Accounts - Get

Reference

Service:: Data Lake Analytics

API Version:: 2016-11-01

Gets details of the specified Data Lake Analytics account.

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

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the Data Lake Analytics account.
resourceGroupName	path	True	string	The name of the Azure resource group.
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.

Responses

Name	Type	Description
200 OK	DataLakeAnalyticsAccount	Successfully retrieved the details of the specified account.
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 details of the specified Data Lake Analytics account.

Sample Request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/contosorg/providers/Microsoft.DataLakeAnalytics/accounts/contosoadla?api-version=2016-11-01

/** Samples for Accounts GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Get.json
     */
    /**
     * Sample code: Gets details of the specified Data Lake Analytics account.
     *
     * @param manager Entry point to DataLakeAnalyticsManager.
     */
    public static void getsDetailsOfTheSpecifiedDataLakeAnalyticsAccount(
        com.azure.resourcemanager.datalakeanalytics.DataLakeAnalyticsManager manager) {
        manager.accounts().getByResourceGroupWithResponse("contosorg", "contosoadla", 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

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_Get.json
// this example is just showing the usage of "Accounts_Get" 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 DataLakeAnalyticsAccountResource created on azure
// for more information of creating DataLakeAnalyticsAccountResource, please refer to the document of DataLakeAnalyticsAccountResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "contosorg";
string accountName = "contosoadla";
ResourceIdentifier dataLakeAnalyticsAccountResourceId = DataLakeAnalyticsAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
DataLakeAnalyticsAccountResource dataLakeAnalyticsAccount = client.GetDataLakeAnalyticsAccountResource(dataLakeAnalyticsAccountResourceId);

// invoke the operation
DataLakeAnalyticsAccountResource result = await dataLakeAnalyticsAccount.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataLakeAnalyticsAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgaba12041/providers/Microsoft.DataLakeAnalytics/accounts/testaba15818",
  "name": "test_account",
  "type": "Microsoft.DataLakeAnalytics/accounts",
  "properties": {
    "accountId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    "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",
    "defaultDataLakeStoreAccount": "test_adls",
    "dataLakeStoreAccounts": [
      {
        "id": "test_adls_id",
        "name": "test_adls",
        "type": "test_type",
        "properties": {
          "suffix": "test_suffix"
        }
      }
    ],
    "publicDataLakeStoreAccounts": [
      {
        "id": "test_adls_id",
        "name": "test_adls",
        "type": "test_type",
        "properties": {
          "suffix": "test_suffix"
        }
      }
    ],
    "storageAccounts": [
      {
        "id": "test_storage_id",
        "name": "test_storage",
        "type": "test_type",
        "properties": {
          "suffix": "test_suffix"
        }
      }
    ],
    "computePolicies": [
      {
        "id": "test_policy_id",
        "name": "test_policy",
        "type": "test_type",
        "properties": {
          "objectId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
          "objectType": "User",
          "maxDegreeOfParallelismPerJob": 1,
          "minPriorityPerJob": 1
        }
      }
    ],
    "firewallRules": [
      {
        "id": "test_firewall_id",
        "name": "test_rule",
        "type": "test_type",
        "properties": {
          "startIpAddress": "1.1.1.1",
          "endIpAddress": "2.2.2.2"
        }
      }
    ],
    "firewallState": "Enabled",
    "firewallAllowAzureIps": "Enabled",
    "newTier": "Consumption",
    "currentTier": "Consumption",
    "maxJobCount": 3,
    "systemMaxJobCount": 1,
    "maxDegreeOfParallelism": 30,
    "systemMaxDegreeOfParallelism": 1,
    "maxDegreeOfParallelismPerJob": 1,
    "minPriorityPerJob": 1,
    "queryStoreRetention": 30
  }
}

Definitions

Name	Description
AADObjectType	The type of AAD object the object identifier refers to.
ComputePolicy	Data Lake Analytics compute policy information.
DataLakeAnalyticsAccount	A Data Lake Analytics account object, containing all information associated with the named Data Lake Analytics account.
DataLakeAnalyticsAccountState	The state of the Data Lake Analytics account.
DataLakeAnalyticsAccountStatus	The provisioning status of the Data Lake Analytics account.
DataLakeStoreAccountInformation	Data Lake Store account information.
DebugDataAccessLevel	The current state of the DebugDataAccessLevel for this account.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FirewallAllowAzureIpsState	The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.
FirewallRule	Data Lake Analytics firewall rule information.
FirewallState	The current state of the IP address firewall for this account.
HiveMetastore
NestedResourceProvisioningState	The current state of the NestedResourceProvisioning for this account.
StorageAccountInformation	Azure Storage account information.
TierType	The commitment tier for the next month.
VirtualNetworkRule	Data Lake Analytics VirtualNetwork Rule information.
VirtualNetworkRuleState	The current state of the VirtualNetworkRule for this account.

AADObjectType

The type of AAD object the object identifier refers to.

Name	Type	Description
Group	string
ServicePrincipal	string
User	string

ComputePolicy

Data Lake Analytics compute policy information.

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties.maxDegreeOfParallelismPerJob	integer	The maximum degree of parallelism per job this user can use to submit jobs.
properties.minPriorityPerJob	integer	The minimum priority per job this user can use to submit jobs.
properties.objectId	string	The AAD object identifier for the entity to create a policy for.
properties.objectType	AADObjectType	The type of AAD object the object identifier refers to.
type	string	The resource type.

DataLakeAnalyticsAccount

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

Name	Type	Default Value	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.computePolicies	ComputePolicy[]		The list of compute policies associated with this account.
properties.creationTime	string		The account creation time.
properties.currentTier	TierType		The commitment tier in use for the current month.
properties.dataLakeStoreAccounts	DataLakeStoreAccountInformation[]		The list of Data Lake Store accounts associated with this account.
properties.debugDataAccessLevel	DebugDataAccessLevel		The current state of the DebugDataAccessLevel for this account.
properties.defaultDataLakeStoreAccount	string		The default Data Lake Store account associated with this account.
properties.endpoint	string		The full CName endpoint for this account.
properties.firewallAllowAzureIps	FirewallAllowAzureIpsState		The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.
properties.firewallRules	FirewallRule[]		The list of firewall rules associated with this account.
properties.firewallState	FirewallState		The current state of the IP address firewall for this account.
properties.hiveMetastores	HiveMetastore[]		The list of hiveMetastores associated with this account.
properties.lastModifiedTime	string		The account last modified time.
properties.maxActiveJobCountPerUser	integer		The maximum supported active jobs under the account at the same time.
properties.maxDegreeOfParallelism	integer	30	The maximum supported degree of parallelism for this account.
properties.maxDegreeOfParallelismPerJob	integer		The maximum supported degree of parallelism per job for this account.
properties.maxJobCount	integer	3	The maximum supported jobs running under the account at the same time.
properties.maxJobRunningTimeInMin	integer		The maximum supported active jobs under the account at the same time.
properties.maxQueuedJobCountPerUser	integer		The maximum supported jobs queued under the account at the same time.
properties.minPriorityPerJob	integer		The minimum supported priority per job for this account.
properties.newTier	TierType		The commitment tier for the next month.
properties.provisioningState	DataLakeAnalyticsAccountStatus		The provisioning status of the Data Lake Analytics account.
properties.publicDataLakeStoreAccounts	DataLakeStoreAccountInformation[]		The list of Data Lake Store accounts associated with this account.
properties.queryStoreRetention	integer	30	The number of days that job metadata is retained.
properties.state	DataLakeAnalyticsAccountState		The state of the Data Lake Analytics account.
properties.storageAccounts	StorageAccountInformation[]		The list of Azure Blob Storage accounts associated with this account.
properties.systemMaxDegreeOfParallelism	integer		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.
properties.systemMaxJobCount	integer		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.
properties.virtualNetworkRules	VirtualNetworkRule[]		The list of virtualNetwork rules associated with this account.
tags	object		The resource tags.
type	string		The resource type.

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

DataLakeStoreAccountInformation

Data Lake Store account information.

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties.suffix	string	The optional suffix for the Data Lake Store account.
type	string	The resource type.

DebugDataAccessLevel

The current state of the DebugDataAccessLevel for this account.

Name	Type	Description
All	string
Customer	string
None	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.

FirewallAllowAzureIpsState

The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.

Name	Type	Description
Disabled	string
Enabled	string

FirewallRule

Data Lake Analytics firewall rule information.

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties.endIpAddress	string	The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.
properties.startIpAddress	string	The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.
type	string	The resource type.

FirewallState

The current state of the IP address firewall for this account.

Name	Type	Description
Disabled	string
Enabled	string

HiveMetastore

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties.databaseName	string	The databaseName for the Hive MetaStore
properties.nestedResourceProvisioningState	NestedResourceProvisioningState	The current state of the NestedResource
properties.password	string	The password for the Hive MetaStore
properties.runtimeVersion	string	The runtimeVersion for the Hive MetaStore
properties.serverUri	string	The serverUri for the Hive MetaStore
properties.userName	string	The userName for the Hive MetaStore
type	string	The resource type.

NestedResourceProvisioningState

The current state of the NestedResourceProvisioning for this account.

Name	Type	Description
Canceled	string
Failed	string
Succeeded	string

StorageAccountInformation

Azure Storage account information.

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties.suffix	string	The optional suffix for the storage account.
type	string	The resource type.

TierType

The commitment tier for the next month.

Name	Type	Description
Commitment_100000AUHours	string
Commitment_10000AUHours	string
Commitment_1000AUHours	string
Commitment_100AUHours	string
Commitment_500000AUHours	string
Commitment_50000AUHours	string
Commitment_5000AUHours	string
Commitment_500AUHours	string
Consumption	string

VirtualNetworkRule

Data Lake Analytics VirtualNetwork Rule information.

Name	Type	Description
id	string	The resource identifier.
name	string	The resource name.
properties.subnetId	string	The resource identifier for the subnet
properties.virtualNetworkRuleState	VirtualNetworkRuleState	The current state of the VirtualNetwork Rule
type	string	The resource type.

VirtualNetworkRuleState

The current state of the VirtualNetworkRule for this account.

Name	Type	Description
Active	string
Failed	string
NetworkSourceDeleted	string

Accounts - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Gets details of the specified Data Lake Analytics account.

Sample Request

Sample Response

Definitions

AADObjectType

ComputePolicy

DataLakeAnalyticsAccount

DataLakeAnalyticsAccountState

DataLakeAnalyticsAccountStatus

DataLakeStoreAccountInformation

DebugDataAccessLevel

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FirewallAllowAzureIpsState

FirewallRule

FirewallState

HiveMetastore

NestedResourceProvisioningState

StorageAccountInformation

TierType

VirtualNetworkRule

VirtualNetworkRuleState

Additional resources