diff --git a/custom-words.txt b/custom-words.txt index 049cac0dbdfe..684c49d704db 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2069,4 +2069,7 @@ Metastores maintenancewindows appendpos appendblock -Exprired \ No newline at end of file +Exprired +azureasyncoperations +saskey +vmsize diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/applications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/applications.json index a05f36080591..80e200b620a8 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/applications.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/applications.json @@ -254,6 +254,10 @@ "format": "int32", "description": "The public port to connect to." }, + "privateIPAddress": { + "type": "string", + "description": "The private ip address of the endpoint." + }, "subDomainSuffix": { "type": "string", "description": "The subdomain suffix of the application." diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json index 8054e928938e..87a098f5f347 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json @@ -619,6 +619,51 @@ }, "x-ms-long-running-operation": true } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/azureasyncoperations/{operationId}": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_GetAzureAsyncOperationStatus", + "description": "The the async operation status.", + "x-ms-examples": { + "Get Async Operation Status of Creating Cluster": { + "$ref": "./examples/GetClusterCreatingAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/AsyncOperationResult" + } + } + } + } } }, "definitions": { @@ -930,6 +975,10 @@ "format": "int32", "description": "The instance count of the cluster." }, + "VMGroupName": { + "type": "string", + "description": "The name of the virtual machine group." + }, "autoscale": { "$ref": "#/definitions/Autoscale", "x-ms-client-name": "autoscaleConfiguration", @@ -1009,6 +1058,14 @@ "msiResourceId": { "type": "string", "description": "The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2." + }, + "saskey": { + "type": "string", + "description": "The shared access signature key." + }, + "fileshare": { + "type": "string", + "description": "The file share name." } }, "description": "The storage Account." @@ -1733,7 +1790,7 @@ }, "description": "Gateway settings." }, - "OperationResource": { + "AsyncOperationResult": { "properties": { "status": { "type": "string", @@ -1845,6 +1902,14 @@ "required": true, "type": "string", "description": "The HDInsight client API Version." + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The long running operation id.", + "x-ms-parameter-location": "method" } } } diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetClusterCreatingAsyncOperationStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetClusterCreatingAsyncOperationStatus.json new file mode 100644 index 000000000000..6d4f9e681bca --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetClusterCreatingAsyncOperationStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "operationId": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetExtension.json index 55763d611c74..2abe46586b1c 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetExtension.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetExtension.json @@ -9,8 +9,8 @@ "responses": { "200": { "body": { - "workspaceId": "id", - "primaryKey": "key" + "clusterMonitoringEnabled": true, + "workspaceId": "id" } } } diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetHDInsightCapabilities.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetHDInsightCapabilities.json index 7b8bf40f3197..dee10f0dba32 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetHDInsightCapabilities.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetHDInsightCapabilities.json @@ -13,12 +13,12 @@ { "friendlyName": "1.6", "displayName": "HdInsight version 1.6.1.0.335536", - "isDefault": "false" + "isDefault": false }, { "friendlyName": "2.1", "displayName": "Version 2.1.9.406.1221105", - "isDefault": "false", + "isDefault": false, "componentVersions": { "HDP": "1.3", "Hadoop": "1.2.0" @@ -27,7 +27,7 @@ { "friendlyName": "3.0", "displayName": "Version 3.0.6.989.2441725", - "isDefault": "false", + "isDefault": false, "componentVersions": { "HDP": "2.0", "Hadoop": "2.2.0" @@ -36,7 +36,7 @@ { "friendlyName": "3.1", "displayName": "Version 3.1.4.989.2441725", - "isDefault": "false", + "isDefault": false, "componentVersions": { "HDP": "2.1.7", "Hadoop": "2.4.0", @@ -46,7 +46,7 @@ { "friendlyName": "3.2", "displayName": "Version 3.2.7.989.2441725", - "isDefault": "false", + "isDefault": false, "componentVersions": { "HDP": "2.2", "Hadoop": "2.6.0", @@ -57,7 +57,7 @@ { "friendlyName": "3.3", "displayName": "Version 3.3.0.989.2441725", - "isDefault": "true", + "isDefault": true, "componentVersions": { "HDP": "2.3", "Hadoop": "2.7.0", @@ -72,7 +72,7 @@ { "friendlyName": "3.2", "displayName": "Version 3.2.1000.0.8840373", - "isDefault": "false", + "isDefault": false, "componentVersions": { "HDP": "2.2", "Hadoop": "2.6.0", @@ -83,7 +83,7 @@ { "friendlyName": "3.3", "displayName": "Version 3.3.1000.0.9776961", - "isDefault": "false", + "isDefault": false, "componentVersions": { "HDP": "2.3", "Hadoop": "2.7.0", @@ -95,7 +95,7 @@ { "friendlyName": "3.4", "displayName": "Version 3.4.1000.0.9719475", - "isDefault": "false", + "isDefault": false, "componentVersions": { "HDP": "2.4", "Hadoop": "2.7.1", @@ -108,7 +108,7 @@ { "friendlyName": "3.5", "displayName": "Version 3.5.1000.0.9732704", - "isDefault": "true", + "isDefault": true, "componentVersions": { "HDP": "2.5", "Hadoop": "2.7.3", @@ -122,7 +122,7 @@ { "friendlyName": "3.6", "displayName": "Version 3.6.1000.0.9503998", - "isDefault": "false", + "isDefault": false, "componentVersions": { "HDP": "2.6", "Spark": "2.1.0" @@ -131,7 +131,7 @@ { "friendlyName": "99.152", "displayName": "Version 99.152.1000.0.6943836", - "isDefault": "false" + "isDefault": false } ] } @@ -184,7 +184,7 @@ ] } }, - "vmSizes": { + "vmsizes": { "paas": { "available": [ "A5", @@ -242,7 +242,7 @@ ] } }, - "vmSize_filters": [ + "vmsize_filters": [ { "FilterMode": "Exclude", "Regions": [ diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/HDI_Locations_GetAsyncOperationStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/HDI_Locations_GetAsyncOperationStatus.json new file mode 100644 index 000000000000..8f6d5c2d32e2 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/HDI_Locations_GetAsyncOperationStatus.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "location": "East US 2", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "operationId": "8a0348f4-8a85-4ec2-abe0-03b26104a9a0-0" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/extensions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/extensions.json index afc7a3f0832d..1f6c2d5c1549 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/extensions.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/extensions.json @@ -262,7 +262,7 @@ "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/Extension" + "$ref": "#/definitions/ClusterMonitoringResponse" } } } @@ -318,7 +318,7 @@ }, "definitions": { "Extension": { - "description": "Cluster monitoring extensions", + "description": "Cluster monitoring extensions.", "properties": { "workspaceId": { "description": "The workspace ID for the cluster monitoring extension.", @@ -331,27 +331,27 @@ } }, "ClusterMonitoringResponse": { - "description": "The Operations Management Suite (OMS) status response", + "description": "The cluster monitoring status response.", "properties": { "clusterMonitoringEnabled": { - "description": "The status of the Operations Management Suite (OMS) on the HDInsight cluster.", + "description": "The status of the monitor on the HDInsight cluster.", "type": "boolean" }, "workspaceId": { - "description": "The workspace ID of the Operations Management Suite (OMS) on the HDInsight cluster.", + "description": "The workspace ID of the monitor on the HDInsight cluster.", "type": "string" } } }, "ClusterMonitoringRequest": { - "description": "The Operations Management Suite (OMS) parameters.", + "description": "The cluster monitor parameters.", "properties": { "workspaceId": { - "description": "The Operations Management Suite (OMS) workspace ID.", + "description": "The cluster monitor workspace ID.", "type": "string" }, "primaryKey": { - "description": "The Operations Management Suite (OMS) workspace key.", + "description": "The cluster monitor workspace key.", "type": "string" } } diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/locations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/locations.json index 2ef35221d7be..7faea471ff71 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/locations.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/locations.json @@ -150,6 +150,48 @@ } } } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/azureasyncoperations/{operationId}": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_GetAzureAsyncOperationStatus", + "description": "Get the async operation status.", + "x-ms-examples": { + "Get the subscription billingSpecs for the specified location": { + "$ref": "./examples/HDI_Locations_GetAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "./cluster.json#/definitions/AsyncOperationResult" + } + } + } + } } }, "definitions": { @@ -165,7 +207,7 @@ "description": "The display name" }, "isDefault": { - "type": "string", + "type": "boolean", "description": "Whether or not the version is the default version." }, "componentVersions": { @@ -322,14 +364,14 @@ "$ref": "#/definitions/RegionsCapability" } }, - "vmSizes": { + "vmsizes": { "description": "The virtual machine sizes.", "type": "object", "additionalProperties": { "$ref": "#/definitions/VmSizesCapability" } }, - "vmSize_filters": { + "vmsize_filters": { "description": "The virtual machine size compatibility filters.", "type": "array", "items": { @@ -374,11 +416,12 @@ "currentValue": { "description": "The current usage.", "type": "integer", - "format": "int32" + "format": "int64" }, "limit": { "description": "The maximum allowed usage.", - "type": "integer" + "type": "integer", + "format": "int64" }, "name": { "description": "The details about the localizable name of the used resource.", @@ -654,6 +697,14 @@ "required": true, "type": "string", "description": "The HDInsight client API Version." + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The long running operation id.", + "x-ms-parameter-location": "method" } } } diff --git a/specification/hdinsight/resource-manager/readme.md b/specification/hdinsight/resource-manager/readme.md index 53114925c2bd..8c9a24976d2c 100644 --- a/specification/hdinsight/resource-manager/readme.md +++ b/specification/hdinsight/resource-manager/readme.md @@ -58,7 +58,7 @@ directive: reason: This would require a breaking change, and need to be consistent with the response from RP side. from: Microsoft.HDInsight/stable/2018-06-01-preview/locations.json where: - - $.definitions.CapabilitiesResult.properties.vmSize_filters + - $.definitions.CapabilitiesResult.properties.vmsize_filters - $.definitions.RegionalQuotaCapability.properties.cores_available - $.definitions.RegionalQuotaCapability.properties.cores_used - $.definitions.RegionalQuotaCapability.properties.region_name @@ -71,6 +71,15 @@ directive: - $.definitions.VmSizeCompatibilityFilter.properties.FilterMode ``` +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: This would require a breaking change, and need to be consistent with the response from RP side. + from: Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json + where: + - $.definitions.Role.properties.VMGroupName +``` + ``` yaml directive: - suppress: R3016 # to suppress (DefinitionsPropertiesNamesCamelCase) @@ -82,6 +91,12 @@ directive: - $..["restAuthCredential.password"] ``` +``` yaml +directive: + - suppress: R4007 # to suppress (DefaultErrorResponseSchema) + reason: Update the default error response to a new format would be a braking change for service. +``` + ### Tag: package-2018-06-preview These settings apply only when `--tag=package-2018-06-preview` is specified on the command line.