azure.mgmt.datalake.store.models module

class azure.mgmt.datalake.store.models.UpdateFirewallRuleParameters(start_ip_address=None, end_ip_address=None)[source]

Bases: msrest.serialization.Model

Data Lake Analytics firewall rule update parameters.

Parameters:
  • start_ip_address (str) – the start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.
  • end_ip_address (str) – the end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.
class azure.mgmt.datalake.store.models.FirewallRule(start_ip_address, end_ip_address, name=None)[source]

Bases: azure.mgmt.datalake.store.models.sub_resource.SubResource

Data Lake Store firewall rule information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • name (str) – Resource name
  • start_ip_address (str) – the start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.
  • end_ip_address (str) – the end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol.
class azure.mgmt.datalake.store.models.UpdateTrustedIdProviderParameters(id_provider=None)[source]

Bases: msrest.serialization.Model

Data Lake Store Trusted Identity Provider update parameters.

Parameters:id_provider (str) – The URL of this trusted identity provider
class azure.mgmt.datalake.store.models.TrustedIdProvider(id_provider, name=None)[source]

Bases: azure.mgmt.datalake.store.models.sub_resource.SubResource

Data Lake Store Trusted Identity Provider information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • name (str) – Resource name
  • id_provider (str) – The URL of this trusted identity provider
class azure.mgmt.datalake.store.models.EncryptionIdentity[source]

Bases: msrest.serialization.Model

The encryption identity properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • type (str) – The type of encryption being used. Currently the only supported type is ‘SystemAssigned’. Default value: “SystemAssigned” .
  • principal_id (str) – The principal identifier associated with the encryption.
  • tenant_id (str) – The tenant identifier associated with the encryption.
type = 'SystemAssigned'
class azure.mgmt.datalake.store.models.KeyVaultMetaInfo(key_vault_resource_id, encryption_key_name, encryption_key_version)[source]

Bases: msrest.serialization.Model

Metadata information used by account encryption.

Parameters:
  • key_vault_resource_id (str) – The resource identifier for the user managed Key Vault being used to encrypt.
  • encryption_key_name (str) – The name of the user managed encryption key.
  • encryption_key_version (str) – The version of the user managed encryption key.
class azure.mgmt.datalake.store.models.EncryptionConfig(type, key_vault_meta_info=None)[source]

Bases: msrest.serialization.Model

The encryption configuration for the account.

Parameters:
  • type (str or EncryptionConfigType) – The type of encryption configuration being used. Currently the only supported types are ‘UserManaged’ and ‘ServiceManaged’. Possible values include: ‘UserManaged’, ‘ServiceManaged’
  • key_vault_meta_info (KeyVaultMetaInfo) – The Key Vault information for connecting to user managed encryption keys.
class azure.mgmt.datalake.store.models.UpdateKeyVaultMetaInfo(encryption_key_version=None)[source]

Bases: msrest.serialization.Model

The Key Vault update information used for user managed key rotation.

Parameters:encryption_key_version (str) – The version of the user managed encryption key to update through a key rotation.
class azure.mgmt.datalake.store.models.UpdateEncryptionConfig(key_vault_meta_info=None)[source]

Bases: msrest.serialization.Model

The encryption configuration used to update a user managed Key Vault key.

Parameters:key_vault_meta_info (UpdateKeyVaultMetaInfo) – The updated Key Vault key to use in user managed key rotation.
class azure.mgmt.datalake.store.models.DataLakeStoreAccountUpdateParameters(tags=None, firewall_state=None, trusted_id_provider_state=None, default_group=None, new_tier=None, firewall_allow_azure_ips=None, encryption_config=None)[source]

Bases: msrest.serialization.Model

Data Lake Store account information to update.

Parameters:
  • tags (dict) – Resource tags
  • firewall_state (str or FirewallState) – 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. Possible values include: ‘Enabled’, ‘Disabled’
  • trusted_id_provider_state (str or TrustedIdProviderState) – 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. Possible values include: ‘Enabled’, ‘Disabled’
  • default_group (str) – the default owner group for all new folders and files created in the Data Lake Store account.
  • new_tier (str or TierType) – the commitment tier to use for next month. Possible values include: ‘Consumption’, ‘Commitment_1TB’, ‘Commitment_10TB’, ‘Commitment_100TB’, ‘Commitment_500TB’, ‘Commitment_1PB’, ‘Commitment_5PB’
  • firewall_allow_azure_ips (str or FirewallAllowAzureIpsState) – The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. Possible values include: ‘Enabled’, ‘Disabled’
  • encryption_config (UpdateEncryptionConfig) – Used for rotation of user managed Key Vault keys. Can only be used to rotate a user managed encryption Key Vault key.
class azure.mgmt.datalake.store.models.DataLakeStoreAccount(location, tags=None, identity=None, encryption_state=None, encryption_config=None, firewall_state=None, firewall_rules=None, trusted_id_provider_state=None, trusted_id_providers=None, default_group=None, new_tier=None, firewall_allow_azure_ips=None)[source]

Bases: azure.mgmt.datalake.store.models.resource.Resource

