Accounts - List

Reference

Service:: Data Lake Storage Gen1

API Version:: 2016-11-01

Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DataLakeStore/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	Gets 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	DataLakeStoreAccountListResult	Successfully retrieved the list of accounts.

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

Lists the Data Lake Store accounts within the subscription

Sample Request

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

/** Samples for Accounts List. */
public final class Main {
    /*
     * x-ms-original-file: specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_List.json
     */
    /**
     * Sample code: Lists the Data Lake Store accounts within the subscription.
     *
     * @param manager Entry point to DataLakeStoreManager.
     */
    public static void listsTheDataLakeStoreAccountsWithinTheSubscription(
        com.azure.resourcemanager.datalakestore.DataLakeStoreManager manager) {
        manager
            .accounts()
            .list("test_filter", 1, 1, "test_select", "test_orderby", false, com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.datalake.store import DataLakeStoreAccountManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datalake-store
# USAGE
    python accounts_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataLakeStoreAccountManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.accounts.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_List.json
if __name__ == "__main__":
    main()

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

package armdatalakestore_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datalake-store/armdatalakestore"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_List.json
func ExampleAccountsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatalakestore.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAccountsClient().NewListPager(&armdatalakestore.AccountsClientListOptions{Filter: to.Ptr("test_filter"),
		Top:     to.Ptr[int32](1),
		Skip:    to.Ptr[int32](1),
		Select:  to.Ptr("test_select"),
		Orderby: to.Ptr("test_orderby"),
		Count:   to.Ptr(false),
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AccountListResult = armdatalakestore.AccountListResult{
		// 	Value: []*armdatalakestore.AccountBasic{
		// 		{
		// 			Name: to.Ptr("contosoadla"),
		// 			Type: to.Ptr("test_type"),
		// 			ID: to.Ptr("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345"),
		// 			Location: to.Ptr("eastus2"),
		// 			Tags: map[string]*string{
		// 				"test_key": to.Ptr("test_value"),
		// 			},
		// 			Properties: &armdatalakestore.AccountPropertiesBasic{
		// 				AccountID: to.Ptr("94f4bf5d-78a9-4c31-8aa7-b34d07bad898"),
		// 				CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-14T20:21:56.681Z"); return t}()),
		// 				Endpoint: to.Ptr("testadlfs17607.azuredatalakestore.net"),
		// 				LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-04-14T20:21:56.681Z"); return t}()),
		// 				ProvisioningState: to.Ptr(armdatalakestore.DataLakeStoreAccountStatusSucceeded),
		// 				State: to.Ptr(armdatalakestore.DataLakeStoreAccountStateActive),
		// 			},
		// 	}},
		// }
	}
}

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": "contosoadla",
      "type": "test_type",
      "location": "eastus2",
      "tags": {
        "test_key": "test_value"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "state": "Active",
        "creationTime": "2017-04-14T13:21:56.6819037-07:00",
        "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00",
        "endpoint": "testadlfs17607.azuredatalakestore.net",
        "accountId": "94f4bf5d-78a9-4c31-8aa7-b34d07bad898"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosorg/providers/Microsoft.DataLakeStore/accounts/contosoadla/jobPolicies?api-version=2016-11-01&%24skiptoken=<token>"
}

Definitions

Name	Description
DataLakeStoreAccountBasic	Basic Data Lake Store account information, returned on list calls.
DataLakeStoreAccountListResult	Data Lake Store account list information response.
DataLakeStoreAccountState	The state of the Data Lake Store account.
DataLakeStoreAccountStatus	The provisioning status of the Data Lake Store account.

DataLakeStoreAccountBasic

Basic Data Lake Store account information, returned on list calls.

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 Store 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	DataLakeStoreAccountStatus	The provisioning status of the Data Lake Store account.
properties.state	DataLakeStoreAccountState	The state of the Data Lake Store account.
tags	object	The resource tags.
type	string	The resource type.

DataLakeStoreAccountListResult

Data Lake Store account list information response.

Name	Type	Description
nextLink	string	The link (url) to the next page of results.
value	DataLakeStoreAccountBasic[]	The results of the list operation.

DataLakeStoreAccountState

The state of the Data Lake Store account.

Name	Type	Description
Active	string
Suspended	string

DataLakeStoreAccountStatus

The provisioning status of the Data Lake Store 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

Accounts - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Lists the Data Lake Store accounts within the subscription

Sample Request

Sample Response

Definitions

DataLakeStoreAccountBasic

DataLakeStoreAccountListResult

DataLakeStoreAccountState

DataLakeStoreAccountStatus

Additional resources