azure.mgmt.datalake.store.models module¶
-
class
azure.mgmt.datalake.store.models.
CapabilityInformation
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
Subscription-level properties and limits for Data Lake Store.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
subscription_id (str) – The subscription credentials that uniquely identifies the subscription.
state (str or SubscriptionState) – The subscription state. Known values are: “Registered”, “Suspended”, “Deleted”, “Unregistered”, and “Warned”.
max_account_count (int) – The maximum supported number of accounts under this subscription.
account_count (int) – The current number of accounts under this subscription.
migration_state (bool) – The Boolean value of true or false to indicate the maintenance state.
-
class
azure.mgmt.datalake.store.models.
CheckNameAvailabilityParameters
(*, name: str, type: Union[str, _models.CheckNameAvailabilityParametersType], **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
Data Lake Store account name availability check parameters.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – The Data Lake Store name to check availability for. Required.
type (str or CheckNameAvailabilityParametersType) – The resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeStore/accounts. Required. “Microsoft.DataLakeStore/accounts”
- Keyword Arguments
name (str) – The Data Lake Store name to check availability for. Required.
type (str or CheckNameAvailabilityParametersType) – The resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeStore/accounts. Required. “Microsoft.DataLakeStore/accounts”
-
class
azure.mgmt.datalake.store.models.
CheckNameAvailabilityParametersType
(value)[source]¶ -
The resource type. Note: This should not be set by the user, as the constant value is Microsoft.DataLakeStore/accounts.
-
MICROSOFT_DATA_LAKE_STORE_ACCOUNTS
= 'Microsoft.DataLakeStore/accounts'¶
-
-
class
azure.mgmt.datalake.store.models.
CreateDataLakeStoreAccountParameters
(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.EncryptionIdentity] = None, default_group: Optional[str] = None, encryption_config: Optional[_models.EncryptionConfig] = None, encryption_state: Optional[Union[str, _models.EncryptionState]] = None, firewall_rules: Optional[List[_models.CreateFirewallRuleWithAccountParameters]] = None, virtual_network_rules: Optional[List[_models.CreateVirtualNetworkRuleWithAccountParameters]] = None, firewall_state: Optional[Union[str, _models.FirewallState]] = None, firewall_allow_azure_ips: Optional[Union[str, _models.FirewallAllowAzureIpsState]] = None, trusted_id_providers: Optional[List[_models.CreateTrustedIdProviderWithAccountParameters]] = None, trusted_id_provider_state: Optional[Union[str, _models.TrustedIdProviderState]] = None, new_tier: Optional[Union[str, _models.TierType]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
CreateDataLakeStoreAccountParameters.
All required parameters must be populated in order to send to Azure.
- Variables
location (str) – The resource location. Required.
identity (EncryptionIdentity) – The Key Vault encryption identity, if any.
default_group (str) – The default owner group for all new folders and files created in the Data Lake Store account.
encryption_config (EncryptionConfig) – The Key Vault encryption configuration.
encryption_state (str or EncryptionState) – The current state of encryption for this Data Lake Store account. Known values are: “Enabled” and “Disabled”.
firewall_rules (list[CreateFirewallRuleWithAccountParameters]) – The list of firewall rules associated with this Data Lake Store account.
virtual_network_rules (list[CreateVirtualNetworkRuleWithAccountParameters]) – The list of virtual network rules associated with this Data Lake Store account.
firewall_state (str or FirewallState) – The current state of the IP address firewall for this Data Lake Store account. Known values are: “Enabled” and “Disabled”.
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. Known values are: “Enabled” and “Disabled”.
trusted_id_providers (list[CreateTrustedIdProviderWithAccountParameters]) – The list of trusted identity providers 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. Known values are: “Enabled” and “Disabled”.
new_tier (str or TierType) – The commitment tier to use for next month. Known values are: “Consumption”, “Commitment_1TB”, “Commitment_10TB”, “Commitment_100TB”, “Commitment_500TB”, “Commitment_1PB”, and “Commitment_5PB”.
- Keyword Arguments
location (str) – The resource location. Required.
identity (EncryptionIdentity) – The Key Vault encryption identity, if any.
default_group (str) – The default owner group for all new folders and files created in the Data Lake Store account.
encryption_config (EncryptionConfig) – The Key Vault encryption configuration.
encryption_state (str or EncryptionState) – The current state of encryption for this Data Lake Store account. Known values are: “Enabled” and “Disabled”.
firewall_rules (list[CreateFirewallRuleWithAccountParameters]) – The list of firewall rules associated with this Data Lake Store account.
virtual_network_rules (list[CreateVirtualNetworkRuleWithAccountParameters]) – The list of virtual network rules associated with this Data Lake Store account.
firewall_state (str or FirewallState) – The current state of the IP address firewall for this Data Lake Store account. Known values are: “Enabled” and “Disabled”.
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. Known values are: “Enabled” and “Disabled”.
trusted_id_providers (list[CreateTrustedIdProviderWithAccountParameters]) – The list of trusted identity providers 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. Known values are: “Enabled” and “Disabled”.
new_tier (str or TierType) – The commitment tier to use for next month. Known values are: “Consumption”, “Commitment_1TB”, “Commitment_10TB”, “Commitment_100TB”, “Commitment_500TB”, “Commitment_1PB”, and “Commitment_5PB”.
-
class
azure.mgmt.datalake.store.models.
CreateFirewallRuleWithAccountParameters
(*, name: str, start_ip_address: str, end_ip_address: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to create a new firewall rule while creating a new Data Lake Store account.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – The unique name of the firewall rule to create. Required.
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. Required.
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. Required.
- Keyword Arguments
name (str) – The unique name of the firewall rule to create. Required.
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. Required.
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. Required.
-
class
azure.mgmt.datalake.store.models.
CreateOrUpdateFirewallRuleParameters
(*, start_ip_address: str, end_ip_address: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to create a new firewall rule.
All required parameters must be populated in order to send to Azure.
- Variables
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. Required.
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. Required.
- Keyword Arguments
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. Required.
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. Required.
-
class
azure.mgmt.datalake.store.models.
CreateOrUpdateTrustedIdProviderParameters
(*, id_provider: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to create a new trusted identity provider.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.datalake.store.models.
CreateOrUpdateVirtualNetworkRuleParameters
(*, subnet_id: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to create a new virtual network rule.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.datalake.store.models.
CreateTrustedIdProviderWithAccountParameters
(*, name: str, id_provider: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to create a new trusted identity provider while creating a new Data Lake Store account.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.datalake.store.models.
CreateVirtualNetworkRuleWithAccountParameters
(*, name: str, subnet_id: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to create a new virtual network rule while creating a new Data Lake Store account.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.datalake.store.models.
DataLakeStoreAccount
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store.models._models_py3.Resource
Data Lake Store account information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – The resource name.
location (str) – The resource location.
identity (EncryptionIdentity) – The Key Vault encryption identity, if any.
account_id (str) – The unique identifier associated with this Data Lake Store account.
provisioning_state (str or DataLakeStoreAccountStatus) – The provisioning status of the Data Lake Store account. Known values are: “Failed”, “Creating”, “Running”, “Succeeded”, “Patching”, “Suspending”, “Resuming”, “Deleting”, “Deleted”, “Undeleting”, and “Canceled”.
state (str or DataLakeStoreAccountState) – The state of the Data Lake Store account. Known values are: “Active” and “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.
default_group (str) – The default owner group for all new folders and files created in the Data Lake Store account.
encryption_config (EncryptionConfig) – The Key Vault encryption configuration.
encryption_state (str or EncryptionState) – The current state of encryption for this Data Lake Store account. Known values are: “Enabled” and “Disabled”.
encryption_provisioning_state (str or EncryptionProvisioningState) – The current state of encryption provisioning for this Data Lake Store account. Known values are: “Creating” and “Succeeded”.
firewall_rules (list[FirewallRule]) – The list of firewall rules associated with this Data Lake Store account.
virtual_network_rules (list[VirtualNetworkRule]) – The list of virtual network rules associated with this Data Lake Store account.
firewall_state (str or FirewallState) – The current state of the IP address firewall for this Data Lake Store account. Known values are: “Enabled” and “Disabled”.
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. Known values are: “Enabled” and “Disabled”.
trusted_id_providers (list[TrustedIdProvider]) – The list of trusted identity providers 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. Known values are: “Enabled” and “Disabled”.
new_tier (str or TierType) – The commitment tier to use for next month. Known values are: “Consumption”, “Commitment_1TB”, “Commitment_10TB”, “Commitment_100TB”, “Commitment_500TB”, “Commitment_1PB”, and “Commitment_5PB”.
current_tier (str or TierType) – The commitment tier in use for the current month. Known values are: “Consumption”, “Commitment_1TB”, “Commitment_10TB”, “Commitment_100TB”, “Commitment_500TB”, “Commitment_1PB”, and “Commitment_5PB”.
-
class
azure.mgmt.datalake.store.models.
DataLakeStoreAccountBasic
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store.models._models_py3.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
name (str) – The resource name.
location (str) – The resource location.
account_id (str) – The unique identifier associated with this Data Lake Store account.
provisioning_state (str or DataLakeStoreAccountStatus) – The provisioning status of the Data Lake Store account. Known values are: “Failed”, “Creating”, “Running”, “Succeeded”, “Patching”, “Suspending”, “Resuming”, “Deleting”, “Deleted”, “Undeleting”, and “Canceled”.
state (str or DataLakeStoreAccountState) – The state of the Data Lake Store account. Known values are: “Active” and “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.
-
class
azure.mgmt.datalake.store.models.
DataLakeStoreAccountListResult
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
Data Lake Store account list information response.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
value (list[DataLakeStoreAccountBasic]) – The results of the list operation.
next_link (str) – The link (url) to the next page of results.
-
class
azure.mgmt.datalake.store.models.
DataLakeStoreAccountProperties
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store.models._models_py3.DataLakeStoreAccountPropertiesBasic
Data Lake Store account properties information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
account_id (str) – The unique identifier associated with this Data Lake Store account.
provisioning_state (str or DataLakeStoreAccountStatus) – The provisioning status of the Data Lake Store account. Known values are: “Failed”, “Creating”, “Running”, “Succeeded”, “Patching”, “Suspending”, “Resuming”, “Deleting”, “Deleted”, “Undeleting”, and “Canceled”.
state (str or DataLakeStoreAccountState) – The state of the Data Lake Store account. Known values are: “Active” and “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.
default_group (str) – The default owner group for all new folders and files created in the Data Lake Store account.
encryption_config (EncryptionConfig) – The Key Vault encryption configuration.
encryption_state (str or EncryptionState) – The current state of encryption for this Data Lake Store account. Known values are: “Enabled” and “Disabled”.
encryption_provisioning_state (str or EncryptionProvisioningState) – The current state of encryption provisioning for this Data Lake Store account. Known values are: “Creating” and “Succeeded”.
firewall_rules (list[FirewallRule]) – The list of firewall rules associated with this Data Lake Store account.
virtual_network_rules (list[VirtualNetworkRule]) – The list of virtual network rules associated with this Data Lake Store account.
firewall_state (str or FirewallState) – The current state of the IP address firewall for this Data Lake Store account. Known values are: “Enabled” and “Disabled”.
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. Known values are: “Enabled” and “Disabled”.
trusted_id_providers (list[TrustedIdProvider]) – The list of trusted identity providers 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. Known values are: “Enabled” and “Disabled”.
new_tier (str or TierType) – The commitment tier to use for next month. Known values are: “Consumption”, “Commitment_1TB”, “Commitment_10TB”, “Commitment_100TB”, “Commitment_500TB”, “Commitment_1PB”, and “Commitment_5PB”.
current_tier (str or TierType) – The commitment tier in use for the current month. Known values are: “Consumption”, “Commitment_1TB”, “Commitment_10TB”, “Commitment_100TB”, “Commitment_500TB”, “Commitment_1PB”, and “Commitment_5PB”.
-
class
azure.mgmt.datalake.store.models.
DataLakeStoreAccountPropertiesBasic
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The basic account specific properties that are associated with an underlying Data Lake Store account.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
account_id (str) – The unique identifier associated with this Data Lake Store account.
provisioning_state (str or DataLakeStoreAccountStatus) – The provisioning status of the Data Lake Store account. Known values are: “Failed”, “Creating”, “Running”, “Succeeded”, “Patching”, “Suspending”, “Resuming”, “Deleting”, “Deleted”, “Undeleting”, and “Canceled”.
state (str or DataLakeStoreAccountState) – The state of the Data Lake Store account. Known values are: “Active” and “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.
-
class
azure.mgmt.datalake.store.models.
DataLakeStoreAccountState
(value)[source]¶ -
The state of the Data Lake Store account.
-
ACTIVE
= 'Active'¶
-
SUSPENDED
= 'Suspended'¶
-
-
class
azure.mgmt.datalake.store.models.
DataLakeStoreAccountStatus
(value)[source]¶ -
The provisioning status of the Data Lake Store account.
-
CANCELED
= 'Canceled'¶
-
CREATING
= 'Creating'¶
-
DELETED
= 'Deleted'¶
-
DELETING
= 'Deleting'¶
-
FAILED
= 'Failed'¶
-
PATCHING
= 'Patching'¶
-
RESUMING
= 'Resuming'¶
-
RUNNING
= 'Running'¶
-
SUCCEEDED
= 'Succeeded'¶
-
SUSPENDING
= 'Suspending'¶
-
UNDELETING
= 'Undeleting'¶
-
-
class
azure.mgmt.datalake.store.models.
EncryptionConfig
(*, type: Union[str, _models.EncryptionConfigType], key_vault_meta_info: Optional[_models.KeyVaultMetaInfo] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The encryption configuration for the account.
All required parameters must be populated in order to send to Azure.
- Variables
type (str or EncryptionConfigType) – The type of encryption configuration being used. Currently the only supported types are ‘UserManaged’ and ‘ServiceManaged’. Required. Known values are: “UserManaged” and “ServiceManaged”.
key_vault_meta_info (KeyVaultMetaInfo) – The Key Vault information for connecting to user managed encryption keys.
- Keyword Arguments
type (str or EncryptionConfigType) – The type of encryption configuration being used. Currently the only supported types are ‘UserManaged’ and ‘ServiceManaged’. Required. Known values are: “UserManaged” and “ServiceManaged”.
key_vault_meta_info (KeyVaultMetaInfo) – The Key Vault information for connecting to user managed encryption keys.
-
class
azure.mgmt.datalake.store.models.
EncryptionConfigType
(value)[source]¶ -
The type of encryption configuration being used. Currently the only supported types are ‘UserManaged’ and ‘ServiceManaged’.
-
SERVICE_MANAGED
= 'ServiceManaged'¶
-
USER_MANAGED
= 'UserManaged'¶
-
-
class
azure.mgmt.datalake.store.models.
EncryptionIdentity
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The encryption identity properties.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
-
type
= 'SystemAssigned'¶
-
class
azure.mgmt.datalake.store.models.
EncryptionProvisioningState
(value)[source]¶ -
The current state of encryption provisioning for this Data Lake Store account.
-
CREATING
= 'Creating'¶
-
SUCCEEDED
= 'Succeeded'¶
-
-
class
azure.mgmt.datalake.store.models.
EncryptionState
(value)[source]¶ -
The current state of encryption for this Data Lake Store account.
-
DISABLED
= 'Disabled'¶
-
ENABLED
= 'Enabled'¶
-
-
class
azure.mgmt.datalake.store.models.
FirewallAllowAzureIpsState
(value)[source]¶ -
The current state of allowing or disallowing IPs originating within Azure through the firewall. If the firewall is disabled, this is not enforced.
-
DISABLED
= 'Disabled'¶
-
ENABLED
= 'Enabled'¶
-
-
class
azure.mgmt.datalake.store.models.
FirewallRule
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store.models._models_py3.SubResource
Data Lake Store firewall rule information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – The 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.
FirewallRuleListResult
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
Data Lake Store firewall rule list information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
value (list[FirewallRule]) – The results of the list operation.
next_link (str) – The link (url) to the next page of results.
-
class
azure.mgmt.datalake.store.models.
FirewallState
(value)[source]¶ -
The current state of the IP address firewall for this Data Lake Store account.
-
DISABLED
= 'Disabled'¶
-
ENABLED
= 'Enabled'¶
-
-
class
azure.mgmt.datalake.store.models.
KeyVaultMetaInfo
(*, key_vault_resource_id: str, encryption_key_name: str, encryption_key_version: str, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
Metadata information used by account encryption.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.datalake.store.models.
NameAvailabilityInformation
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
Data Lake Store account name availability result information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name_available (bool) – The Boolean value of true or false to indicate whether the Data Lake Store account name is available or not.
reason (str) – The reason why the Data Lake Store account name is not available, if nameAvailable is false.
message (str) – The message describing why the Data Lake Store account name is not available, if nameAvailable is false.
-
class
azure.mgmt.datalake.store.models.
Operation
(*, display: Optional[_models.OperationDisplay] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
An available operation for Data Lake Store.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – The name of the operation.
display (OperationDisplay) – The display information for the operation.
origin (str or OperationOrigin) – The intended executor of the operation. Known values are: “user”, “system”, and “user,system”.
- Keyword Arguments
display (OperationDisplay) – The display information for the operation.
-
class
azure.mgmt.datalake.store.models.
OperationDisplay
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The display information for a particular operation.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.datalake.store.models.
OperationListResult
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The list of available operations for Data Lake Store.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.datalake.store.models.
OperationOrigin
(value)[source]¶ -
The intended executor of the operation.
-
SYSTEM
= 'system'¶
-
USER
= 'user'¶
-
USER_SYSTEM
= 'user,system'¶
-
-
class
azure.mgmt.datalake.store.models.
Resource
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The resource model definition.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.datalake.store.models.
SubResource
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._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.
-
class
azure.mgmt.datalake.store.models.
SubscriptionState
(value)[source]¶ -
The subscription state.
-
DELETED
= 'Deleted'¶
-
REGISTERED
= 'Registered'¶
-
SUSPENDED
= 'Suspended'¶
-
UNREGISTERED
= 'Unregistered'¶
-
WARNED
= 'Warned'¶
-
-
class
azure.mgmt.datalake.store.models.
TierType
(value)[source]¶ -
The commitment tier to use for next month.
-
COMMITMENT100_TB
= 'Commitment_100TB'¶
-
COMMITMENT10_TB
= 'Commitment_10TB'¶
-
COMMITMENT1_PB
= 'Commitment_1PB'¶
-
COMMITMENT1_TB
= 'Commitment_1TB'¶
-
COMMITMENT500_TB
= 'Commitment_500TB'¶
-
COMMITMENT5_PB
= 'Commitment_5PB'¶
-
CONSUMPTION
= 'Consumption'¶
-
-
class
azure.mgmt.datalake.store.models.
TrustedIdProvider
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store.models._models_py3.SubResource
Data Lake Store trusted identity provider information.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.datalake.store.models.
TrustedIdProviderListResult
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
Data Lake Store trusted identity provider list information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
value (list[TrustedIdProvider]) – The results of the list operation.
next_link (str) – The link (url) to the next page of results.
-
class
azure.mgmt.datalake.store.models.
TrustedIdProviderState
(value)[source]¶ -
The current state of the trusted identity provider feature for this Data Lake Store account.
-
DISABLED
= 'Disabled'¶
-
ENABLED
= 'Enabled'¶
-
-
class
azure.mgmt.datalake.store.models.
UpdateDataLakeStoreAccountParameters
(*, tags: Optional[Dict[str, str]] = None, default_group: Optional[str] = None, encryption_config: Optional[_models.UpdateEncryptionConfig] = None, firewall_rules: Optional[List[_models.UpdateFirewallRuleWithAccountParameters]] = None, virtual_network_rules: Optional[List[_models.UpdateVirtualNetworkRuleWithAccountParameters]] = None, firewall_state: Optional[Union[str, _models.FirewallState]] = None, firewall_allow_azure_ips: Optional[Union[str, _models.FirewallAllowAzureIpsState]] = None, trusted_id_providers: Optional[List[_models.UpdateTrustedIdProviderWithAccountParameters]] = None, trusted_id_provider_state: Optional[Union[str, _models.TrustedIdProviderState]] = None, new_tier: Optional[Union[str, _models.TierType]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
Data Lake Store account information to update.
- Variables
default_group (str) – The default owner group for all new folders and files created in the Data Lake Store account.
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.
firewall_rules (list[UpdateFirewallRuleWithAccountParameters]) – The list of firewall rules associated with this Data Lake Store account.
virtual_network_rules (list[UpdateVirtualNetworkRuleWithAccountParameters]) – The list of virtual network rules associated with this Data Lake Store account.
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. Known values are: “Enabled” and “Disabled”.
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. Known values are: “Enabled” and “Disabled”.
trusted_id_providers (list[UpdateTrustedIdProviderWithAccountParameters]) – The list of trusted identity providers 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. Disabling trusted identity provider functionality does not remove the providers, they will just be ignored until this feature is re-enabled. Known values are: “Enabled” and “Disabled”.
new_tier (str or TierType) – The commitment tier to use for next month. Known values are: “Consumption”, “Commitment_1TB”, “Commitment_10TB”, “Commitment_100TB”, “Commitment_500TB”, “Commitment_1PB”, and “Commitment_5PB”.
- Keyword Arguments
default_group (str) – The default owner group for all new folders and files created in the Data Lake Store account.
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.
firewall_rules (list[UpdateFirewallRuleWithAccountParameters]) – The list of firewall rules associated with this Data Lake Store account.
virtual_network_rules (list[UpdateVirtualNetworkRuleWithAccountParameters]) – The list of virtual network rules associated with this Data Lake Store account.
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. Known values are: “Enabled” and “Disabled”.
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. Known values are: “Enabled” and “Disabled”.
trusted_id_providers (list[UpdateTrustedIdProviderWithAccountParameters]) – The list of trusted identity providers 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. Disabling trusted identity provider functionality does not remove the providers, they will just be ignored until this feature is re-enabled. Known values are: “Enabled” and “Disabled”.
new_tier (str or TierType) – The commitment tier to use for next month. Known values are: “Consumption”, “Commitment_1TB”, “Commitment_10TB”, “Commitment_100TB”, “Commitment_500TB”, “Commitment_1PB”, and “Commitment_5PB”.
-
class
azure.mgmt.datalake.store.models.
UpdateEncryptionConfig
(*, key_vault_meta_info: Optional[_models.UpdateKeyVaultMetaInfo] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The encryption configuration used to update a user managed Key Vault key.
- Variables
key_vault_meta_info (UpdateKeyVaultMetaInfo) – The updated Key Vault key to use in user managed key rotation.
- Keyword Arguments
key_vault_meta_info (UpdateKeyVaultMetaInfo) – The updated Key Vault key to use in user managed key rotation.
-
class
azure.mgmt.datalake.store.models.
UpdateFirewallRuleParameters
(*, start_ip_address: Optional[str] = None, end_ip_address: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to update a firewall rule.
- Variables
- Keyword Arguments
-
class
azure.mgmt.datalake.store.models.
UpdateFirewallRuleWithAccountParameters
(*, name: str, start_ip_address: Optional[str] = None, end_ip_address: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to update a firewall rule while updating a Data Lake Store account.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – The unique name of the firewall rule to update. Required.
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.
- Keyword Arguments
name (str) – The unique name of the firewall rule to update. Required.
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.
UpdateKeyVaultMetaInfo
(*, encryption_key_version: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The Key Vault update information used for user managed key rotation.
-
class
azure.mgmt.datalake.store.models.
UpdateTrustedIdProviderParameters
(*, id_provider: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to update a trusted identity provider.
-
class
azure.mgmt.datalake.store.models.
UpdateTrustedIdProviderWithAccountParameters
(*, name: str, id_provider: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to update a trusted identity provider while updating a Data Lake Store account.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.datalake.store.models.
UpdateVirtualNetworkRuleParameters
(*, subnet_id: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to update a virtual network rule.
-
class
azure.mgmt.datalake.store.models.
UpdateVirtualNetworkRuleWithAccountParameters
(*, name: str, subnet_id: Optional[str] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The parameters used to update a virtual network rule while updating a Data Lake Store account.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.datalake.store.models.
Usage
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
Describes the Resource Usage.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
unit (str or UsageUnit) – Gets the unit of measurement. Known values are: “Count”, “Bytes”, “Seconds”, “Percent”, “CountsPerSecond”, and “BytesPerSecond”.
current_value (int) – Gets the current count of the allocated resources in the subscription.
limit (int) – Gets the maximum count of the resources that can be allocated in the subscription.
name (UsageName) – Gets the name of the type of usage.
-
class
azure.mgmt.datalake.store.models.
UsageListResult
(*, value: Optional[List[_models.Usage]] = None, **kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The response from the List Usages operation.
-
class
azure.mgmt.datalake.store.models.
UsageName
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
The usage names that can be used.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.datalake.store.models.
UsageUnit
(value)[source]¶ -
Gets the unit of measurement.
-
BYTES
= 'Bytes'¶
-
BYTES_PER_SECOND
= 'BytesPerSecond'¶
-
COUNT
= 'Count'¶
-
COUNTS_PER_SECOND
= 'CountsPerSecond'¶
-
PERCENT
= 'Percent'¶
-
SECONDS
= 'Seconds'¶
-
-
class
azure.mgmt.datalake.store.models.
VirtualNetworkRule
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store.models._models_py3.SubResource
Data Lake Store virtual network rule information.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.datalake.store.models.
VirtualNetworkRuleListResult
(**kwargs: Any)[source]¶ Bases:
azure.mgmt.datalake.store._serialization.Model
Data Lake Store virtual network rule list information.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
value (list[VirtualNetworkRule]) – The results of the list operation.
next_link (str) – The link (url) to the next page of results.