Data Lake Store account information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • provisioning_state (str or DataLakeStoreAccountStatus) – the provisioning status of the Data Lake Store account. Possible values include: ‘Failed’, ‘Creating’, ‘Running’, ‘Succeeded’, ‘Patching’, ‘Suspending’, ‘Resuming’, ‘Deleting’, ‘Deleted’
  • state (str or DataLakeStoreAccountState) – the state of the Data Lake Store account. Possible values include: ‘Active’, ‘Suspended’
  • creation_time (datetime) – the account creation time.
  • last_modified_time (datetime) – the account last modified time.
  • endpoint (str) – the full CName endpoint for this account.
  • account_id (str) – The unique identifier associated with this Data Lake Store account.
  • encryption_provisioning_state (str or EncryptionProvisioningState) – The current state of encryption provisioning for this Data Lake store account. Possible values include: ‘Creating’, ‘Succeeded’
  • current_tier (str or TierType) – the commitment tier in use for the current month. Possible values include: ‘Consumption’, ‘Commitment_1TB’, ‘Commitment_10TB’, ‘Commitment_100TB’, ‘Commitment_500TB’, ‘Commitment_1PB’, ‘Commitment_5PB’
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
  • identity (EncryptionIdentity) – The Key Vault encryption identity, if any.
  • encryption_state (str or EncryptionState) – The current state of encryption for this Data Lake store account. Possible values include: ‘Enabled’, ‘Disabled’
  • encryption_config (EncryptionConfig) – The Key Vault encryption configuration.
  • firewall_state (str or FirewallState) – The current state of the IP address firewall for this Data Lake store account. Possible values include: ‘Enabled’, ‘Disabled’
  • firewall_rules (list of FirewallRule) – The list of firewall rules associated with this Data Lake store account.
  • trusted_id_provider_state (str or TrustedIdProviderState) – The current state of the trusted identity provider feature for this Data Lake store account. Possible values include: ‘Enabled’, ‘Disabled’
  • trusted_id_providers (list of TrustedIdProvider) – The list of trusted identity providers associated with this Data Lake store account.
  • default_group (str) – the default owner group for all new folders and files created in the Data Lake Store account.
  • new_tier (str or TierType) – the commitment tier to use for next month. Possible values include: ‘Consumption’, ‘Commitment_1TB’, ‘Commitment_10TB’, ‘Commitment_100TB’, ‘Commitment_500TB’, ‘Commitment_1PB’, ‘Commitment_5PB’
  • firewall_allow_azure_ips (str or FirewallAllowAzureIpsState) – The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced. Possible values include: ‘Enabled’, ‘Disabled’
class azure.mgmt.datalake.store.models.DataLakeStoreAccountBasic(location, tags=None)[source]

Bases: azure.mgmt.datalake.store.models.resource.Resource

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – Resource Id
  • name (str) – Resource name
  • type (str) – Resource type
  • provisioning_state (str or DataLakeStoreAccountStatus) – the provisioning status of the Data Lake Store account. Possible values include: ‘Failed’, ‘Creating’, ‘Running’, ‘Succeeded’, ‘Patching’, ‘Suspending’, ‘Resuming’, ‘Deleting’, ‘Deleted’
  • state (str or DataLakeStoreAccountState) – the state of the Data Lake Store account. Possible values include: ‘Active’, ‘Suspended’
  • creation_time (datetime) – the account creation time.
  • last_modified_time (datetime) – the account last modified time.
  • endpoint (str) – the full CName endpoint for this account.
  • account_id (str) – The unique identifier associated with this Data Lake Store account.
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
class azure.mgmt.datalake.store.models.ErrorDetails[source]

Bases: msrest.serialization.Model

Data Lake Store error details information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • code (str) – the HTTP status code or error code associated with this error
  • message (str) – the error message localized based on Accept-Language
  • target (str) – the target of the particular error (for example, the name of the property in error).
class azure.mgmt.datalake.store.models.Resource(location, tags=None)[source]

Bases: msrest.serialization.Model

The Resource model definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:
  • location (str) – Resource location
  • tags (dict) – Resource tags
class azure.mgmt.datalake.store.models.SubResource(name=None)[source]

Bases: msrest.serialization.Model

The Resource model definition for a nested resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Parameters:

name (str) – Resource name

class azure.mgmt.datalake.store.models.FirewallRulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of FirewallRule object

class azure.mgmt.datalake.store.models.TrustedIdProviderPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of TrustedIdProvider object

class azure.mgmt.datalake.store.models.DataLakeStoreAccountBasicPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of DataLakeStoreAccountBasic object

class azure.mgmt.datalake.store.models.EncryptionConfigType[source]

Bases: enum.Enum

service_managed = 'ServiceManaged'
user_managed = 'UserManaged'
class azure.mgmt.datalake.store.models.EncryptionState[source]

Bases: enum.Enum

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.datalake.store.models.EncryptionProvisioningState[source]

Bases: enum.Enum

creating = 'Creating'
succeeded = 'Succeeded'
class azure.mgmt.datalake.store.models.FirewallState[source]

Bases: enum.Enum

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.datalake.store.models.TrustedIdProviderState[source]

Bases: enum.Enum

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.datalake.store.models.TierType[source]

Bases: enum.Enum

commitment_100_tb = 'Commitment_100TB'
commitment_10_tb = 'Commitment_10TB'
commitment_1_pb = 'Commitment_1PB'
commitment_1_tb = 'Commitment_1TB'
commitment_500_tb = 'Commitment_500TB'
commitment_5_pb = 'Commitment_5PB'
consumption = 'Consumption'
class azure.mgmt.datalake.store.models.FirewallAllowAzureIpsState[source]

Bases: enum.Enum

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.datalake.store.models.DataLakeStoreAccountStatus[source]

Bases: enum.Enum

creating = 'Creating'
deleted = 'Deleted'
deleting = 'Deleting'
failed = 'Failed'
patching = 'Patching'
resuming = 'Resuming'
running = 'Running'
succeeded = 'Succeeded'
suspending = 'Suspending'
class azure.mgmt.datalake.store.models.DataLakeStoreAccountState[source]

Bases: enum.Enum

active = 'Active'
suspended = 'Suspended'