@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api DataLakeAnalyticsAccountManagementClient
@base https://management.azure.com
@version 2016-11-01
@auth OAuth2
@common_fields {subscriptionId: any # Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., api-version: any # Client Api Version.}
@endpoints 31
@hint download_for_search
@toc subscriptions(30), providers(1)

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/accounts
@desc 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.
@optional {$filter: any # OData filter. Optional., $top: any # The number of items to return. Optional., $skip: any # The number of items to skip over before returning elements. Optional., $select: any # OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional., $orderby: any # 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., $count: any # 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.}
@returns(200) Successfully retrieved the list of Azure Data Lake Analytics accounts.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts
@desc 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.
@required {resourceGroupName: any # The name of the Azure resource group.}
@optional {$filter: any # OData filter. Optional., $top: any # The number of items to return. Optional., $skip: any # The number of items to skip over before returning elements. Optional., $select: any # OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional., $orderby: any # 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., $count: any # 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.}
@returns(200) Successfully retrieved the list of accounts in the specified resource group.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}
@desc Creates the specified Data Lake Analytics account. This supplies the user with computation services for Data Lake Analytics workloads.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., parameters: any # Parameters supplied to create a new Data Lake Analytics account.}
@returns(200) Successfully created the specified account.
@returns(201) Successfully initiated creation of the specified account.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}
@desc Gets details of the specified Data Lake Analytics account.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account.}
@returns(200) Successfully retrieved the details of the specified account.

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}
@desc Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account.}
@optional {parameters: any # Parameters supplied to the update Data Lake Analytics account operation.}
@returns(200) Successfully updated the specified account.
@returns(201) Successfully initiated an update of the specified account.
@returns(202) Successfully initiated an update of the specified account.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}
@desc Begins the delete process for the Data Lake Analytics account object specified by the account name.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account.}
@returns(200) Successfully deleted the specified account.
@returns(202) Successfully initiated the deletion of the specified account.
@returns(204) The specified account was not found.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/dataLakeStoreAccounts
@desc 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.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account.}
@optional {$filter: any # OData filter. Optional., $top: any # The number of items to return. Optional., $skip: any # The number of items to skip over before returning elements. Optional., $select: any # OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional., $orderby: any # 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., $count: any # 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.}
@returns(200) Successfully retrieved the list of Data Lake Store accounts.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/dataLakeStoreAccounts/{dataLakeStoreAccountName}
@desc Updates the specified Data Lake Analytics account to include the additional Data Lake Store account.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., dataLakeStoreAccountName: any # The name of the Data Lake Store account to add.}
@optional {parameters: any # The details of the Data Lake Store account.}
@returns(200) Successfully added the specified Azure Data Lake Store account information.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/dataLakeStoreAccounts/{dataLakeStoreAccountName}
@desc Gets the specified Data Lake Store account details in the specified Data Lake Analytics account.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., dataLakeStoreAccountName: any # The name of the Data Lake Store account to retrieve}
@returns(200) Successfully retrieved the specified Azure Data Lake Store account information.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/dataLakeStoreAccounts/{dataLakeStoreAccountName}
@desc Updates the Data Lake Analytics account specified to remove the specified Data Lake Store account.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., dataLakeStoreAccountName: any # The name of the Data Lake Store account to remove}
@returns(200) Successfully removed the specified Azure Data Lake Store account information from the specified Azure Data Lake Analytics account.
@returns(204) The specified datalake storage account does not exist or was already deleted.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/storageAccounts
@desc 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.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account.}
@optional {$filter: any # The OData filter. Optional., $top: any # The number of items to return. Optional., $skip: any # The number of items to skip over before returning elements. Optional., $select: any # OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional., $orderby: any # 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., $count: any # 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.}
@returns(200) Successfully retrieved the list of Azure Storage accounts.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/storageAccounts/{storageAccountName}
@desc Updates the specified Data Lake Analytics account to add an Azure Storage account.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., storageAccountName: any # The name of the Azure Storage account to add, parameters: any # The parameters containing the access key and optional suffix for the Azure Storage Account.}
@returns(200) Successfully added the specified Azure Storage account information to the specified Azure Data Lake Analytics account.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/storageAccounts/{storageAccountName}
@desc Gets the specified Azure Storage account linked to the given Data Lake Analytics account.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., storageAccountName: any # The name of the Azure Storage account for which to retrieve the details.}
@returns(200) Successfully retrieved the specified Azure Storage account information.

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/storageAccounts/{storageAccountName}
@desc Updates the Data Lake Analytics account to replace Azure Storage blob account details, such as the access key and/or suffix.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., storageAccountName: any # The Azure Storage account to modify}
@optional {parameters: any # The parameters containing the access key and suffix to update the storage account with, if any. Passing nothing results in no change.}
@returns(200) Successfully update the specified Azure Storage account information for the specified Azure Data Lake Analytics account.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/storageAccounts/{storageAccountName}
@desc Updates the specified Data Lake Analytics account to remove an Azure Storage account.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., storageAccountName: any # The name of the Azure Storage account to remove}
@returns(200) Successfully deleted the specified Azure Storage account information from the Azure Data Lake Analytics account.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/storageAccounts/{storageAccountName}/containers
@desc 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.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., storageAccountName: any # The name of the Azure storage account from which to list blob containers.}
@returns(200) Successfully retrieved the list of Azure Storage containers under the specified Azure Data Lake Analytics account.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/storageAccounts/{storageAccountName}/containers/{containerName}
@desc Gets the specified Azure Storage container associated with the given Data Lake Analytics and Azure Storage accounts.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., storageAccountName: any # The name of the Azure storage account from which to retrieve the blob container., containerName: any # The name of the Azure storage container to retrieve}
@returns(200) Successfully retrieved the specified Azure Storage container information.

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/storageAccounts/{storageAccountName}/containers/{containerName}/listSasTokens
@desc Gets the SAS token associated with the specified Data Lake Analytics and Azure Storage account and container combination.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., storageAccountName: any # The name of the Azure storage account for which the SAS token is being requested., containerName: any # The name of the Azure storage container for which the SAS token is being requested.}
@returns(200) Successfully retrieved the list of Storage Account SAS tokens for the specified Azure Storage account container.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/computePolicies
@desc Lists the Data Lake Analytics compute policies within the specified Data Lake Analytics account. An account supports, at most, 50 policies
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account.}
@returns(200) Successfully listed the compute policies.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/computePolicies/{computePolicyName}
@desc Creates or updates the specified compute policy. During update, the compute policy with the specified name will be replaced with this new compute policy. An account supports, at most, 50 policies
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., computePolicyName: any # The name of the compute policy to create or update., parameters: any # Parameters supplied to create or update the compute policy. The max degree of parallelism per job property, min priority per job property, or both must be present.}
@returns(200) Successfully created or updated the specified compute policy

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/computePolicies/{computePolicyName}
@desc Gets the specified Data Lake Analytics compute policy.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., computePolicyName: any # The name of the compute policy to retrieve.}
@returns(200) Successfully retrieved the specified compute policy.

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/computePolicies/{computePolicyName}
@desc Updates the specified compute policy.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., computePolicyName: any # The name of the compute policy to update.}
@optional {parameters: any # Parameters supplied to update the compute policy.}
@returns(200) Successfully updated the specified compute policy

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/computePolicies/{computePolicyName}
@desc Deletes the specified compute policy from the specified Data Lake Analytics account
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., computePolicyName: any # The name of the compute policy to delete.}
@returns(200) Successfully deleted the specified compute policy
@returns(204) The specified compute policy does not exist or was already deleted.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/firewallRules
@desc Lists the Data Lake Analytics firewall rules within the specified Data Lake Analytics account.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account.}
@returns(200) Successfully listed the firewall rules.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/firewallRules/{firewallRuleName}
@desc Creates or updates the specified firewall rule. During update, the firewall rule with the specified name will be replaced with this new firewall rule.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., firewallRuleName: any # The name of the firewall rule to create or update., parameters: any # Parameters supplied to create or update the firewall rule.}
@returns(200) Successfully created or updated the specified firewall rule

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/firewallRules/{firewallRuleName}
@desc Gets the specified Data Lake Analytics firewall rule.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., firewallRuleName: any # The name of the firewall rule to retrieve.}
@returns(200) Successfully retrieved the specified firewall rule.

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/firewallRules/{firewallRuleName}
@desc Updates the specified firewall rule.
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., firewallRuleName: any # The name of the firewall rule to update.}
@optional {parameters: any # Parameters supplied to update the firewall rule.}
@returns(200) Successfully updated the specified firewall rule

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/firewallRules/{firewallRuleName}
@desc Deletes the specified firewall rule from the specified Data Lake Analytics account
@required {resourceGroupName: any # The name of the Azure resource group., accountName: any # The name of the Data Lake Analytics account., firewallRuleName: any # The name of the firewall rule to delete.}
@returns(200) Successfully deleted the specified firewall rule
@returns(204) The specified firewall rule does not exist or was already deleted.

@endgroup

@group providers
@endpoint GET /providers/Microsoft.DataLakeAnalytics/operations
@desc Lists all of the available Data Lake Analytics REST API operations.
@returns(200) Successfully listed the available operations for Data Lake Analytics.

@endgroup

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/locations/{location}/capability
@desc Gets subscription-level properties and limits for Data Lake Analytics specified by resource location.
@required {location: any # The resource location without whitespace.}
@returns(200) Successfully retrieved the subscription-level properties and limits for Data Lake Analytics specified by resource location.
@errors {404: Subscription not found.}

@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/locations/{location}/checkNameAvailability
@desc Checks whether the specified account name is available or taken.
@required {location: any # The resource location without whitespace., parameters: any # Parameters supplied to check the Data Lake Analytics account name availability.}
@returns(200) Successfully retrieved the Data Lake Analytics account name availability information.

@endgroup

@end