Accounts - List

Service:

Data Lake Analytics

API Version:

2016-11-01

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.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/accounts?api-version=2016-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DataLakeAnalytics/accounts?$filter={$filter}&$top={$top}&$skip={$skip}&$select={$select}&$orderby={$orderby}&$count={$count}&api-version=2016-11-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Get subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.
$count	query		boolean	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.
$filter	query		string	OData filter. Optional.
$orderby	query		string	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.
$select	query		string	OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
$skip	query		integer int32	The number of items to skip over before returning elements. Optional.
$top	query		integer int32	The number of items to return. Optional.

Responses

Name	Type	Description
200 OK	DataLakeAnalyticsAccountListResult	Successfully retrieved the list of Azure Data Lake Analytics accounts.
Other Status Codes	ErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

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.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DataLakeAnalytics/accounts?$filter=test_filter&$top=1&$skip=1&$select=test_select&$orderby=test_orderby&$count=False&api-version=2016-11-01

dotnet

using System;
using System.Net;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataLakeAnalytics;
using Azure.ResourceManager.DataLakeAnalytics.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_List.json
// this example is just showing the usage of "Accounts_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
SubscriptionResourceGetAccountsOptions options = new SubscriptionResourceGetAccountsOptions() { Filter = "test_filter", Top = 1, Skip = 1, Select = "test_select", Orderby = "test_orderby", Count = false };
await foreach (DataLakeAnalyticsAccountBasic item in subscriptionResource.GetAccountsAsync(options))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
      "name": "test_account",
      "type": "test_type",
      "properties": {
        "provisioningState": "Succeeded",
        "state": "Active",
        "creationTime": "2017-04-14T13:21:56.6819037-07:00",
        "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00",
        "endpoint": "test_endpoint",
        "accountId": "94f4bf5d-78a9-4c31-8aa7-b34d07bad898"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosorg/providers/Microsoft.DataLakeAnalytics/accounts/contosoadla/jobPolicies?api-version=2016-11-01&%24skiptoken=<token>"
}

Definitions

Name	Description
DataLakeAnalyticsAccountBasic	A Data Lake Analytics account object, containing all information associated with the named Data Lake Analytics account.
DataLakeAnalyticsAccountListResult	Data Lake Analytics account list information.
DataLakeAnalyticsAccountState	The state of the Data Lake Analytics account.
DataLakeAnalyticsAccountStatus	The provisioning status of the Data Lake Analytics account.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

DataLakeAnalyticsAccountBasic

A Data Lake Analytics account object, containing all information associated with the named Data Lake Analytics account.

Name	Type	Description
id	string	The resource identifier.
location	string	The resource location.
name	string	The resource name.
properties.accountId	string	The unique identifier associated with this Data Lake Analytics account.
properties.creationTime	string	The account creation time.
properties.endpoint	string	The full CName endpoint for this account.
properties.lastModifiedTime	string	The account last modified time.
properties.provisioningState	DataLakeAnalyticsAccountStatus	The provisioning status of the Data Lake Analytics account.
properties.state	DataLakeAnalyticsAccountState	The state of the Data Lake Analytics account.
tags	object	The resource tags.
type	string	The resource type.

DataLakeAnalyticsAccountListResult

Data Lake Analytics account list information.

Name	Type	Description
count	integer	The current number of data lake analytics accounts under this subscription.
nextLink	string	The link (url) to the next page of results.
value	DataLakeAnalyticsAccountBasic[]	The results of the list operation.

DataLakeAnalyticsAccountState

The state of the Data Lake Analytics account.

Name	Type	Description
Active	string
Suspended	string

DataLakeAnalyticsAccountStatus

The provisioning status of the Data Lake Analytics account.

Name	Type	Description
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
Patching	string
Resuming	string
Running	string
Succeeded	string
Suspending	string
Undeleting	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.