diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/account.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/account.json index d230dc198a17..f06602431eea 100644 --- a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/account.json +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/account.json @@ -1598,6 +1598,113 @@ } } } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "Account" + ], + "operationId": "Account_CheckNameAvailability", + "description": "Checks whether the specified account name is available or taken.", + "x-ms-examples": { + "Checks whether the specified account name is available or taken": { "$ref": "./examples/Adla_Account_CheckNameAvailability.json" } + }, + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Resource location without whitespace." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + }, + "description": "Parameters supplied to check the Data Lake Analytics account name availability." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Data Lake Analytics account name availability information.", + "schema": { + "$ref": "#/definitions/NameAvailabilityInformation" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/locations/{location}/capability": { + "get": { + "tags": [ + "Locations" + ], + "operationId": "Locations_GetCapability", + "description": "Gets subscription-level properties and limits for Data Lake Analytics specified by Resource location.", + "x-ms-examples": { + "Gets subscription-level properties and limits for Data Lake Analytics specified by Resource location": { "$ref": "./examples/Adla_Locations_GetCapability.json" } + }, + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Resource location without whitespace." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the subscription-level properties and limits for Data Lake Analytics specified by Resource location.", + "schema": { + "$ref": "#/definitions/CapabilityInformation" + } + }, + "404": { + "description": "Subscription not found." + } + } + } + }, + "/providers/Microsoft.DataLakeAnalytics/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Data Lake Analytics REST API operations.", + "x-ms-examples": { + "Lists all of the available Data Lake Analytics REST API operations": { "$ref": "./examples/Adla_Operations_List.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the available operations for Data Lake Analytics.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + } + } } }, "definitions": { @@ -1831,7 +1938,7 @@ "type": "integer", "format": "int32", "readOnly": true, - "description": "the system defined maximum supported degree of parallelism for this account, which restricts the maximum value of parallelism the user can set for the account.." + "description": "the system defined maximum supported degree of parallelism for this account, which restricts the maximum value of parallelism the user can set for the account." }, "systemMaxJobCount": { "type": "integer", @@ -2421,6 +2528,161 @@ }, "description": "Data Lake Analytics firewall rule update parameters" }, + "NameAvailabilityInformation": { + "properties": { + "nameAvailable": { + "type": "boolean", + "readOnly": true, + "description": "the Boolean value of true or false to indicate whether the Data Lake Analytics account name is available or not." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "the reason why the Data Lake Analytics account name is not available, if nameAvailable is false." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "the message describing why the Data Lake Analytics account name is not available, if nameAvailable is false." + } + }, + "description": "Data Lake Analytics account name availability result information" + }, + "CheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "the Data Lake Analytics name to check availability for." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataLakeAnalytics/accounts" + ], + "description": "the Resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeAnalytics/accounts" + } + }, + "required": [ + "name", + "type" + ], + "description": "Data Lake Analytics account name availability check parameters" + }, + "CapabilityInformation": { + "properties": { + "subscriptionId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "the subscription credentials that uniquely identifies the subscription." + }, + "state": { + "type": "string", + "enum": [ + "Registered", + "Suspended", + "Deleted", + "Unregistered", + "Warned" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": true + }, + "readOnly": true, + "description": "the subscription state." + }, + "maxAccountCount": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "the maximum supported number of accounts under this subscription." + }, + "accountCount": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "the current number of accounts under this subscription." + }, + "migrationState": { + "type": "boolean", + "readOnly": true, + "description": "the Boolean value of true or false to indicate the maintenance state." + } + }, + "description": "Subscription-level properties and limits for Data Lake Analytics" + }, + "OperationDisplay": { + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "the Resource provider of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "the Resource type of the operation." + }, + "operation": { + "type": "string", + "readOnly": true, + "description": "a friendly name of the operation." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "a friendly description of the operation." + } + }, + "description": "The display information for a particular operation" + }, + "Operation": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "the name of the operation." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "the display information for the operation." + }, + "origin": { + "type": "string", + "enum": [ + "user", + "system", + "user,system" + ], + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + }, + "readOnly": true, + "description": "the intended executor of the operation." + } + }, + "description": "An available operation for Data Lake Analytics" + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true, + "description": "the results of the list operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "the link (url) to the next page of results." + } + }, + "description": "The list of available operations for Data Lake Analytics" + }, "Resource": { "description": "The Resource model definition.", "properties": { diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/examples/Adla_Account_CheckNameAvailability.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/examples/Adla_Account_CheckNameAvailability.json new file mode 100644 index 000000000000..5f6b962a58d2 --- /dev/null +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/examples/Adla_Account_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "EastUS2", + "parameters": { + "name": "contosoadla", + "type": "Microsoft.DataLakeAnalytics/accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "An account named 'abc' already exists." + } + } + } +} diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/examples/Adla_Locations_GetCapability.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/examples/Adla_Locations_GetCapability.json new file mode 100644 index 000000000000..c44d18cbfdcb --- /dev/null +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/examples/Adla_Locations_GetCapability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "EastUS2" + }, + "responses": { + "200": { + "body": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "state": "Registered", + "maxAccountCount": 150, + "accountCount": 100, + "migrationState": false + } + }, + "404": { + } + } +} diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/examples/Adla_Operations_List.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/examples/Adla_Operations_List.json new file mode 100644 index 000000000000..c16b26ab7e22 --- /dev/null +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/examples/Adla_Operations_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2016-11-01" + }, + "responses": { + "200": { + "body": { + "value": [{ + "name": "Microsoft.DataLakeAnalytics/operations/read", + "display": { + "provider": "Microsoft DataLakeAnalytics", + "resource": "Available Operations", + "operation": "Get Available Operations", + "description": "Get available operations of DataLakeAnalytics." + } + }], + "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosorg/providers/Microsoft.DataLakeAnalytics/accounts/contosoadla/jobPolicies?api-version=2016-11-01&%24skiptoken=" + } + } + } +} diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/account.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/account.json index 8f35bfcd38b7..ef2075f31449 100644 --- a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/account.json +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/account.json @@ -87,7 +87,7 @@ ], "responses": { "200": { - "description": "Successfully created or updated the specified firewall rule", + "description": "Successfully created or updated the specified firewall rule.", "schema": { "$ref": "#/definitions/FirewallRule" } @@ -143,7 +143,7 @@ ], "responses": { "200": { - "description": "Successfully updated the specified firewall rule", + "description": "Successfully updated the specified firewall rule.", "schema": { "$ref": "#/definitions/FirewallRule" } @@ -190,7 +190,7 @@ ], "responses": { "200": { - "description": "Successfully deleted the specified firewall rule" + "description": "Successfully deleted the specified firewall rule." }, "204": { "description": "The specified firewall rule does not exist or was already deleted." @@ -237,7 +237,7 @@ ], "responses": { "200": { - "description": "Successfully retrieved the list of firewall rules.", + "description": "Successfully retrieved the firewall rule.", "schema": { "$ref": "#/definitions/FirewallRule" } @@ -279,7 +279,7 @@ ], "responses": { "200": { - "description": "Successfully created the firewall rule.", + "description": "Successfully retrieved the list of firewall rules.", "schema": { "$ref": "#/definitions/DataLakeStoreFirewallRuleListResult" } @@ -942,6 +942,113 @@ }, "x-ms-odata": "#/definitions/DataLakeStoreAccount" } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "Account" + ], + "operationId": "Account_CheckNameAvailability", + "description": "Checks whether the specified account name is available or taken.", + "x-ms-examples": { + "Checks whether the specified account name is available or taken": { "$ref": "./examples/Adls_Account_CheckNameAvailability.json" } + }, + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Resource location without whitespace." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + }, + "description": "Parameters supplied to check the Data Lake Store account name availability." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Data Lake Store account name availability information.", + "schema": { + "$ref": "#/definitions/NameAvailabilityInformation" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/locations/{location}/capability": { + "get": { + "tags": [ + "Locations" + ], + "operationId": "Locations_GetCapability", + "description": "Gets subscription-level properties and limits for Data Lake Store specified by Resource location.", + "x-ms-examples": { + "Gets subscription-level properties and limits for Data Lake Store specified by Resource location": { "$ref": "./examples/Adls_Locations_GetCapability.json" } + }, + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Resource location without whitespace." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the subscription-level properties and limits for Data Lake Store specified by Resource location.", + "schema": { + "$ref": "#/definitions/CapabilityInformation" + } + }, + "404": { + "description": "Subscription not found." + } + } + } + }, + "/providers/Microsoft.DataLakeStore/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Data Lake Store REST API operations.", + "x-ms-examples": { + "Lists all of the available Data Lake Store REST API operations": { "$ref": "./examples/Adls_Operations_List.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the available operations for Data Lake Store.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + } + } } }, "definitions": { @@ -956,7 +1063,7 @@ "description": "the end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol." } }, - "description": "Data Lake Analytics firewall rule properties information" + "description": "Data Lake Store firewall rule properties information" }, "UpdateFirewallRuleParameters": { "properties": { @@ -966,7 +1073,7 @@ "x-ms-client-flatten": true } }, - "description": "Data Lake Analytics firewall rule update parameters" + "description": "Data Lake Store firewall rule update parameters" }, "FirewallRuleProperties": { "required": [ @@ -1509,6 +1616,161 @@ }, "description": "Data Lake Store account list information response." }, + "NameAvailabilityInformation": { + "properties": { + "nameAvailable": { + "type": "boolean", + "readOnly": true, + "description": "the Boolean value of true or false to indicate whether the Data Lake Store account name is available or not." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "the reason why the Data Lake Store account name is not available, if nameAvailable is false." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "the message describing why the Data Lake Store account name is not available, if nameAvailable is false." + } + }, + "description": "Data Lake Store account name availability result information" + }, + "CheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "the Data Lake Store name to check availability for." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.DataLakeStore/accounts" + ], + "description": "the Resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeStore/accounts" + } + }, + "required": [ + "name", + "type" + ], + "description": "Data Lake Store account name availability check parameters" + }, + "CapabilityInformation": { + "properties": { + "subscriptionId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "the subscription credentials that uniquely identifies the subscription." + }, + "state": { + "type": "string", + "enum": [ + "Registered", + "Suspended", + "Deleted", + "Unregistered", + "Warned" + ], + "x-ms-enum": { + "name": "SubscriptionState", + "modelAsString": true + }, + "readOnly": true, + "description": "the subscription state." + }, + "maxAccountCount": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "the maximum supported number of accounts under this subscription." + }, + "accountCount": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "the current number of accounts under this subscription." + }, + "migrationState": { + "type": "boolean", + "readOnly": true, + "description": "the Boolean value of true or false to indicate the maintenance state." + } + }, + "description": "Subscription-level properties and limits for Data Lake Store" + }, + "OperationDisplay": { + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "the Resource provider of the operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "the Resource type of the operation." + }, + "operation": { + "type": "string", + "readOnly": true, + "description": "a friendly name of the operation." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "a friendly description of the operation." + } + }, + "description": "The display information for a particular operation" + }, + "Operation": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "the name of the operation." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "the display information for the operation." + }, + "origin": { + "type": "string", + "enum": [ + "user", + "system", + "user,system" + ], + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + }, + "readOnly": true, + "description": "the intended executor of the operation." + } + }, + "description": "An available operation for Data Lake Store" + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true, + "description": "the results of the list operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "the link (url) to the next page of results." + } + }, + "description": "The list of available operations for Data Lake Store" + }, "ErrorDetails": { "properties": { "code": { diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/examples/Adls_Account_CheckNameAvailability.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/examples/Adls_Account_CheckNameAvailability.json new file mode 100644 index 000000000000..b2b12f3a1860 --- /dev/null +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/examples/Adls_Account_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "EastUS2", + "parameters": { + "name": "contosoadla", + "type": "Microsoft.DataLakeStore/accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "An account named 'abc' already exists." + } + } + } +} diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/examples/Adls_Locations_GetCapability.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/examples/Adls_Locations_GetCapability.json new file mode 100644 index 000000000000..c44d18cbfdcb --- /dev/null +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/examples/Adls_Locations_GetCapability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2016-11-01", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "EastUS2" + }, + "responses": { + "200": { + "body": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "state": "Registered", + "maxAccountCount": 150, + "accountCount": 100, + "migrationState": false + } + }, + "404": { + } + } +} diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/examples/Adls_Operations_List.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/examples/Adls_Operations_List.json new file mode 100644 index 000000000000..5604a02f32ef --- /dev/null +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/examples/Adls_Operations_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2016-11-01" + }, + "responses": { + "200": { + "body": { + "value": [{ + "name": "Microsoft.DataLakeStore/operations/read", + "display": { + "provider": "Microsoft DataLakeStore", + "resource": "Available Operations", + "operation": "Get Available Operations", + "description": "Get available operations of DataLakeStore." + } + }], + "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosorg/providers/Microsoft.DataLakeAnalytics/accounts/contosoadla/jobPolicies?api-version=2016-11-01&%24skiptoken=" + } + } + } +}