diff --git a/arm-datalake-analytics/account/2016-11-01/swagger/account.json b/arm-datalake-analytics/account/2016-11-01/swagger/account.json new file mode 100644 index 0000000000000..7546f0abc5976 --- /dev/null +++ b/arm-datalake-analytics/account/2016-11-01/swagger/account.json @@ -0,0 +1,1597 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataLakeAnalyticsAccountManagementClient", + "description": "Creates an Azure Data Lake Analytics account management client.", + "version": "2016-11-01", + "x-ms-code-generation-settings": { + "internalConstructors": true + } + }, + "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.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Get", + "description": "Gets the specified Azure Storage account linked to the given Data Lake Analytics account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account from which to retrieve Azure storage account details." + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Storage account for which to retrieve the details." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified Azure Storage account information.", + "schema": { + "$ref": "#/definitions/StorageAccountInfo" + } + } + } + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Delete", + "description": "Updates the specified Data Lake Analytics account to remove an Azure Storage account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account from which to remove the Azure Storage account." + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Storage account to remove" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the specified Azure Storage account information from the Azure Data Lake Analytics account." + } + } + }, + "patch": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Update", + "description": "Updates the Data Lake Analytics account to replace Azure Storage blob account details, such as the access key and/or suffix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to modify storage accounts in" + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure Storage account to modify" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/UpdateStorageAccountParameters" + }, + "description": "The parameters containing the access key and suffix to update the storage account with, if any. Passing nothing results in no change." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully update the specified Azure Storage account information for the specified Azure Data Lake Analytics account." + } + } + }, + "put": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Add", + "description": "Updates the specified Data Lake Analytics account to add an Azure Storage account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to which to add the Azure Storage account." + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Storage account to add" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AddStorageAccountParameters" + }, + "description": "The parameters containing the access key and optional suffix for the Azure Storage Account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the specified Azure Storage account information to the specified Azure Data Lake Analytics account." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}/Containers/{containerName}": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_GetStorageContainer", + "description": "Gets the specified Azure Storage container associated with the given Data Lake Analytics and Azure Storage accounts.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account for which to retrieve blob container." + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure storage account from which to retrieve the blob container." + }, + { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure storage container to retrieve" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified Azure Storage container information.", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}/Containers": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListStorageContainers", + "description": "Lists the Azure Storage containers, if any, associated with the specified Data Lake Analytics and Azure Storage account combination. The response includes a link to the next page of results, if any.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account for which to list Azure Storage blob containers." + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure storage account from which to list blob containers." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Azure Storage containers under the specified Azure Data Lake Analytics account.", + "schema": { + "$ref": "#/definitions/ListStorageContainersResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}/Containers/{containerName}/listSasTokens": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListSasTokens", + "description": "Gets the SAS token associated with the specified Data Lake Analytics and Azure Storage account and container combination.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account from which an Azure Storage account's SAS token is being requested." + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure storage account for which the SAS token is being requested." + }, + { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure storage container for which the SAS token is being requested." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Storage Account SAS tokens for the specified Azure Storage account container.", + "schema": { + "$ref": "#/definitions/ListSasTokensResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/DataLakeStoreAccounts/{dataLakeStoreAccountName}": { + "get": { + "tags": [ + "DataLakeStoreAccounts" + ], + "operationId": "DataLakeStoreAccounts_Get", + "description": "Gets the specified Data Lake Store account details in the specified Data Lake Analytics account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account from which to retrieve the Data Lake Store account details." + }, + { + "name": "dataLakeStoreAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to retrieve" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified Azure Data Lake Store account information.", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccountInfo" + } + } + } + }, + "delete": { + "tags": [ + "DataLakeStoreAccounts" + ], + "operationId": "DataLakeStoreAccounts_Delete", + "description": "Updates the Data Lake Analytics account specified to remove the specified Data Lake Store account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account from which to remove the Data Lake Store account." + }, + { + "name": "dataLakeStoreAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to remove" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully removed the specified Azure Data Lake Store account information from the specified Azure Data Lake Analytics account." + } + } + }, + "put": { + "tags": [ + "DataLakeStoreAccounts" + ], + "operationId": "DataLakeStoreAccounts_Add", + "description": "Updates the specified Data Lake Analytics account to include the additional Data Lake Store account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to which to add the Data Lake Store account." + }, + { + "name": "dataLakeStoreAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to add." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AddDataLakeStoreParameters" + }, + "description": "The details of the Data Lake Store account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the specified Azure Data Lake Store account information." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListByAccount", + "description": "Gets the first page of Azure Storage accounts, if any, linked to the specified Data Lake Analytics account. The response includes a link to the next page, if any.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account for which to list Azure Storage accounts." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to skip over before returning elements. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Azure Storage accounts.", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccountListStorageAccountsResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/StorageAccountInfo" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/DataLakeStoreAccounts/": { + "get": { + "tags": [ + "DataLakeStoreAccounts" + ], + "operationId": "DataLakeStoreAccounts_ListByAccount", + "description": "Gets the first page of Data Lake Store accounts linked to the specified Data Lake Analytics account. The response includes a link to the next page, if any.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account for which to list Data Lake Store accounts." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to skip over before returning elements. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Azure Data Lake Store accounts.", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccountListDataLakeStoreResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DataLakeStoreAccountInfo" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts": { + "get": { + "tags": [ + "Account" + ], + "operationId": "Account_ListByResourceGroup", + "description": "Gets the first page of Data Lake Analytics accounts, if any, within a specific resource group. This includes a link to the next page, if any.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to skip over before returning elements. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of accounts in the specified resource group.", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DataLakeAnalyticsAccount" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/accounts": { + "get": { + "tags": [ + "Account" + ], + "operationId": "Account_List", + "description": "Gets the first page of Data Lake Analytics accounts, if any, within the current subscription. This includes a link to the next page, if any.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to skip over before returning elements. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Azure Data Lake Analytics accounts.", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DataLakeAnalyticsAccount" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}": { + "get": { + "tags": [ + "Account" + ], + "operationId": "Account_Get", + "description": "Gets details of the specified Data Lake Analytics account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to retrieve." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the details of the specified account.", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + } + } + } + }, + "delete": { + "tags": [ + "Account" + ], + "operationId": "Account_Delete", + "description": "Begins the delete delete process for the Data Lake Analytics account object specified by the account name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to delete" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the specified account." + }, + "202": { + "description": "Successfully initiated the deletion of the specified account." + }, + "204": { + "description": "The specified account was not found." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{name}": { + "put": { + "tags": [ + "Account" + ], + "operationId": "Account_Create", + "description": "Creates the specified Data Lake Analytics account. This supplies the user with computation services for Data Lake Analytics workloads", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account.the account will be associated with." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to create." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + }, + "description": "Parameters supplied to the create Data Lake Analytics account operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Successfully initiated creation of the specified account.", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + } + }, + "200": { + "description": "Successfully created the specified account.", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Account" + ], + "operationId": "Account_Update", + "description": "Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Analytics account." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to update." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccountUpdateParameters" + }, + "description": "Parameters supplied to the update Data Lake Analytics account operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the specified account.", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + } + }, + "201": { + "description": "Successfully initiated an update of the specified account.", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "StorageAccountProperties": { + "required": [ + "accessKey" + ], + "properties": { + "accessKey": { + "type": "string", + "description": "the access key associated with this Azure Storage account that will be used to connect to it." + }, + "suffix": { + "type": "string", + "description": "the optional suffix for the storage account." + } + }, + "description": "Azure Storage account properties information." + }, + "UpdateStorageAccountProperties": { + "properties": { + "accessKey": { + "type": "string", + "description": "the updated access key associated with this Azure Storage account that will be used to connect to it." + }, + "suffix": { + "type": "string", + "description": "the optional suffix for the storage account." + } + }, + "description": "Azure Storage account properties information to update." + }, + "StorageAccountInfo": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "the account name associated with the Azure storage account." + }, + "properties": { + "$ref": "#/definitions/StorageAccountProperties", + "description": "the properties associated with this storage account.", + "x-ms-client-flatten": true + } + }, + "description": "Azure Storage account information." + }, + "CreateStorageAccountInfo": { + "required": [ + "properties", + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "the account name associated with the Azure storage account to add to the Data Lake analytics account being created." + }, + "properties": { + "$ref": "#/definitions/StorageAccountProperties", + "description": "the properties associated with this storage account to add to the Data Lake analytics account being created.", + "x-ms-client-flatten": true + } + }, + "description": "Azure Storage account information to add to the Data Lake analytics account being created." + }, + "StorageContainerProperties": { + "properties": { + "lastModifiedTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "the last modified time of the blob container." + } + }, + "description": "Azure Storage blob container properties information." + }, + "StorageContainer": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "the name of the blob container." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "the unique identifier of the blob container." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "the type of the blob container." + }, + "properties": { + "readOnly": true, + "$ref": "#/definitions/StorageContainerProperties", + "description": "the properties of the blob container.", + "x-ms-client-flatten": true + } + }, + "description": "Azure Storage blob container information." + }, + "ListStorageContainersResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageContainer" + }, + "readOnly": true, + "description": "the results of the list operation" + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "the link (url) to the next page of results." + } + }, + "description": "The list of blob containers associated with the storage account attached to the Data Lake Analytics account." + }, + "SasTokenInfo": { + "properties": { + "accessToken": { + "readOnly": true, + "type": "string", + "description": "the access token for the associated Azure Storage Container." + } + }, + "description": "SAS token information." + }, + "ListSasTokensResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SasTokenInfo" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "the link (url) to the next page of results." + } + }, + "description": "The SAS response that contains the storage account, container and associated SAS token for connection use." + }, + "DataLakeStoreAccountInfoProperties": { + "properties": { + "suffix": { + "type": "string", + "description": "the optional suffix for the Data Lake Store account." + } + }, + "description": "Data Lake Store account properties information." + }, + "DataLakeStoreAccountInfo": { + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "the account name of the Data Lake Store account to add to the Data Lake Analytics account being created." + }, + "properties": { + "$ref": "#/definitions/DataLakeStoreAccountInfoProperties", + "description": "the properties associated with this Data Lake Store account.", + "x-ms-client-flatten": true + } + }, + "description": "Data Lake Store account information." + }, + "DataLakeAnalyticsAccountListStorageAccountsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountInfo" + }, + "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": "Azure Storage Account list information." + }, + "DataLakeAnalyticsAccountListDataLakeStoreResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataLakeStoreAccountInfo" + }, + "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": "Data Lake Account list information." + }, + "DataLakeAnalyticsAccountProperties": { + "required": [ + "defaultDataLakeStoreAccount", + "dataLakeStoreAccounts" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "the provisioning status of the Data Lake Analytics account.", + "enum": [ + "Failed", + "Creating", + "Running", + "Succeeded", + "Patching", + "Suspending", + "Resuming", + "Deleting", + "Deleted" + ], + "x-ms-enum": { + "name": "DataLakeAnalyticsAccountStatus", + "modelAsString": false + } + }, + "state": { + "readOnly": true, + "type": "string", + "description": "the state of the Data Lake Analytics account.", + "enum": [ + "Active", + "Suspended" + ], + "x-ms-enum": { + "name": "DataLakeAnalyticsAccountState", + "modelAsString": false + } + }, + "defaultDataLakeStoreAccount": { + "type": "string", + "description": "the default data lake storage account associated with this Data Lake Analytics account." + }, + "maxDegreeOfParallelism": { + "type": "integer", + "format": "int32", + "minimum": 1, + "default": 30, + "description": "the maximum supported degree of parallelism for this account." + }, + "queryStoreRetention": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 180, + "default": 30, + "description": "the number of days that job metadata is retained." + }, + "maxJobCount": { + "type": "integer", + "format": "int32", + "minimum": 1, + "default": 3, + "description": "the maximum supported jobs running under the account at the same time." + }, + "systemMaxDegreeOfParallelism": { + "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.." + }, + "systemMaxJobCount": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "the system defined maximum supported jobs running under the account at the same time, which restricts the maximum number of running jobs the user can set for the account." + }, + "dataLakeStoreAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/DataLakeStoreAccountInfo" + }, + "description": "the list of Data Lake storage accounts associated with this account." + }, + "storageAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountInfo" + }, + "description": "the list of Azure Blob storage accounts associated with this account." + }, + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "the account creation time." + }, + "lastModifiedTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "the account last modified time." + }, + "endpoint": { + "type": "string", + "readOnly": true, + "description": "the full CName endpoint for this account." + } + }, + "description": "The account specific properties that are associated with an underlying Data Lake Analytics account." + }, + "UpdateDataLakeAnalyticsAccountProperties": { + "properties": { + "maxDegreeOfParallelism": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "the maximum supported degree of parallelism for this account." + }, + "queryStoreRetention": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 180, + "description": "the number of days that job metadata is retained." + }, + "maxJobCount": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "the maximum supported jobs running under the account at the same time." + } + }, + "description": "The properties to update that are associated with an underlying Data Lake Analytics account to." + }, + "AddDataLakeStoreParameters": { + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/DataLakeStoreAccountInfoProperties", + "description": "the properties for the Data Lake Store account being added.", + "x-ms-client-flatten": true + } + }, + "description": "Additional Data Lake Store parameters." + }, + "AddStorageAccountParameters": { + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageAccountProperties", + "description": "the properties for the Azure Storage account being added.", + "x-ms-client-flatten": true + } + }, + "description": "Storage account parameters for a storage account being added to a Data Lake Analytics account." + }, + "UpdateStorageAccountParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/UpdateStorageAccountProperties", + "description": "the properties for the Azure Storage account being updated.", + "x-ms-client-flatten": true + } + }, + "description": "Storage account parameters for a storage account being updated in a Data Lake Analytics account." + }, + "DataLakeAnalyticsAccountUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "$ref": "#/definitions/UpdateDataLakeAnalyticsAccountProperties", + "description": "The properties that can be updated in an existing Data Lake Analytics account.", + "x-ms-client-flatten": true + } + }, + "description": "The parameters that can be used to update an existing Data Lake Analytics account." + }, + "DataLakeAnalyticsAccount": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/DataLakeAnalyticsAccountProperties", + "description": "The properties defined by Data Lake Analytics all properties are specific to each resource provider.", + "x-ms-client-flatten": true + } + }, + "description": "A Data Lake Analytics account object, containing all information associated with the named Data Lake Analytics account." + }, + "DataLakeAnalyticsAccountListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + }, + "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": "DataLakeAnalytics Account list information." + }, + "ErrorDetails": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "the HTTP status code or error code associated with this error" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "the error message localized based on Accept-Language" + }, + "target": { + "type": "string", + "readOnly": true, + "description": "the target of the particular error (for example, the name of the property in error)." + } + }, + "description": "Generic resource error details information." + }, + "InnerError": { + "properties": { + "trace": { + "type": "string", + "readOnly": true, + "description": "the stack trace for the error" + }, + "context": { + "type": "string", + "readOnly": true, + "description": "the context for the error message" + } + }, + "description": "Generic resource inner error information." + }, + "Error": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "the HTTP status code or error code associated with this error" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "the error message to display." + }, + "target": { + "type": "string", + "readOnly": true, + "description": "the target of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "readOnly": true, + "description": "The list of error details" + }, + "innerError": { + "$ref": "#/definitions/InnerError", + "readOnly": true, + "description": "The inner exceptions or errors, if any" + } + }, + "description": "Generic resource error information." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Get 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." + } + } +} diff --git a/arm-datalake-analytics/catalog/2016-06-01-preview/swagger/catalog.json b/arm-datalake-analytics/catalog/2016-11-01/swagger/catalog.json similarity index 93% rename from arm-datalake-analytics/catalog/2016-06-01-preview/swagger/catalog.json rename to arm-datalake-analytics/catalog/2016-11-01/swagger/catalog.json index 156f806b8acac..e77e47d45d685 100644 --- a/arm-datalake-analytics/catalog/2016-06-01-preview/swagger/catalog.json +++ b/arm-datalake-analytics/catalog/2016-11-01/swagger/catalog.json @@ -3,7 +3,7 @@ "info": { "title": "DataLakeAnalyticsCatalogManagementClient", "description": "Creates an Azure Data Lake Analytics catalog client.", - "version": "2016-06-01-preview", + "version": "2016-11-01", "x-ms-code-generation-settings": { "useDateTimeOffset": true, "internalConstructors": true @@ -14,7 +14,7 @@ "parameters": [ { "name": "accountName", - "description": "The Azure Data Lake Analytics account to execute catalog operations on.", + "description": "The Azure Data Lake Analytics account upon which to execute catalog operations.", "required": true, "type": "string", "in": "path", @@ -29,14 +29,10 @@ "https" ], "consumes": [ - "application/json", - "text/json", - "application/octet-stream" + "application/json" ], "produces": [ - "application/json", - "text/json", - "application/octet-stream" + "application/json" ], "paths": { "/catalog/usql/databases/{databaseName}/secrets/{secretName}": { @@ -76,7 +72,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully created the specified secret in the specified database.", "schema": { "$ref": "#/definitions/USqlSecret" } @@ -119,7 +115,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully updated the details of the specified secret in the specified database.", "schema": { "$ref": "#/definitions/USqlSecret" } @@ -153,7 +149,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved details of the specified secret in the specified database.", "schema": { "$ref": "#/definitions/USqlSecret" } @@ -187,7 +183,7 @@ ], "responses": { "200": { - "description": "" + "description": "Successfully deleted the specified secret from the specified database." } } } @@ -213,7 +209,7 @@ ], "responses": { "200": { - "description": "" + "description": "Successfully deleted all secrets from the specified database." } } } @@ -326,7 +322,7 @@ ], "responses": { "200": { - "description": "Successfully retrieved and returned the specified credential (name only) from the specified database.", + "description": "Successfully retrieved the specified credential (name only) from the specified database.", "schema": { "$ref": "#/definitions/USqlCredential" } @@ -357,7 +353,7 @@ { "name": "parameters", "in": "body", - "required": true, + "required": false, "schema": { "$ref": "#/definitions/DataLakeAnalyticsCatalogCredentialDeleteParameters" }, @@ -374,6 +370,85 @@ } } }, + "/catalog/usql/databases/{databaseName}/credentials": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListCredentials", + "description": "Retrieves the list of credentials from the Data Lake Analytics catalog.", + "parameters": [ + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database containing the schema." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to skip over before returning elements. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of credentials in the specified database.", + "schema": { + "$ref": "#/definitions/USqlCredentialList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/USqlCredential" + } + }, "/catalog/usql/databases/{databaseName}/externaldatasources/{externalDataSourceName}": { "get": { "tags": [ @@ -402,7 +477,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved details of the specified external data source in the specified database.", "schema": { "$ref": "#/definitions/USqlExternalDataSource" } @@ -438,6 +513,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -446,15 +522,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, + }, { "name": "$select", "in": "query", @@ -482,7 +552,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of external data sources in the specified database.", "schema": { "$ref": "#/definitions/USqlExternalDataSourceList" } @@ -529,7 +599,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the specified procedure from the underlying database and schema combination.", "schema": { "$ref": "#/definitions/USqlProcedure" } @@ -572,6 +642,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -580,15 +651,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -616,7 +681,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of procedures in the specified database and schema.", "schema": { "$ref": "#/definitions/USqlProcedureList" } @@ -663,7 +728,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the specified table from the underying database and schema combination", "schema": { "$ref": "#/definitions/USqlTable" } @@ -706,6 +771,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -714,15 +780,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -750,7 +810,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of tables in the specified database and schema.", "schema": { "$ref": "#/definitions/USqlTableList" } @@ -797,7 +857,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the specified table type from the underying database and schema combination", "schema": { "$ref": "#/definitions/USqlTableType" } @@ -840,6 +900,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -848,15 +909,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -884,7 +939,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of table types in the specified database and schema.", "schema": { "$ref": "#/definitions/USqlTableTypeList" } @@ -931,7 +986,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the specified view from the underying database and schema combination", "schema": { "$ref": "#/definitions/USqlView" } @@ -974,6 +1029,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -982,15 +1038,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -1018,7 +1068,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of views in the specified database and schema.", "schema": { "$ref": "#/definitions/USqlViewList" } @@ -1072,7 +1122,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the details of the specified table statistics in the specified database and schema.", "schema": { "$ref": "#/definitions/USqlTableStatistics" } @@ -1122,6 +1172,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -1130,15 +1181,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -1166,7 +1211,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of table statistics in the specified database and schema.", "schema": { "$ref": "#/definitions/USqlTableStatisticsList" } @@ -1220,7 +1265,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the details of the specified table partition in the specified database, schema, and table.", "schema": { "$ref": "#/definitions/USqlTablePartition" } @@ -1270,6 +1315,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -1278,15 +1324,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -1314,7 +1354,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of table partitions in the specified database, schema, and table.", "schema": { "$ref": "#/definitions/USqlTablePartitionList" } @@ -1361,6 +1401,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -1369,15 +1410,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -1405,7 +1440,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of types in the specified database and schema.", "schema": { "$ref": "#/definitions/USqlTypeList" } @@ -1452,7 +1487,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the details of the specified table valued function in the specified database and schema.", "schema": { "$ref": "#/definitions/USqlTableValuedFunction" } @@ -1495,6 +1530,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -1503,15 +1539,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -1539,7 +1569,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of table valued functions in the specified database and schema.", "schema": { "$ref": "#/definitions/USqlTableValuedFunctionList" } @@ -1579,7 +1609,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the details of the specified assembly in the specified database.", "schema": { "$ref": "#/definitions/USqlAssembly" } @@ -1615,6 +1645,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -1623,15 +1654,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -1659,7 +1684,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of assemblies in the specified database.", "schema": { "$ref": "#/definitions/USqlAssemblyList" } @@ -1699,7 +1724,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the details of the specified schema in the specified database.", "schema": { "$ref": "#/definitions/USqlSchema" } @@ -1735,6 +1760,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -1743,15 +1769,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -1779,7 +1799,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of schemas in the specified database.", "schema": { "$ref": "#/definitions/USqlSchemaList" } @@ -1812,7 +1832,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the details of the specified database.", "schema": { "$ref": "#/definitions/USqlDatabase" } @@ -1841,6 +1861,7 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to return. Optional." }, { @@ -1849,15 +1870,9 @@ "required": false, "type": "integer", "format": "int32", + "minimum": 1, "description": "The number of items to skip over before returning elements. Optional." }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional." - }, { "name": "$select", "in": "query", @@ -1885,7 +1900,7 @@ ], "responses": { "200": { - "description": "", + "description": "Successfully retrieved the list of databases.", "schema": { "$ref": "#/definitions/USqlDatabaseList" } @@ -2051,6 +2066,24 @@ }, "description": "A Data Lake Analytics catalog U-SQL external datasource item list." }, + "USqlCredentialList": { + "allOf": [ + { + "$ref": "#/definitions/CatalogItemList" + } + ], + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/USqlCredential" + }, + "description": "the list of credentials in the database" + } + }, + "description": "A Data Lake Analytics catalog U-SQL credential item list." + }, "USqlCredential": { "allOf": [ { @@ -2927,11 +2960,6 @@ }, "CatalogItemList": { "properties": { - "count": { - "type": "integer", - "format": "int32", - "description": "the count of items in the list." - }, "nextLink": { "type": "string", "description": "the link to the next page of results." diff --git a/arm-datalake-analytics/job/2016-11-01/swagger/job.json b/arm-datalake-analytics/job/2016-11-01/swagger/job.json new file mode 100644 index 0000000000000..a1762ba717e1e --- /dev/null +++ b/arm-datalake-analytics/job/2016-11-01/swagger/job.json @@ -0,0 +1,1048 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataLakeAnalyticsJobManagementClient", + "description": "Creates an Azure Data Lake Analytics job client.", + "version": "2016-11-01", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true, + "internalConstructors": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{accountName}.{adlaJobDnsSuffix}", + "parameters": [ + { + "name": "accountName", + "description": "The Azure Data Lake Analytics account to execute job operations on.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/adlaJobDnsSuffixInPath" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Jobs/{jobIdentity}/GetStatistics": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_GetStatistics", + "description": "Gets statistics of the specified job.", + "parameters": [ + { + "name": "jobIdentity", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "Job Information ID." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved job statistics of the specified job.", + "schema": { + "$ref": "#/definitions/JobStatistics" + } + } + } + } + }, + "/Jobs/{jobIdentity}/GetDebugDataPath": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_GetDebugDataPath", + "description": "Gets the job debug data information specified by the job ID.", + "parameters": [ + { + "name": "jobIdentity", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "JobInfo ID." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved debug data paths of the specified job.", + "schema": { + "$ref": "#/definitions/JobDataPath" + } + } + } + } + }, + "/BuildJob": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_Build", + "description": "Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobInformation" + }, + "description": "The parameters to build a job." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully built the job script.", + "schema": { + "$ref": "#/definitions/JobInformation" + } + } + } + } + }, + "/Jobs/{jobIdentity}/CancelJob": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_Cancel", + "description": "Cancels the running job specified by the job ID.", + "parameters": [ + { + "name": "jobIdentity", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "JobInfo ID to cancel." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully cancelled the job." + } + } + } + }, + "/Jobs/{jobIdentity}": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_Get", + "description": "Gets the job information for the specified job ID.", + "parameters": [ + { + "name": "jobIdentity", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "JobInfo ID." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved details of the specified job.", + "schema": { + "$ref": "#/definitions/JobInformation" + } + } + } + }, + "put": { + "tags": [ + "Job" + ], + "operationId": "Job_Create", + "description": "Submits a job to the specified Data Lake Analytics account.", + "parameters": [ + { + "name": "jobIdentity", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "The job ID (a GUID) for the job being submitted." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobInformation" + }, + "description": "The parameters to submit a job." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully submitted the job.", + "schema": { + "$ref": "#/definitions/JobInformation" + } + } + } + } + }, + "/Jobs": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_List", + "description": "Lists the jobs, if any, associated with the specified Data Lake Analytics account. The response includes a link to the next page of results, if any.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to skip over before returning elements. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of jobs.", + "schema": { + "$ref": "#/definitions/JobInfoListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobInformation" + } + } + }, + "definitions": { + "JobStatisticsVertexStage": { + "properties": { + "dataRead": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "the amount of data read, in bytes." + }, + "dataReadCrossPod": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "the amount of data read across multiple pods, in bytes." + }, + "dataReadIntraPod": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "the amount of data read in one pod, in bytes." + }, + "dataToRead": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "the amount of data remaining to be read, in bytes." + }, + "dataWritten": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "the amount of data written, in bytes." + }, + "duplicateDiscardCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the number of duplicates that were discarded." + }, + "failedCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the number of failures that occured in this stage." + }, + "maxVertexDataRead": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "the maximum amount of data read in a single vertex, in bytes." + }, + "minVertexDataRead": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "the minimum amount of data read in a single vertex, in bytes." + }, + "readFailureCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the number of read failures in this stage." + }, + "revocationCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the number of vertices that were revoked during this stage." + }, + "runningCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the number of currently running vertices in this stage." + }, + "scheduledCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the number of currently scheduled vertices in this stage" + }, + "stageName": { + "type": "string", + "readOnly": true, + "description": "the name of this stage in job execution." + }, + "succeededCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the number of vertices that succeeded in this stage." + }, + "tempDataWritten": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "the amount of temporary data written, in bytes." + }, + "totalCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the total vertex count for this stage." + }, + "totalFailedTime": { + "type": "string", + "readOnly": true, + "format": "duration", + "description": "the amount of time that failed vertices took up in this stage." + }, + "totalProgress": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the current progress of this stage, as a percentage." + }, + "totalSucceededTime": { + "type": "string", + "readOnly": true, + "format": "duration", + "description": "the amount of time all successful vertices took in this stage." + } + }, + "description": "The Data Lake Analytics job statistics vertex stage information." + }, + "JobStatistics": { + "properties": { + "lastUpdateTimeUtc": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "the last update time for the statistics." + }, + "finalizingTimeUtc": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "the job finalizing start time." + }, + "stages": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobStatisticsVertexStage" + }, + "description": "the list of stages for the job." + } + }, + "description": "The Data Lake Analytics job execution statistics." + }, + "JobDataPath": { + "properties": { + "jobId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "the id of the job this data is for." + }, + "command": { + "type": "string", + "readOnly": true, + "description": "the command that this job data relates to." + }, + "paths": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "the list of paths to all of the job data." + } + }, + "description": "A Data Lake Analytics job data path item." + }, + "JobStateAuditRecord": { + "properties": { + "newState": { + "type": "string", + "readOnly": true, + "description": "the new state the job is in." + }, + "timeStamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "the time stamp that the state change took place." + }, + "requestedByUser": { + "type": "string", + "readOnly": true, + "description": "the user who requests the change." + }, + "details": { + "type": "string", + "readOnly": true, + "description": " the details of the audit log." + } + }, + "description": "The Data Lake Analytics job state audit records for tracking the lifecycle of a job." + }, + "JobResource": { + "properties": { + "name": { + "type": "string", + "description": "the name of the resource." + }, + "resourcePath": { + "type": "string", + "description": "the path to the resource." + }, + "type": { + "type": "string", + "description": "the job resource type.", + "enum": [ + "VertexResource", + "JobManagerResource", + "StatisticsResource", + "VertexResourceInUserFolder", + "JobManagerResourceInUserFolder", + "StatisticsResourceInUserFolder" + ], + "x-ms-enum": { + "name": "JobResourceType", + "modelAsString": false + } + } + }, + "description": "The Data Lake Analytics job resources." + }, + "USqlJobProperties": { + "x-ms-discriminator-value": "USql", + "allOf": [ + { + "$ref": "#/definitions/JobProperties" + } + ], + "properties": { + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/JobResource" + }, + "description": "the list of resources that are required by the job" + }, + "statistics": { + "$ref": "#/definitions/JobStatistics", + "description": "the job specific statistics." + }, + "debugData": { + "$ref": "#/definitions/JobDataPath", + "description": "the job specific debug data locations." + }, + "diagnostics": { + "type": "array", + "items": { + "$ref": "#/definitions/Diagnostics" + }, + "description": "the diagnostics for the job." + }, + "algebraFilePath": { + "type": "string", + "readOnly": true, + "description": "the algebra file path after the job has completed" + }, + "totalCompilationTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "the total time this job spent compiling. This value should not be set by the user and will be ignored if it is." + }, + "totalPauseTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "the total time this job spent paused. This value should not be set by the user and will be ignored if it is." + }, + "totalQueuedTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "the total time this job spent queued. This value should not be set by the user and will be ignored if it is." + }, + "totalRunningTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "the total time this job spent executing. This value should not be set by the user and will be ignored if it is." + }, + "rootProcessNodeId": { + "type": "string", + "readOnly": true, + "description": "the ID used to identify the job manager coordinating job execution. This value should not be set by the user and will be ignored if it is." + }, + "yarnApplicationId": { + "type": "string", + "readOnly": true, + "description": "the ID used to identify the yarn application executing the job. This value should not be set by the user and will be ignored if it is." + }, + "yarnApplicationTimeStamp": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "the timestamp (in ticks) for the yarn application executing the job. This value should not be set by the user and will be ignored if it is." + }, + "compileMode": { + "type": "string", + "description": "Optionally enforces a specific compilation mode for the job during execution. If this is not specified during submission, the server will determine the optimal compilation mode.", + "enum": [ + "Semantic", + "Full", + "SingleBox" + ], + "x-ms-enum": { + "name": "CompileMode", + "modelAsString": false + } + } + }, + "description": "U-SQL job properties used when submitting and retrieving U-SQL jobs." + }, + "HiveJobProperties": { + "x-ms-discriminator-value": "Hive", + "allOf": [ + { + "$ref": "#/definitions/JobProperties" + } + ], + "properties": { + "logsLocation": { + "type": "string", + "readOnly": true, + "description": "the Hive logs location" + }, + "outputLocation": { + "type": "string", + "readOnly": true, + "description": "the location of Hive job output files (both execution output and results)" + }, + "statementCount": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "the number of statements that will be run based on the script" + }, + "executedStatementCount": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "the number of statements that have been run based on the script" + } + }, + "description": "Hive job properties used when submitting and retrieving Hive jobs." + }, + "JobProperties": { + "discriminator": "type", + "required": [ + "script", + "type" + ], + "properties": { + "runtimeVersion": { + "type": "string", + "description": "the runtime version of the Data Lake Analytics engine to use for the specific type of job being run." + }, + "script": { + "type": "string", + "description": "the script to run" + }, + "type": { + "type": "string", + "description": "the job type of the current job (i.e. Hive or U-SQL)." + } + }, + "description": "The common Data Lake Analytics job properties." + }, + "Diagnostics" : { + "properties": { + "columnNumber" : { + "description": "the column where the error occured.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "end" : { + "description": "the ending index of the error.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "lineNumber" : { + "description": "the line number the error occured on.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "message" : { + "description": "the error message.", + "type": "string", + "readOnly": true + }, + "severity" : { + "description": "the severity of the error.", + "readOnly": true, + "type": "string", + "enum": [ + "Warning", + "Error", + "Info" + ], + "x-ms-enum": { + "name": "SeverityTypes", + "modelAsString": false + } + }, + "start" : { + "description": "the starting index of the error.", + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "description": "Error diagnostic information for failed jobs." + }, + "JobErrorDetails": { + "properties": { + "description": { + "type": "string", + "readOnly": true, + "description": "the error message description" + }, + "details": { + "type": "string", + "readOnly": true, + "description": "the details of the error message." + }, + "endOffset": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the end offset in the job where the error was found." + }, + "errorId": { + "type": "string", + "readOnly": true, + "description": "the specific identifier for the type of error encountered in the job." + }, + "filePath": { + "type": "string", + "readOnly": true, + "description": "the path to any supplemental error files, if any." + }, + "helpLink": { + "type": "string", + "readOnly": true, + "description": "the link to MSDN or Azure help for this type of error, if any." + }, + "internalDiagnostics": { + "type": "string", + "readOnly": true, + "description": "the internal diagnostic stack trace if the user requesting the job error details has sufficient permissions it will be retrieved, otherwise it will be empty." + }, + "lineNumber": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the specific line number in the job where the error occured." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "the user friendly error message for the failure." + }, + "resolution": { + "type": "string", + "readOnly": true, + "description": "the recommended resolution for the failure, if any." + }, + "innerError": { + "$ref": "#/definitions/JobInnerError", + "readOnly": true, + "description": "the inner error of this specific job error message, if any." + }, + "severity": { + "type": "string", + "readOnly": true, + "description": "the severity level of the failure.", + "enum": [ + "Warning", + "Error", + "Info" + ], + "x-ms-enum": { + "name": "SeverityTypes", + "modelAsString": false + } + }, + "source": { + "type": "string", + "readOnly": true, + "description": "the ultimate source of the failure (usually either SYSTEM or USER)." + }, + "startOffset": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the start offset in the job where the error was found" + } + }, + "description": "The Data Lake Analytics job error details." + }, + "JobInnerError": { + "properties": { + "diagnosticCode": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "the diagnostic error code." + }, + "severity": { + "type": "string", + "readOnly": true, + "description": "the severity level of the failure.", + "enum": [ + "Warning", + "Error", + "Info" + ], + "x-ms-enum": { + "name": "SeverityTypes", + "modelAsString": false + } + }, + "details": { + "type": "string", + "readOnly": true, + "description": "the details of the error message." + }, + "component": { + "type": "string", + "readOnly": true, + "description": "the component that failed." + }, + "errorId": { + "type": "string", + "readOnly": true, + "description": "the specific identifier for the type of error encountered in the job." + }, + "helpLink": { + "type": "string", + "readOnly": true, + "description": "the link to MSDN or Azure help for this type of error, if any." + }, + "internalDiagnostics": { + "type": "string", + "readOnly": true, + "description": "the internal diagnostic stack trace if the user requesting the job error details has sufficient permissions it will be retrieved, otherwise it will be empty." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "the user friendly error message for the failure." + }, + "resolution": { + "type": "string", + "readOnly": true, + "description": "the recommended resolution for the failure, if any." + }, + "source": { + "type": "string", + "readOnly": true, + "description": "the ultimate source of the failure (usually either SYSTEM or USER)." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "the error message description" + } + }, + "description": "The Data Lake Analytics job error details." + }, + "JobInformation": { + "properties": { + "jobId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "the job's unique identifier (a GUID)." + }, + "name": { + "type": "string", + "description": "the friendly name of the job." + }, + "type": { + "type": "string", + "description": "the job type of the current job (Hive or USql).", + "enum": [ + "USql", + "Hive" + ], + "x-ms-enum": { + "name": "JobType", + "modelAsString": false + } + }, + "submitter": { + "type": "string", + "readOnly": true, + "description": "the user or account that submitted the job." + }, + "errorMessage": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobErrorDetails" + }, + "description": "the error message details for the job, if the job failed." + }, + "degreeOfParallelism": { + "type": "integer", + "minimum": 1, + "default": 1, + "format": "int32", + "description": "the degree of parallelism used for this job. This must be greater than 0." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "the priority value for the current job. Lower numbers have a higher priority. By default, a job has a priority of 1000. This must be greater than 0." + }, + "submitTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "the time the job was submitted to the service." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "the start time of the job." + }, + "endTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "the completion time of the job." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "the job state. When the job is in the Ended state, refer to Result and ErrorMessage for details.", + "enum": [ + "Accepted", + "Compiling", + "Ended", + "New", + "Queued", + "Running", + "Scheduling", + "Starting", + "Paused", + "WaitingForCapacity" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": false + } + }, + "result": { + "type": "string", + "readOnly": true, + "description": "the result of job execution or the current result of the running job.", + "enum": [ + "None", + "Succeeded", + "Cancelled", + "Failed" + ], + "x-ms-enum": { + "name": "JobResult", + "modelAsString": false + } + }, + "logFolder": { + "type": "string", + "readOnly": true, + "description": "the log folder path to use in the following format: adl://.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/." + }, + "logFilePatterns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the list of log file name patterns to find in the logFolder. '*' is the only matching character allowed. Example format: jobExecution*.log or *mylog*.txt" + }, + "stateAuditRecords": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobStateAuditRecord" + }, + "description": "the job state audit records, indicating when various operations have been performed on this job." + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "the job specific properties." + } + }, + "required": [ + "name", + "type", + "properties" + ], + "description": "The common Data Lake Analytics job information properties." + }, + "JobInfoListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobInformation" + }, + "description": "the list of jobInfo items." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "the link (url) to the next page of results." + } + }, + "description": "List of jobInfo items." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "adlaJobDnsSuffixInPath": { + "name": "adlaJobDnsSuffix", + "in": "path", + "required": true, + "type": "string", + "default": "azuredatalakeanalytics.net", + "x-ms-skip-url-encoding": true, + "description": "Gets the DNS suffix used as the base for all Azure Data Lake Analytics Job service requests." + } + } +} diff --git a/arm-datalake-store/account/2016-11-01/swagger/account.json b/arm-datalake-store/account/2016-11-01/swagger/account.json new file mode 100644 index 0000000000000..2c6001cb05fac --- /dev/null +++ b/arm-datalake-store/account/2016-11-01/swagger/account.json @@ -0,0 +1,1327 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataLakeStoreAccountManagementClient", + "description": "Creates an Azure Data Lake Store account management client.", + "version": "2016-11-01", + "x-ms-code-generation-settings": { + "internalConstructors": true + } + }, + "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.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}": { + "put": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "description": "Creates or updates the specified firewall rule. During update, the firewall rule with the specified name will be replaced with this new firewall rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to which to add the firewall rule." + }, + { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "Parameters supplied to create or update the firewall rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the specified firewall rule", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + } + } + }, + "delete": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "description": "Deletes the specified firewall rule from the specified Data Lake Store account", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account from which to delete the firewall rule." + }, + { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the specified firewall rule" + }, + "204": { + "description": "The specified firewall rule does not exist or was already deleted." + } + } + }, + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "description": "Gets the specified Data Lake Store firewall rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account from which to get the firewall rule." + }, + { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule to retrieve." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of firewall rules.", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules": { + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_ListByAccount", + "description": "Lists the Data Lake Store firewall rules within the specified Data Lake Store account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account from which to get the firewall rules." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created the firewall rule.", + "schema": { + "$ref": "#/definitions/DataLakeStoreFirewallRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders/{trustedIdProviderName}": { + "put": { + "tags": [ + "TrustedIdProviders" + ], + "operationId": "TrustedIdProviders_CreateOrUpdate", + "description": "Creates or updates the specified trusted identity provider. During update, the trusted identity provider with the specified name will be replaced with this new provider", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to which to add the trusted identity provider." + }, + { + "name": "trustedIdProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the trusted identity provider. This is used for differentiation of providers in the account." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrustedIdProvider" + }, + "description": "Parameters supplied to create the create the trusted identity provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the trusted identity provider.", + "schema": { + "$ref": "#/definitions/TrustedIdProvider" + } + } + } + }, + "delete": { + "tags": [ + "TrustedIdProviders" + ], + "operationId": "TrustedIdProviders_Delete", + "description": "Deletes the specified trusted identity provider from the specified Data Lake Store account", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account from which to delete the trusted identity provider." + }, + { + "name": "trustedIdProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the trusted identity provider to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the specified trusted identity provider details." + }, + "204": { + "description": "The specified trusted identity provider was not found." + } + } + }, + "get": { + "tags": [ + "TrustedIdProviders" + ], + "operationId": "TrustedIdProviders_Get", + "description": "Gets the specified Data Lake Store trusted identity provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account from which to get the trusted identity provider." + }, + { + "name": "trustedIdProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the trusted identity provider to retrieve." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved details of the specified trusted identity provider.", + "schema": { + "$ref": "#/definitions/TrustedIdProvider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/trustedIdProviders": { + "get": { + "tags": [ + "TrustedIdProviders" + ], + "operationId": "TrustedIdProviders_ListByAccount", + "description": "Lists the Data Lake Store trusted identity providers within the specified Data Lake Store account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account from which to get the trusted identity providers." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of trusted identity providers.", + "schema": { + "$ref": "#/definitions/DataLakeStoreTrustedIdProviderListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{name}": { + "put": { + "tags": [ + "Account" + ], + "operationId": "Account_Create", + "description": "Creates the specified Data Lake Store account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to create." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + }, + "description": "Parameters supplied to create the Data Lake Store account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Successfully initiated creation of the account.", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + }, + "200": { + "description": "Successfully created the account.", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Account" + ], + "operationId": "Account_Update", + "description": "Updates the specified Data Lake Store account information.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataLakeStoreAccountUpdateParameters" + }, + "description": "Parameters supplied to update the Data Lake Store account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the account details.", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + }, + "201": { + "description": "Successfully initiated the update of the account details.", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}": { + "delete": { + "tags": [ + "Account" + ], + "operationId": "Account_Delete", + "description": "Deletes the specified Data Lake Store account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the specified account." + }, + "204": { + "description": "The specified account was not found." + }, + "202": { + "description": "Successfully initiated the deletion of the specified account." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Account" + ], + "operationId": "Account_Get", + "description": "Gets the specified Data Lake Store account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to retrieve." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved details of the specified account.", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/enableKeyVault": { + "post": { + "tags": [ + "Account" + ], + "operationId": "Account_EnableKeyVault", + "description": "Attempts to enable a user managed key vault for encryption of the specified Data Lake Store account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to attempt to enable the Key Vault for." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully enabled the user-managed Key Vault settings used for encrypting this Data Lake Store account." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts": { + "get": { + "tags": [ + "Account" + ], + "operationId": "Account_ListByResourceGroup", + "description": "Lists the Data Lake Store accounts within a specific resource group. The response includes a link to the next page of results, if any.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group that contains the Data Lake Store account(s)." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to skip over before returning elements. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "A Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of accounts in the specified resource group.", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DataLakeStoreAccount" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/accounts": { + "get": { + "tags": [ + "Account" + ], + "operationId": "Account_List", + "description": "Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The number of items to skip over before returning elements. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "OrderBy clause. One or more comma-separated expressions with an optional \"asc\" (the default) or \"desc\" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of accounts.", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DataLakeStoreAccount" + } + } + }, + "definitions": { + "FirewallRuleProperties": { + "required": [ + "startIpAddress", + "endIpAddress" + ], + "properties": { + "startIpAddress": { + "type": "string", + "description": "the start IP address for the firewall rule." + }, + "endIpAddress": { + "type": "string", + "description": "the end IP address for the firewall rule." + } + }, + "description": "Data Lake Store firewall rule properties information" + }, + "FirewallRule": { + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "description": "the properties of the firewall rule.", + "x-ms-client-flatten": true + } + }, + "description": "Data Lake Store firewall rule information" + }, + "TrustedIdProviderProperties": { + "required": [ + "idProvider" + ], + "properties": { + "idProvider": { + "type": "string", + "description": "The URL of this trusted identity provider" + } + }, + "description": "Data Lake Store trusted identity provider properties information" + }, + "TrustedIdProvider": { + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/TrustedIdProviderProperties", + "description": "the properties of the trusted identity provider.", + "x-ms-client-flatten": true + } + }, + "description": "Data Lake Store firewall rule information" + }, + "DataLakeStoreTrustedIdProviderListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedIdProvider" + }, + "description": "the results of the list operation" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "the link (url) to the next page of results." + } + }, + "description": "Data Lake Store trusted identity provider list information." + }, + "DataLakeStoreFirewallRuleListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "the results of the list operation" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "the link (url) to the next page of results." + } + }, + "description": "Data Lake Store firewall rule list information." + }, + "EncryptionIdentity": { + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of encryption being used. Currently the only supported type is 'SystemAssigned'.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "EncryptionIdentityType", + "modelAsString": false + } + }, + "principalId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The principal identifier associated with the encryption." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "readOnly": true, + "description": "The tenant identifier associated with the encryption." + } + }, + "description": "The encryption identity properties." + }, + "EncryptionConfig": { + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'.", + "enum": [ + "UserManaged", + "ServiceManaged" + ], + "x-ms-enum": { + "name": "EncryptionConfigType", + "modelAsString": false + } + }, + "keyVaultMetaInfo": { + "$ref": "#/definitions/KeyVaultMetaInfo", + "description": "The Key vault information for connecting to user managed encryption keys." + } + }, + "description": "The encryption configuration for the account." + }, + "KeyVaultMetaInfo": { + "required": [ + "keyVaultResourceId", + "encryptionKeyName", + "encryptionKeyVersion" + ], + "properties": { + "keyVaultResourceId": { + "type": "string", + "description": "The resource identifier for the user managed Key Vault being used to encrypt." + }, + "encryptionKeyName": { + "type": "string", + "description": "The name of the user managed encryption key." + }, + "encryptionKeyVersion": { + "type": "string", + "description": "The version of the user managed encryption key." + } + }, + "description": "Metadata information used by account encryption." + }, + "DataLakeStoreAccountProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "the status of the Data Lake Store account while being provisioned.", + "enum": [ + "Failed", + "Creating", + "Running", + "Succeeded", + "Patching", + "Suspending", + "Resuming", + "Deleting", + "Deleted" + ], + "x-ms-enum": { + "name": "DataLakeStoreAccountStatus", + "modelAsString": false + } + }, + "state": { + "readOnly": true, + "type": "string", + "description": "the status of the Data Lake Store account after provisioning has completed.", + "enum": [ + "Active", + "Suspended" + ], + "x-ms-enum": { + "name": "DataLakeStoreAccountState", + "modelAsString": false + } + }, + "creationTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "the account creation time." + }, + "encryptionState": { + "type": "string", + "description": "The current state of encryption for this Data Lake store account.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EncryptionState", + "modelAsString": false + } + }, + "encryptionProvisioningState": { + "readOnly": true, + "type": "string", + "description": "The current state of encryption provisioning for this Data Lake store account.", + "enum": [ + "Creating", + "Succeeded" + ], + "x-ms-enum": { + "name": "EncryptionProvisioningState", + "modelAsString": false + } + }, + "encryptionConfig": { + "$ref": "#/definitions/EncryptionConfig", + "description": "The Key vault encryption configuration." + }, + "firewallState": { + "type": "string", + "description": "The current state of the IP address firewall for this Data Lake store account.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "FirewallState", + "modelAsString": false + } + }, + "firewallRules": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The list of firewall rules associated with this Data Lake store account." + }, + "trustedIdProviderState": { + "type": "string", + "description": "The current state of the trusted identity provider feature for this Data Lake store account.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "TrustedIdProviderState", + "modelAsString": false + } + }, + "trustedIdProviders": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedIdProvider" + }, + "description": "The list of trusted identity providers associated with this Data Lake store account." + }, + "lastModifiedTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "the account last modified time." + }, + "endpoint": { + "type": "string", + "readOnly": true, + "description": "the gateway host." + }, + "defaultGroup": { + "type": "string", + "description": "the default owner group for all new folders and files created in the Data Lake Store account." + } + }, + "description": "Data Lake Store account properties information" + }, + "UpdateDataLakeStoreAccountProperties": { + "properties": { + "firewallState": { + "type": "string", + "description": "The current state of the IP address firewall for this Data Lake store account. Disabling the firewall does not remove existing rules, they will just be ignored until the firewall is re-enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "FirewallState", + "modelAsString": false + } + }, + "trustedIdProviderState": { + "type": "string", + "description": "The current state of the trusted identity provider feature for this Data Lake store account. Disabling trusted identity provider functionality does not remove the providers, they will just be ignored until this feature is re-enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "TrustedIdProviderState", + "modelAsString": false + } + }, + "defaultGroup": { + "type": "string", + "description": "the default owner group for all new folders and files created in the Data Lake Store account." + } + }, + "description": "Data Lake Store account properties information to be updated." + }, + "DataLakeStoreAccountUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "$ref": "#/definitions/UpdateDataLakeStoreAccountProperties", + "description": "the Data Lake Store account properties to update.", + "x-ms-client-flatten": true + } + }, + "description": "Data Lake Store account information to update" + }, + "DataLakeStoreAccount": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "The Key vault encryption identity, if any." + }, + "properties": { + "$ref": "#/definitions/DataLakeStoreAccountProperties", + "description": "the Data Lake Store account properties.", + "x-ms-client-flatten": true + } + }, + "description": "Data Lake Store account information" + }, + "DataLakeStoreAccountListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DataLakeStoreAccount" + }, + "description": "the results of the list operation" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "the link (url) to the next page of results." + } + }, + "description": "Data Lake Store account list information response." + }, + "ErrorDetails": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "the HTTP status code or error code associated with this error" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "the error message localized based on Accept-Language" + }, + "target": { + "type": "string", + "readOnly": true, + "description": "the target of the particular error (for example, the name of the property in error)." + } + }, + "description": "Data Lake Store error details information" + }, + "InnerError": { + "properties": { + "trace": { + "type": "string", + "readOnly": true, + "description": "the stack trace for the error" + }, + "context": { + "type": "string", + "readOnly": true, + "description": "the context for the error message" + } + }, + "description": "Data Lake Store inner error information" + }, + "Error": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "the HTTP status code or error code associated with this error" + }, + "message": { + "type": "string", + "readOnly": true, + "description": "the error message to display." + }, + "target": { + "type": "string", + "readOnly": true, + "description": "the target of the error." + }, + "details": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "description": "the list of error details" + }, + "innerError": { + "$ref": "#/definitions/InnerError", + "readOnly": true, + "description": "the inner exceptions or errors, if any" + } + }, + "description": "Data Lake Store error information" + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "description": "The Resource model definition for a nested resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets 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." + } + } +} \ No newline at end of file diff --git a/arm-datalake-store/filesystem/2015-10-01-preview/swagger/filesystem.json b/arm-datalake-store/filesystem/2015-10-01-preview/swagger/filesystem.json index 3fac5e8266884..6b79b15e2e12e 100644 --- a/arm-datalake-store/filesystem/2015-10-01-preview/swagger/filesystem.json +++ b/arm-datalake-store/filesystem/2015-10-01-preview/swagger/filesystem.json @@ -47,7 +47,7 @@ "application/octet-stream" ], "operationId": "FileSystem_ConcurrentAppend", - "description": "Appends to the specified file. This method supports multiple concurrent appends to the file. NOTE: Concurrent append and normal (serial) append CANNOT be used interchangeably. Once a file has been appended to using either append option, it can only be appended to using that append option.", + "description": "Appends to the specified file. This method supports multiple concurrent appends to the file. NOTE: ConcurrentAppend and normal (serial) Append CANNOT be used interchangeably; once a file has been appended to using either of these append options, it can only be appended to using that append option. ConcurrentAppend DOES NOT guarantee order and can result in duplicated data landing in the target file. In order to close a file after using ConcurrentAppend, call the Flush method.", "parameters": [ { "name": "filePath", @@ -555,6 +555,72 @@ } } }, + "/webhdfs/v1/{flushFilePath}": { + "post": { + "tags": [ + "FileSystem" + ], + "consumes": [ + "application/octet-stream" + ], + "operationId": "FileSystem_Flush", + "description": "Flushes the specified file to the store. This forces an update to the metadata of the file (returned from GetFileStatus), and is required by ConcurrentAppend once the file is done to populate finalized metadata.", + "parameters": [ + { + "name": "flushFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The Data Lake Store path (starting with '/') of the file to which to flush." + }, + { + "name": "op", + "in": "query", + "required": true, + "type": "string", + "description": "The constant value for the operation.", + "enum": [ + "APPEND" + ] + }, + { + "name": "append", + "in": "query", + "required": true, + "description": "The constant value that avoids redirects.", + "type": "string", + "enum": [ + "true" + ] + }, + { + "name": "flush", + "in": "query", + "required": true, + "description": "The constant value initiating the flush.", + "type": "string", + "enum": [ + "true" + ] + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully flushed the specified file." + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } + } + } + } + }, "/webhdfs/v1/{directFilePath}": { "post": { "tags": [ @@ -611,16 +677,6 @@ "true" ] }, - { - "name": "Transfer-Encoding", - "in": "header", - "required": true, - "type": "string", - "description": "Indicates the data being sent to the server is being streamed in chunks.", - "enum": [ - "chunked" - ] - }, { "$ref": "#/parameters/ApiVersionParameter" } @@ -692,16 +748,6 @@ "true" ] }, - { - "name": "Transfer-Encoding", - "in": "header", - "required": true, - "type": "string", - "description": "Indicates the data being sent to the server is being streamed in chunks.", - "enum": [ - "chunked" - ] - }, { "$ref": "#/parameters/ApiVersionParameter" } diff --git a/arm-datalake-store/filesystem/VNext/swagger/filesystem.json b/arm-datalake-store/filesystem/2016-11-01/swagger/filesystem.json similarity index 70% rename from arm-datalake-store/filesystem/VNext/swagger/filesystem.json rename to arm-datalake-store/filesystem/2016-11-01/swagger/filesystem.json index 471732fdfdaaa..6088f67282e11 100644 --- a/arm-datalake-store/filesystem/VNext/swagger/filesystem.json +++ b/arm-datalake-store/filesystem/2016-11-01/swagger/filesystem.json @@ -3,7 +3,7 @@ "info": { "title": "DataLakeStoreFileSystemManagementClient", "description": "Creates an Azure Data Lake Store filesystem client.", - "version": "2015-10-01-preview", + "version": "2016-11-01", "x-ms-code-generation-settings": { "internalConstructors": true } @@ -28,57 +28,13 @@ "https" ], "consumes": [ - "application/json", - "text/json", - "application/octet-stream" + "application/json" ], "produces": [ - "application/json", - "text/json", - "application/octet-stream" + "application/json" ], "paths": { "/WebHdfsExt/{filePath}": { - "get": { - "tags": [ - "FileSystem" - ], - "operationId": "FileSystem_GetFileInfo", - "description": "Gets the file information object containing the expiration time for the file at the file path.", - "parameters": [ - { - "name": "filePath", - "in": "path", - "required": true, - "type": "string", - "description": "The Data Lake Store path (starting with '/') of the file for which you want the file expiration information." - }, - { - "name": "op", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "GETFILEINFO" - ], - "description": "The constant value for the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/FileInfoResult" - } - } - } - }, "post": { "tags": [ "FileSystem" @@ -87,7 +43,7 @@ "application/octet-stream" ], "operationId": "FileSystem_ConcurrentAppend", - "description": "Appends to the specified file. This method supports multiple concurrent appends to the file. NOTE: Concurrent append and normal (serial) append CANNOT be used interchangeably. Once a file has been appended to using either append option, it can only be appended to using that append option.", + "description": "Appends to the specified file. This method supports multiple concurrent appends to the file. NOTE: ConcurrentAppend and normal (serial) Append CANNOT be used interchangeably; once a file has been appended to using either of these append options, it can only be appended to using that append option. ConcurrentAppend DOES NOT guarantee order and can result in duplicated data landing in the target file.", "parameters": [ { "name": "filePath", @@ -131,15 +87,29 @@ ] }, { - "$ref": "#/parameters/ApiVersionParameter" + "name": "Transfer-Encoding", + "in": "header", + "required": true, + "type": "string", + "description": "Indicates the data being sent to the server is being streamed in chunks.", + "enum": [ + "chunked" + ] }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "" + "description": "OK" + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } }, @@ -194,14 +164,18 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "" + "description": "Successfully set the expiration time on the specified file." + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -240,14 +214,18 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "" + "description": "OK" + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } }, @@ -277,17 +255,21 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "", + "description": "OK", "schema": { "$ref": "#/definitions/FileOperationResult" } + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -298,7 +280,7 @@ "FileSystem" ], "operationId": "FileSystem_Concat", - "description": "Concatenates the list of source files into the destination file.", + "description": "Concatenates the list of source files into the destination file, removing all source files upon success.", "parameters": [ { "name": "destinationPath", @@ -330,14 +312,18 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "" + "description": "OK" + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -351,7 +337,7 @@ "application/octet-stream" ], "operationId": "FileSystem_MsConcat", - "description": "Concatenates the list of source files into the destination file. This method accepts more source file paths than the Concat method. This method and the parameters it accepts are subject to change for usability in an upcoming version.", + "description": "Concatenates the list of source files into the destination file, deleting all source files upon success. This method accepts more source file paths than the Concat method. This method and the parameters it accepts are subject to change for usability in an upcoming version.", "parameters": [ { "name": "msConcatDestinationPath", @@ -361,11 +347,11 @@ "description": "The Data Lake Store path (starting with '/') of the destination file resulting from the concatenation." }, { - "name": "deletesourcedirectory", + "name": "deleteSourceDirectory", "in": "query", "required": false, "type": "boolean", - "description": "Caution: Setting this parameter to true will delete the parent directory of all source files provided to the MsConcat method." + "description": "Indicates that as an optimization instead of deleting each individual source stream, delete the source stream folder if all streams are in the same folder instead. This results in a substantial performance improvement when the only streams in the folder are part of the concatenation operation. WARNING: This includes the deletion of any other files that are not source files. Only set this to true when source files are the only files in the source directory." }, { "name": "streamContents", @@ -389,14 +375,18 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "" + "description": "OK" + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -450,17 +440,21 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "", + "description": "OK", "schema": { "$ref": "#/definitions/FileStatusesResult" } + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -492,17 +486,21 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "", + "description": "OK", "schema": { "$ref": "#/definitions/ContentSummaryResult" } + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -529,22 +527,26 @@ "type": "string", "description": "The constant value for the operation.", "enum": [ - "GETFILESTATUS" + "MSGETFILESTATUS" ] }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "", + "description": "OK", "schema": { "$ref": "#/definitions/FileStatusResult" } + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -577,6 +579,31 @@ "required": true, "description": "The file contents to include when appending to the file." }, + { + "name": "offset", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The optional offset in the stream to begin the append operation. Default is to append at the end of the stream." + }, + { + "name": "syncFlag", + "in": "query", + "required": false, + "type": "string", + "default": "CLOSE", + "description": "Optionally indicates what to do after completion of the append. DATA indicates more data is coming so no sync takes place, METADATA indicates a sync should be done to refresh metadata of the file only. CLOSE indicates that both the stream and metadata should be refreshed upon append completion.", + "enum": [ + "DATA", + "METADATA", + "CLOSE" + ], + "x-ms-enum": { + "name": "SyncFlag", + "modelAsString": false + } + }, { "name": "op", "in": "query", @@ -599,14 +626,18 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "" + "description": "OK" + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } }, @@ -644,6 +675,23 @@ "type": "boolean", "description": "The indication of if the file should be overwritten." }, + { + "name": "syncFlag", + "in": "query", + "required": false, + "type": "string", + "default": "CLOSE", + "description": "Optionally indicates what to do after completion of the append. DATA indicates more data is coming so no sync takes place, METADATA indicates a sync should be done to refresh metadata of the file only. CLOSE indicates that both the stream and metadata should be refreshed upon append completion.", + "enum": [ + "DATA", + "METADATA", + "CLOSE" + ], + "x-ms-enum": { + "name": "SyncFlag", + "modelAsString": false + } + }, { "name": "op", "in": "query", @@ -666,14 +714,18 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { - "description": "" + "description": "CREATED" + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } }, @@ -683,6 +735,9 @@ ], "operationId": "FileSystem_Open", "description": "Opens and reads from the specified file.", + "produces": [ + "application/octet-stream" + ], "parameters": [ { "name": "directFilePath", @@ -696,14 +751,16 @@ "in": "query", "required": false, "type": "integer", - "format": "int64" + "format": "int64", + "description": "The number of bytes that the server will attempt to retrieve. It will retrieve <= length bytes." }, { "name": "offset", "in": "query", "required": false, "type": "integer", - "format": "int64" + "format": "int64", + "description": "The byte offset to start reading data from." }, { "name": "op", @@ -727,17 +784,21 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "", + "description": "OK", "schema": { "type": "file" } + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -776,14 +837,18 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "" + "description": "OK" + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -822,14 +887,18 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "" + "description": "OK" + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -868,14 +937,61 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } + } + } + } + }, + "/webhdfs/v1/{defaultAclFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_RemoveDefaultAcl", + "description": "Removes the existing Default Access Control List (ACL) of the specified directory.", + "parameters": [ + { + "name": "defaultAclFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The Data Lake Store path (starting with '/') of the directory with the default ACL being removed." + }, + { + "name": "op", + "in": "query", + "required": true, + "type": "string", + "description": "The constant value for the operation.", + "enum": [ + "REMOVEDEFAULTACL" + ] }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "" + "description": "Successfully Removed the Default Access Control List on the specified directory." + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -907,14 +1023,18 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "" + "description": "Successfully removed the Access Control List on the specified file or directory." + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } }, @@ -939,22 +1059,26 @@ "type": "string", "description": "The constant value for the operation.", "enum": [ - "GETACLSTATUS" + "MSGETACLSTATUS" ] }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "", + "description": "OK", "schema": { "$ref": "#/definitions/AclStatusResult" } + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -993,17 +1117,21 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "", + "description": "OK", "schema": { "$ref": "#/definitions/FileOperationResult" } + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -1042,17 +1170,21 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "", + "description": "OK", "schema": { "$ref": "#/definitions/FileOperationResult" } + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -1098,14 +1230,18 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "" + "description": "OK" + }, + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" + } } } } @@ -1144,48 +1280,17 @@ }, { "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { - "description": "" - } - } - } - }, - "/webhdfs/v1/": { - "get": { - "tags": [ - "FileSystem" - ], - "operationId": "FileSystem_GetHomeDirectory", - "description": "Get the home directory for the specified account.", - "parameters": [ - { - "name": "op", - "in": "query", - "required": true, - "type": "string", - "description": "The constant value for the operation.", - "enum": [ - "GETHOMEDIRECTORY" - ] + "description": "OK" }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/HomeDirectoryResult" + "default": { + "description": "An unexpected error from the server.", + "schema": + { + "$ref": "#/definitions/AdlsError" } } } @@ -1197,8 +1302,9 @@ "properties": { "boolean": { "type": "boolean", + "x-ms-client-name": "operationResult", "readOnly": true, - "description": "Gets the result of the operation or request." + "description": "the result of the operation or request." } }, "description": "The result of the request or operation." @@ -1210,19 +1316,25 @@ "items": { "type": "string" }, - "description": "Gets or sets the list of ACLSpec entries on a file or directory." + "description": "the list of ACLSpec entries on a file or directory." }, "group": { "type": "string", - "description": "Gets or sets the group owner, an AAD Object ID." + "description": "the group owner, an AAD Object ID." }, "owner": { "type": "string", - "description": "Gets or sets the user owner, an AAD Object ID." + "description": "the user owner, an AAD Object ID." + }, + "permission": { + "type": "integer", + "format": "int32", + "description": "The octal representation of the unnamed user, mask and other permissions." }, "stickyBit": { "type": "boolean", - "description": "Gets or sets the indicator of whether the sticky bit is on or off." + "readOnly": true, + "description": "the indicator of whether the sticky bit is on or off." } }, "description": "Data Lake Store file or directory Access Control List information." @@ -1231,45 +1343,36 @@ "properties": { "AclStatus": { "$ref": "#/definitions/AclStatus", - "description": "Gets or sets the AclStatus object for a given file or directory." + "description": "the AclStatus object for a given file or directory." } }, "description": "Data Lake Store file or directory Access Control List information." }, - "HomeDirectoryResult": { - "properties": { - "Path": { - "type": "string", - "description": "Gets or sets the path to the home directory" - } - }, - "description": "Data Lake Store filesystem home path response." - }, "ContentSummary": { "properties": { "directoryCount": { "type": "integer", "readOnly": true, "format": "int64", - "description": "Gets the number of directories." + "description": "the number of directories." }, "fileCount": { "type": "integer", "readOnly": true, "format": "int64", - "description": "Gets the number of files." + "description": "the number of files." }, "length": { "type": "integer", "readOnly": true, "format": "int64", - "description": "Gets the number of bytes used by the contet." + "description": "the number of bytes used by the content." }, "spaceConsumed": { "type": "integer", "readOnly": true, "format": "int64", - "description": "Gets the disk space consumed by the content." + "description": "the disk space consumed by the content." } }, "description": "Data Lake Store content summary information" @@ -1279,7 +1382,7 @@ "ContentSummary": { "$ref": "#/definitions/ContentSummary", "readOnly": true, - "description": "Gets the content summary for the specified path" + "description": "the content summary for the specified path" } }, "description": "Data Lake Store filesystem content summary information response." @@ -1290,59 +1393,65 @@ "type": "integer", "readOnly": true, "format": "int64", - "description": "Gets the last access time as ticks since the epoch." + "description": "the last access time as ticks since the epoch." }, "blockSize": { "type": "integer", "readOnly": true, "format": "int64", - "description": "Gets the block size for the file." + "description": "the block size for the file." }, "childrenNum": { "type": "integer", "readOnly": true, "format": "int64", - "description": "Gets the number of children in the directory." + "description": "the number of children in the directory." + }, + "expirationTime": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "Gets the expiration time, if any, as ticks since the epoch. If the value is 0 or DateTime.MaxValue there is no expiration." }, "group": { "type": "string", "readOnly": true, - "description": "Gets the group owner." + "description": "the group owner." }, "length": { "type": "integer", "readOnly": true, "format": "int64", - "description": "Gets the number of bytes in a file." + "description": "the number of bytes in a file." }, "modificationTime": { "type": "integer", "readOnly": true, "format": "int64", - "description": "Gets the modification time as ticks since the epoch." + "description": "the modification time as ticks since the epoch." }, "owner": { "type": "string", "readOnly": true, - "description": "Gets the user who is the owner." + "description": "the user who is the owner." }, "pathSuffix": { "type": "string", "readOnly": true, - "description": "Gets the path suffix." + "description": "the path suffix." }, "permission": { "type": "string", "readOnly": true, - "description": "Gets the permission represented as an string." + "description": "the permission represented as an string." }, "type": { "type": "string", "readOnly": true, - "description": "Gets the type of the path object.", + "description": "the type of the path object.", "enum": [ - "File", - "Directory" + "FILE", + "DIRECTORY" ], "x-ms-enum": { "name": "FileType", @@ -1352,45 +1461,6 @@ }, "description": "Data Lake Store file or directory information." }, - "FileInfoProperties": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the file unique identifier (as a GUID)." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the file name." - }, - "length": { - "type": "integer", - "readOnly": true, - "format": "int64", - "description": "Gets the number of bytes in a file." - }, - "modificationTime": { - "type": "integer", - "readOnly": true, - "format": "int64", - "description": "Gets the modification time as ticks since the epoch." - }, - "creationTime": { - "type": "integer", - "readOnly": true, - "format": "int64", - "description": "Gets the creation time as ticks since the epoch." - }, - "expirationTime": { - "type": "integer", - "readOnly": true, - "format": "int64", - "description": "Gets the expiration time, if any, as ticks since the epoch. If this is set to 0 or DateTime.MaxValue there is no expiration." - } - }, - "description": "Data Lake Store file information." - }, "FileStatuses": { "properties": { "FileStatus": { @@ -1399,7 +1469,7 @@ "items": { "$ref": "#/definitions/FileStatusProperties" }, - "description": "Gets the object containing the list of properties of the files." + "description": "the object containing the list of properties of the files." } }, "description": "Data Lake Store file status list information." @@ -1409,7 +1479,7 @@ "FileStatuses": { "$ref": "#/definitions/FileStatuses", "readOnly": true, - "description": "Gets the object representing the list of file statuses." + "description": "the object representing the list of file statuses." } }, "description": "Data Lake Store filesystem file status list information response." @@ -1419,30 +1489,128 @@ "FileStatus": { "$ref": "#/definitions/FileStatusProperties", "readOnly": true, - "description": "Gets the file status object associated with the specified path." + "description": "the file status object associated with the specified path." } }, "description": "Data Lake Store filesystem file status information response." }, - "FileInfoResult": { + "AdlsIllegalArgumentException": { + "x-ms-discriminator-value": "IllegalArgumentException", + "allOf": [ + { + "$ref": "#/definitions/AdlsRemoteException" + } + ], + "description": "A WebHDFS exception thrown indicating that one more arguments is incorrect. Thrown when a 400 error response code is returned (bad request)." + }, + "AdlsUnsupportedOperationException": { + "x-ms-discriminator-value": "UnsupportedOperationException", + "allOf": [ + { + "$ref": "#/definitions/AdlsRemoteException" + } + ], + "description": "A WebHDFS exception thrown indicating that the requested operation is not supported. Thrown when a 400 error response code is returned (bad request)." + }, + "AdlsSecurityException": { + "x-ms-discriminator-value": "SecurityException", + "allOf": [ + { + "$ref": "#/definitions/AdlsRemoteException" + } + ], + "description": "A WebHDFS exception thrown indicating that access is denied. Thrown when a 401 error response code is returned (Unauthorized)." + }, + "AdlsIOException": { + "x-ms-discriminator-value": "IOException", + "allOf": [ + { + "$ref": "#/definitions/AdlsRemoteException" + } + ], + "description": "A WebHDFS exception thrown indicating there was an IO (read or write) error. Thrown when a 403 error response code is returned (forbidden)." + }, + "AdlsFileNotFoundException": { + "x-ms-discriminator-value": "FileNotFoundException", + "allOf": [ + { + "$ref": "#/definitions/AdlsRemoteException" + } + ], + "description": "A WebHDFS exception thrown indicating the file or folder could not be found. Thrown when a 404 error response code is returned (not found)." + }, + "AdlsFileAlreadyExistsException": { + "x-ms-discriminator-value": "FileAlreadyExistsException", + "allOf": [ + { + "$ref": "#/definitions/AdlsRemoteException" + } + ], + "description": "A WebHDFS exception thrown indicating the file or folder already exists. Thrown when a 403 error response code is returned (forbidden)." + }, + "AdlsBadOffsetException": { + "x-ms-discriminator-value": "BadOffsetException", + "allOf": [ + { + "$ref": "#/definitions/AdlsRemoteException" + } + ], + "description": "A WebHDFS exception thrown indicating the append or read is from a bad offset. Thrown when a 400 error response code is returned for append and open operations (Bad request)." + }, + "AdlsRuntimeException": { + "x-ms-discriminator-value": "RuntimeException", + "allOf": [ + { + "$ref": "#/definitions/AdlsRemoteException" + } + ], + "description": "A WebHDFS exception thrown when an unexpected error occurs during an operation. Thrown when a 500 error response code is returned (Internal server error)." + }, + "AdlsAccessControlException": { + "x-ms-discriminator-value": "AccessControlException", + "allOf": [ + { + "$ref": "#/definitions/AdlsRemoteException" + } + ], + "description": "A WebHDFS exception thrown indicating that access is denied due to insufficient permissions. Thrown when a 403 error response code is returned (forbidden)." + }, + "AdlsRemoteException": { + "discriminator": "exception", + "required": [ + "exception" + ], + "properties": { + "exception": { + "type": "string", + "readOnly": true, + "description": "the class name of the exception thrown, such as 'IllegalArgumentException'." + }, + "javaClassName": { + "type": "string", + "readOnly": true, + "description": "the full class package name for the exception thrown, such as 'java.lang.IllegalArgumentException'." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "the message associated with the exception that was thrown, such as 'Invalid value for webhdfs parameter \"permission\":...'." + } + }, + "description": "Data Lake Store filesystem exception based on the WebHDFS definition for RemoteExceptions. This is a WebHDFS 'catch all' exception" + }, + "AdlsError": { "properties": { - "FileInfo": { - "$ref": "#/definitions/FileInfoProperties", + "RemoteException": { + "$ref": "#/definitions/AdlsRemoteException", "readOnly": true, - "description": "Gets the file information object associated with the specified file path." + "description": "the object representing the actual WebHDFS exception being returned." } }, - "description": "Data Lake Store filesystem file information response used with file expiration." + "description": "Data Lake Store filesystem error containing a specific WebHDFS exception." } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "header", - "required": true, - "type": "string", - "description": "Gets 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", @@ -1460,4 +1628,4 @@ "description": "Gets the URI used as the base for all cloud service requests." } } -} +} \ No newline at end of file