# coding=utf-8
# pylint: disable=too-many-lines
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union
from .. import _serialization
if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from .. import models as _models
[docs]class CheckNameAvailabilityParameters(_serialization.Model):
"""Data Lake Store account name availability check parameters.
All required parameters must be populated in order to send to Azure.
:ivar name: The Data Lake Store name to check availability for. Required.
:vartype name: str
:ivar type: The resource type. Note: This should not be set by the user, as the constant value
is Microsoft.DataLakeStore/accounts. Required. "Microsoft.DataLakeStore/accounts"
:vartype type: str or ~azure.mgmt.datalake.store.models.CheckNameAvailabilityParametersType
"""
_validation = {
"name": {"required": True},
"type": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
}
def __init__(
self, *, name: str, type: Union[str, "_models.CheckNameAvailabilityParametersType"], **kwargs: Any
) -> None:
"""
:keyword name: The Data Lake Store name to check availability for. Required.
:paramtype name: str
:keyword type: The resource type. Note: This should not be set by the user, as the constant
value is Microsoft.DataLakeStore/accounts. Required. "Microsoft.DataLakeStore/accounts"
:paramtype type: str or ~azure.mgmt.datalake.store.models.CheckNameAvailabilityParametersType
"""
super().__init__(**kwargs)
self.name = name
self.type = type
[docs]class CreateDataLakeStoreAccountParameters(_serialization.Model): # pylint: disable=too-many-instance-attributes
"""CreateDataLakeStoreAccountParameters.
All required parameters must be populated in order to send to Azure.
:ivar location: The resource location. Required.
:vartype location: str
:ivar tags: The resource tags.
:vartype tags: dict[str, str]
:ivar identity: The Key Vault encryption identity, if any.
:vartype identity: ~azure.mgmt.datalake.store.models.EncryptionIdentity
:ivar default_group: The default owner group for all new folders and files created in the Data
Lake Store account.
:vartype default_group: str
:ivar encryption_config: The Key Vault encryption configuration.
:vartype encryption_config: ~azure.mgmt.datalake.store.models.EncryptionConfig
:ivar encryption_state: The current state of encryption for this Data Lake Store account. Known
values are: "Enabled" and "Disabled".
:vartype encryption_state: str or ~azure.mgmt.datalake.store.models.EncryptionState
:ivar firewall_rules: The list of firewall rules associated with this Data Lake Store account.
:vartype firewall_rules:
list[~azure.mgmt.datalake.store.models.CreateFirewallRuleWithAccountParameters]
:ivar virtual_network_rules: The list of virtual network rules associated with this Data Lake
Store account.
:vartype virtual_network_rules:
list[~azure.mgmt.datalake.store.models.CreateVirtualNetworkRuleWithAccountParameters]
:ivar firewall_state: The current state of the IP address firewall for this Data Lake Store
account. Known values are: "Enabled" and "Disabled".
:vartype firewall_state: str or ~azure.mgmt.datalake.store.models.FirewallState
:ivar firewall_allow_azure_ips: 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".
:vartype firewall_allow_azure_ips: str or
~azure.mgmt.datalake.store.models.FirewallAllowAzureIpsState
:ivar trusted_id_providers: The list of trusted identity providers associated with this Data
Lake Store account.
:vartype trusted_id_providers:
list[~azure.mgmt.datalake.store.models.CreateTrustedIdProviderWithAccountParameters]
:ivar trusted_id_provider_state: The current state of the trusted identity provider feature for
this Data Lake Store account. Known values are: "Enabled" and "Disabled".
:vartype trusted_id_provider_state: str or
~azure.mgmt.datalake.store.models.TrustedIdProviderState
:ivar new_tier: 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".
:vartype new_tier: str or ~azure.mgmt.datalake.store.models.TierType
"""
_validation = {
"location": {"required": True},
}
_attribute_map = {
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"identity": {"key": "identity", "type": "EncryptionIdentity"},
"default_group": {"key": "properties.defaultGroup", "type": "str"},
"encryption_config": {"key": "properties.encryptionConfig", "type": "EncryptionConfig"},
"encryption_state": {"key": "properties.encryptionState", "type": "str"},
"firewall_rules": {"key": "properties.firewallRules", "type": "[CreateFirewallRuleWithAccountParameters]"},
"virtual_network_rules": {
"key": "properties.virtualNetworkRules",
"type": "[CreateVirtualNetworkRuleWithAccountParameters]",
},
"firewall_state": {"key": "properties.firewallState", "type": "str"},
"firewall_allow_azure_ips": {"key": "properties.firewallAllowAzureIps", "type": "str"},
"trusted_id_providers": {
"key": "properties.trustedIdProviders",
"type": "[CreateTrustedIdProviderWithAccountParameters]",
},
"trusted_id_provider_state": {"key": "properties.trustedIdProviderState", "type": "str"},
"new_tier": {"key": "properties.newTier", "type": "str"},
}
def __init__(
self,
*,
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
) -> None:
"""
:keyword location: The resource location. Required.
:paramtype location: str
:keyword tags: The resource tags.
:paramtype tags: dict[str, str]
:keyword identity: The Key Vault encryption identity, if any.
:paramtype identity: ~azure.mgmt.datalake.store.models.EncryptionIdentity
:keyword default_group: The default owner group for all new folders and files created in the
Data Lake Store account.
:paramtype default_group: str
:keyword encryption_config: The Key Vault encryption configuration.
:paramtype encryption_config: ~azure.mgmt.datalake.store.models.EncryptionConfig
:keyword encryption_state: The current state of encryption for this Data Lake Store account.
Known values are: "Enabled" and "Disabled".
:paramtype encryption_state: str or ~azure.mgmt.datalake.store.models.EncryptionState
:keyword firewall_rules: The list of firewall rules associated with this Data Lake Store
account.
:paramtype firewall_rules:
list[~azure.mgmt.datalake.store.models.CreateFirewallRuleWithAccountParameters]
:keyword virtual_network_rules: The list of virtual network rules associated with this Data
Lake Store account.
:paramtype virtual_network_rules:
list[~azure.mgmt.datalake.store.models.CreateVirtualNetworkRuleWithAccountParameters]
:keyword firewall_state: The current state of the IP address firewall for this Data Lake Store
account. Known values are: "Enabled" and "Disabled".
:paramtype firewall_state: str or ~azure.mgmt.datalake.store.models.FirewallState
:keyword firewall_allow_azure_ips: 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".
:paramtype firewall_allow_azure_ips: str or
~azure.mgmt.datalake.store.models.FirewallAllowAzureIpsState
:keyword trusted_id_providers: The list of trusted identity providers associated with this Data
Lake Store account.
:paramtype trusted_id_providers:
list[~azure.mgmt.datalake.store.models.CreateTrustedIdProviderWithAccountParameters]
:keyword trusted_id_provider_state: The current state of the trusted identity provider feature
for this Data Lake Store account. Known values are: "Enabled" and "Disabled".
:paramtype trusted_id_provider_state: str or
~azure.mgmt.datalake.store.models.TrustedIdProviderState
:keyword new_tier: 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".
:paramtype new_tier: str or ~azure.mgmt.datalake.store.models.TierType
"""
super().__init__(**kwargs)
self.location = location
self.tags = tags
self.identity = identity
self.default_group = default_group
self.encryption_config = encryption_config
self.encryption_state = encryption_state
self.firewall_rules = firewall_rules
self.virtual_network_rules = virtual_network_rules
self.firewall_state = firewall_state
self.firewall_allow_azure_ips = firewall_allow_azure_ips
self.trusted_id_providers = trusted_id_providers
self.trusted_id_provider_state = trusted_id_provider_state
self.new_tier = new_tier
[docs]class CreateFirewallRuleWithAccountParameters(_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.
:ivar name: The unique name of the firewall rule to create. Required.
:vartype name: str
:ivar start_ip_address: 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.
:vartype start_ip_address: str
:ivar end_ip_address: 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.
:vartype end_ip_address: str
"""
_validation = {
"name": {"required": True},
"start_ip_address": {"required": True},
"end_ip_address": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"start_ip_address": {"key": "properties.startIpAddress", "type": "str"},
"end_ip_address": {"key": "properties.endIpAddress", "type": "str"},
}
def __init__(self, *, name: str, start_ip_address: str, end_ip_address: str, **kwargs: Any) -> None:
"""
:keyword name: The unique name of the firewall rule to create. Required.
:paramtype name: str
:keyword start_ip_address: 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.
:paramtype start_ip_address: str
:keyword end_ip_address: 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.
:paramtype end_ip_address: str
"""
super().__init__(**kwargs)
self.name = name
self.start_ip_address = start_ip_address
self.end_ip_address = end_ip_address
[docs]class CreateOrUpdateFirewallRuleParameters(_serialization.Model):
"""The parameters used to create a new firewall rule.
All required parameters must be populated in order to send to Azure.
:ivar start_ip_address: 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.
:vartype start_ip_address: str
:ivar end_ip_address: 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.
:vartype end_ip_address: str
"""
_validation = {
"start_ip_address": {"required": True},
"end_ip_address": {"required": True},
}
_attribute_map = {
"start_ip_address": {"key": "properties.startIpAddress", "type": "str"},
"end_ip_address": {"key": "properties.endIpAddress", "type": "str"},
}
def __init__(self, *, start_ip_address: str, end_ip_address: str, **kwargs: Any) -> None:
"""
:keyword start_ip_address: 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.
:paramtype start_ip_address: str
:keyword end_ip_address: 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.
:paramtype end_ip_address: str
"""
super().__init__(**kwargs)
self.start_ip_address = start_ip_address
self.end_ip_address = end_ip_address
[docs]class CreateOrUpdateTrustedIdProviderParameters(_serialization.Model):
"""The parameters used to create a new trusted identity provider.
All required parameters must be populated in order to send to Azure.
:ivar id_provider: The URL of this trusted identity provider. Required.
:vartype id_provider: str
"""
_validation = {
"id_provider": {"required": True},
}
_attribute_map = {
"id_provider": {"key": "properties.idProvider", "type": "str"},
}
def __init__(self, *, id_provider: str, **kwargs: Any) -> None:
"""
:keyword id_provider: The URL of this trusted identity provider. Required.
:paramtype id_provider: str
"""
super().__init__(**kwargs)
self.id_provider = id_provider
[docs]class CreateOrUpdateVirtualNetworkRuleParameters(_serialization.Model):
"""The parameters used to create a new virtual network rule.
All required parameters must be populated in order to send to Azure.
:ivar subnet_id: The resource identifier for the subnet. Required.
:vartype subnet_id: str
"""
_validation = {
"subnet_id": {"required": True},
}
_attribute_map = {
"subnet_id": {"key": "properties.subnetId", "type": "str"},
}
def __init__(self, *, subnet_id: str, **kwargs: Any) -> None:
"""
:keyword subnet_id: The resource identifier for the subnet. Required.
:paramtype subnet_id: str
"""
super().__init__(**kwargs)
self.subnet_id = subnet_id
[docs]class CreateTrustedIdProviderWithAccountParameters(_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.
:ivar name: The unique name of the trusted identity provider to create. Required.
:vartype name: str
:ivar id_provider: The URL of this trusted identity provider. Required.
:vartype id_provider: str
"""
_validation = {
"name": {"required": True},
"id_provider": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"id_provider": {"key": "properties.idProvider", "type": "str"},
}
def __init__(self, *, name: str, id_provider: str, **kwargs: Any) -> None:
"""
:keyword name: The unique name of the trusted identity provider to create. Required.
:paramtype name: str
:keyword id_provider: The URL of this trusted identity provider. Required.
:paramtype id_provider: str
"""
super().__init__(**kwargs)
self.name = name
self.id_provider = id_provider
[docs]class CreateVirtualNetworkRuleWithAccountParameters(_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.
:ivar name: The unique name of the virtual network rule to create. Required.
:vartype name: str
:ivar subnet_id: The resource identifier for the subnet. Required.
:vartype subnet_id: str
"""
_validation = {
"name": {"required": True},
"subnet_id": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"subnet_id": {"key": "properties.subnetId", "type": "str"},
}
def __init__(self, *, name: str, subnet_id: str, **kwargs: Any) -> None:
"""
:keyword name: The unique name of the virtual network rule to create. Required.
:paramtype name: str
:keyword subnet_id: The resource identifier for the subnet. Required.
:paramtype subnet_id: str
"""
super().__init__(**kwargs)
self.name = name
self.subnet_id = subnet_id
[docs]class Resource(_serialization.Model):
"""The resource model definition.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar location: The resource location.
:vartype location: str
:ivar tags: The resource tags.
:vartype tags: dict[str, str]
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"readonly": True},
"tags": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.location = None
self.tags = None
[docs]class DataLakeStoreAccount(Resource): # pylint: disable=too-many-instance-attributes
"""Data Lake Store account information.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar location: The resource location.
:vartype location: str
:ivar tags: The resource tags.
:vartype tags: dict[str, str]
:ivar identity: The Key Vault encryption identity, if any.
:vartype identity: ~azure.mgmt.datalake.store.models.EncryptionIdentity
:ivar account_id: The unique identifier associated with this Data Lake Store account.
:vartype account_id: str
:ivar provisioning_state: The provisioning status of the Data Lake Store account. Known values
are: "Failed", "Creating", "Running", "Succeeded", "Patching", "Suspending", "Resuming",
"Deleting", "Deleted", "Undeleting", and "Canceled".
:vartype provisioning_state: str or
~azure.mgmt.datalake.store.models.DataLakeStoreAccountStatus
:ivar state: The state of the Data Lake Store account. Known values are: "Active" and
"Suspended".
:vartype state: str or ~azure.mgmt.datalake.store.models.DataLakeStoreAccountState
:ivar creation_time: The account creation time.
:vartype creation_time: ~datetime.datetime
:ivar last_modified_time: The account last modified time.
:vartype last_modified_time: ~datetime.datetime
:ivar endpoint: The full CName endpoint for this account.
:vartype endpoint: str
:ivar default_group: The default owner group for all new folders and files created in the Data
Lake Store account.
:vartype default_group: str
:ivar encryption_config: The Key Vault encryption configuration.
:vartype encryption_config: ~azure.mgmt.datalake.store.models.EncryptionConfig
:ivar encryption_state: The current state of encryption for this Data Lake Store account. Known
values are: "Enabled" and "Disabled".
:vartype encryption_state: str or ~azure.mgmt.datalake.store.models.EncryptionState
:ivar encryption_provisioning_state: The current state of encryption provisioning for this Data
Lake Store account. Known values are: "Creating" and "Succeeded".
:vartype encryption_provisioning_state: str or
~azure.mgmt.datalake.store.models.EncryptionProvisioningState
:ivar firewall_rules: The list of firewall rules associated with this Data Lake Store account.
:vartype firewall_rules: list[~azure.mgmt.datalake.store.models.FirewallRule]
:ivar virtual_network_rules: The list of virtual network rules associated with this Data Lake
Store account.
:vartype virtual_network_rules: list[~azure.mgmt.datalake.store.models.VirtualNetworkRule]
:ivar firewall_state: The current state of the IP address firewall for this Data Lake Store
account. Known values are: "Enabled" and "Disabled".
:vartype firewall_state: str or ~azure.mgmt.datalake.store.models.FirewallState
:ivar firewall_allow_azure_ips: 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".
:vartype firewall_allow_azure_ips: str or
~azure.mgmt.datalake.store.models.FirewallAllowAzureIpsState
:ivar trusted_id_providers: The list of trusted identity providers associated with this Data
Lake Store account.
:vartype trusted_id_providers: list[~azure.mgmt.datalake.store.models.TrustedIdProvider]
:ivar trusted_id_provider_state: The current state of the trusted identity provider feature for
this Data Lake Store account. Known values are: "Enabled" and "Disabled".
:vartype trusted_id_provider_state: str or
~azure.mgmt.datalake.store.models.TrustedIdProviderState
:ivar new_tier: 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".
:vartype new_tier: str or ~azure.mgmt.datalake.store.models.TierType
:ivar current_tier: 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".
:vartype current_tier: str or ~azure.mgmt.datalake.store.models.TierType
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"readonly": True},
"tags": {"readonly": True},
"identity": {"readonly": True},
"account_id": {"readonly": True},
"provisioning_state": {"readonly": True},
"state": {"readonly": True},
"creation_time": {"readonly": True},
"last_modified_time": {"readonly": True},
"endpoint": {"readonly": True},
"default_group": {"readonly": True},
"encryption_config": {"readonly": True},
"encryption_state": {"readonly": True},
"encryption_provisioning_state": {"readonly": True},
"firewall_rules": {"readonly": True},
"virtual_network_rules": {"readonly": True},
"firewall_state": {"readonly": True},
"firewall_allow_azure_ips": {"readonly": True},
"trusted_id_providers": {"readonly": True},
"trusted_id_provider_state": {"readonly": True},
"new_tier": {"readonly": True},
"current_tier": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"identity": {"key": "identity", "type": "EncryptionIdentity"},
"account_id": {"key": "properties.accountId", "type": "str"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"state": {"key": "properties.state", "type": "str"},
"creation_time": {"key": "properties.creationTime", "type": "iso-8601"},
"last_modified_time": {"key": "properties.lastModifiedTime", "type": "iso-8601"},
"endpoint": {"key": "properties.endpoint", "type": "str"},
"default_group": {"key": "properties.defaultGroup", "type": "str"},
"encryption_config": {"key": "properties.encryptionConfig", "type": "EncryptionConfig"},
"encryption_state": {"key": "properties.encryptionState", "type": "str"},
"encryption_provisioning_state": {"key": "properties.encryptionProvisioningState", "type": "str"},
"firewall_rules": {"key": "properties.firewallRules", "type": "[FirewallRule]"},
"virtual_network_rules": {"key": "properties.virtualNetworkRules", "type": "[VirtualNetworkRule]"},
"firewall_state": {"key": "properties.firewallState", "type": "str"},
"firewall_allow_azure_ips": {"key": "properties.firewallAllowAzureIps", "type": "str"},
"trusted_id_providers": {"key": "properties.trustedIdProviders", "type": "[TrustedIdProvider]"},
"trusted_id_provider_state": {"key": "properties.trustedIdProviderState", "type": "str"},
"new_tier": {"key": "properties.newTier", "type": "str"},
"current_tier": {"key": "properties.currentTier", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None: # pylint: disable=too-many-locals
""" """
super().__init__(**kwargs)
self.identity = None
self.account_id = None
self.provisioning_state = None
self.state = None
self.creation_time = None
self.last_modified_time = None
self.endpoint = None
self.default_group = None
self.encryption_config = None
self.encryption_state = None
self.encryption_provisioning_state = None
self.firewall_rules = None
self.virtual_network_rules = None
self.firewall_state = None
self.firewall_allow_azure_ips = None
self.trusted_id_providers = None
self.trusted_id_provider_state = None
self.new_tier = None
self.current_tier = None
[docs]class DataLakeStoreAccountBasic(Resource): # pylint: disable=too-many-instance-attributes
"""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.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar location: The resource location.
:vartype location: str
:ivar tags: The resource tags.
:vartype tags: dict[str, str]
:ivar account_id: The unique identifier associated with this Data Lake Store account.
:vartype account_id: str
:ivar provisioning_state: The provisioning status of the Data Lake Store account. Known values
are: "Failed", "Creating", "Running", "Succeeded", "Patching", "Suspending", "Resuming",
"Deleting", "Deleted", "Undeleting", and "Canceled".
:vartype provisioning_state: str or
~azure.mgmt.datalake.store.models.DataLakeStoreAccountStatus
:ivar state: The state of the Data Lake Store account. Known values are: "Active" and
"Suspended".
:vartype state: str or ~azure.mgmt.datalake.store.models.DataLakeStoreAccountState
:ivar creation_time: The account creation time.
:vartype creation_time: ~datetime.datetime
:ivar last_modified_time: The account last modified time.
:vartype last_modified_time: ~datetime.datetime
:ivar endpoint: The full CName endpoint for this account.
:vartype endpoint: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"location": {"readonly": True},
"tags": {"readonly": True},
"account_id": {"readonly": True},
"provisioning_state": {"readonly": True},
"state": {"readonly": True},
"creation_time": {"readonly": True},
"last_modified_time": {"readonly": True},
"endpoint": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"account_id": {"key": "properties.accountId", "type": "str"},
"provisioning_state": {"key": "properties.provisioningState", "type": "str"},
"state": {"key": "properties.state", "type": "str"},
"creation_time": {"key": "properties.creationTime", "type": "iso-8601"},
"last_modified_time": {"key": "properties.lastModifiedTime", "type": "iso-8601"},
"endpoint": {"key": "properties.endpoint", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.account_id = None
self.provisioning_state = None
self.state = None
self.creation_time = None
self.last_modified_time = None
self.endpoint = None
[docs]class DataLakeStoreAccountListResult(_serialization.Model):
"""Data Lake Store account list information response.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: The results of the list operation.
:vartype value: list[~azure.mgmt.datalake.store.models.DataLakeStoreAccountBasic]
:ivar next_link: The link (url) to the next page of results.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[DataLakeStoreAccountBasic]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class DataLakeStoreAccountPropertiesBasic(_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.
:ivar account_id: The unique identifier associated with this Data Lake Store account.
:vartype account_id: str
:ivar provisioning_state: The provisioning status of the Data Lake Store account. Known values
are: "Failed", "Creating", "Running", "Succeeded", "Patching", "Suspending", "Resuming",
"Deleting", "Deleted", "Undeleting", and "Canceled".
:vartype provisioning_state: str or
~azure.mgmt.datalake.store.models.DataLakeStoreAccountStatus
:ivar state: The state of the Data Lake Store account. Known values are: "Active" and
"Suspended".
:vartype state: str or ~azure.mgmt.datalake.store.models.DataLakeStoreAccountState
:ivar creation_time: The account creation time.
:vartype creation_time: ~datetime.datetime
:ivar last_modified_time: The account last modified time.
:vartype last_modified_time: ~datetime.datetime
:ivar endpoint: The full CName endpoint for this account.
:vartype endpoint: str
"""
_validation = {
"account_id": {"readonly": True},
"provisioning_state": {"readonly": True},
"state": {"readonly": True},
"creation_time": {"readonly": True},
"last_modified_time": {"readonly": True},
"endpoint": {"readonly": True},
}
_attribute_map = {
"account_id": {"key": "accountId", "type": "str"},
"provisioning_state": {"key": "provisioningState", "type": "str"},
"state": {"key": "state", "type": "str"},
"creation_time": {"key": "creationTime", "type": "iso-8601"},
"last_modified_time": {"key": "lastModifiedTime", "type": "iso-8601"},
"endpoint": {"key": "endpoint", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.account_id = None
self.provisioning_state = None
self.state = None
self.creation_time = None
self.last_modified_time = None
self.endpoint = None
[docs]class DataLakeStoreAccountProperties(
DataLakeStoreAccountPropertiesBasic
): # pylint: disable=too-many-instance-attributes
"""Data Lake Store account properties information.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar account_id: The unique identifier associated with this Data Lake Store account.
:vartype account_id: str
:ivar provisioning_state: The provisioning status of the Data Lake Store account. Known values
are: "Failed", "Creating", "Running", "Succeeded", "Patching", "Suspending", "Resuming",
"Deleting", "Deleted", "Undeleting", and "Canceled".
:vartype provisioning_state: str or
~azure.mgmt.datalake.store.models.DataLakeStoreAccountStatus
:ivar state: The state of the Data Lake Store account. Known values are: "Active" and
"Suspended".
:vartype state: str or ~azure.mgmt.datalake.store.models.DataLakeStoreAccountState
:ivar creation_time: The account creation time.
:vartype creation_time: ~datetime.datetime
:ivar last_modified_time: The account last modified time.
:vartype last_modified_time: ~datetime.datetime
:ivar endpoint: The full CName endpoint for this account.
:vartype endpoint: str
:ivar default_group: The default owner group for all new folders and files created in the Data
Lake Store account.
:vartype default_group: str
:ivar encryption_config: The Key Vault encryption configuration.
:vartype encryption_config: ~azure.mgmt.datalake.store.models.EncryptionConfig
:ivar encryption_state: The current state of encryption for this Data Lake Store account. Known
values are: "Enabled" and "Disabled".
:vartype encryption_state: str or ~azure.mgmt.datalake.store.models.EncryptionState
:ivar encryption_provisioning_state: The current state of encryption provisioning for this Data
Lake Store account. Known values are: "Creating" and "Succeeded".
:vartype encryption_provisioning_state: str or
~azure.mgmt.datalake.store.models.EncryptionProvisioningState
:ivar firewall_rules: The list of firewall rules associated with this Data Lake Store account.
:vartype firewall_rules: list[~azure.mgmt.datalake.store.models.FirewallRule]
:ivar virtual_network_rules: The list of virtual network rules associated with this Data Lake
Store account.
:vartype virtual_network_rules: list[~azure.mgmt.datalake.store.models.VirtualNetworkRule]
:ivar firewall_state: The current state of the IP address firewall for this Data Lake Store
account. Known values are: "Enabled" and "Disabled".
:vartype firewall_state: str or ~azure.mgmt.datalake.store.models.FirewallState
:ivar firewall_allow_azure_ips: 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".
:vartype firewall_allow_azure_ips: str or
~azure.mgmt.datalake.store.models.FirewallAllowAzureIpsState
:ivar trusted_id_providers: The list of trusted identity providers associated with this Data
Lake Store account.
:vartype trusted_id_providers: list[~azure.mgmt.datalake.store.models.TrustedIdProvider]
:ivar trusted_id_provider_state: The current state of the trusted identity provider feature for
this Data Lake Store account. Known values are: "Enabled" and "Disabled".
:vartype trusted_id_provider_state: str or
~azure.mgmt.datalake.store.models.TrustedIdProviderState
:ivar new_tier: 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".
:vartype new_tier: str or ~azure.mgmt.datalake.store.models.TierType
:ivar current_tier: 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".
:vartype current_tier: str or ~azure.mgmt.datalake.store.models.TierType
"""
_validation = {
"account_id": {"readonly": True},
"provisioning_state": {"readonly": True},
"state": {"readonly": True},
"creation_time": {"readonly": True},
"last_modified_time": {"readonly": True},
"endpoint": {"readonly": True},
"default_group": {"readonly": True},
"encryption_config": {"readonly": True},
"encryption_state": {"readonly": True},
"encryption_provisioning_state": {"readonly": True},
"firewall_rules": {"readonly": True},
"virtual_network_rules": {"readonly": True},
"firewall_state": {"readonly": True},
"firewall_allow_azure_ips": {"readonly": True},
"trusted_id_providers": {"readonly": True},
"trusted_id_provider_state": {"readonly": True},
"new_tier": {"readonly": True},
"current_tier": {"readonly": True},
}
_attribute_map = {
"account_id": {"key": "accountId", "type": "str"},
"provisioning_state": {"key": "provisioningState", "type": "str"},
"state": {"key": "state", "type": "str"},
"creation_time": {"key": "creationTime", "type": "iso-8601"},
"last_modified_time": {"key": "lastModifiedTime", "type": "iso-8601"},
"endpoint": {"key": "endpoint", "type": "str"},
"default_group": {"key": "defaultGroup", "type": "str"},
"encryption_config": {"key": "encryptionConfig", "type": "EncryptionConfig"},
"encryption_state": {"key": "encryptionState", "type": "str"},
"encryption_provisioning_state": {"key": "encryptionProvisioningState", "type": "str"},
"firewall_rules": {"key": "firewallRules", "type": "[FirewallRule]"},
"virtual_network_rules": {"key": "virtualNetworkRules", "type": "[VirtualNetworkRule]"},
"firewall_state": {"key": "firewallState", "type": "str"},
"firewall_allow_azure_ips": {"key": "firewallAllowAzureIps", "type": "str"},
"trusted_id_providers": {"key": "trustedIdProviders", "type": "[TrustedIdProvider]"},
"trusted_id_provider_state": {"key": "trustedIdProviderState", "type": "str"},
"new_tier": {"key": "newTier", "type": "str"},
"current_tier": {"key": "currentTier", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.default_group = None
self.encryption_config = None
self.encryption_state = None
self.encryption_provisioning_state = None
self.firewall_rules = None
self.virtual_network_rules = None
self.firewall_state = None
self.firewall_allow_azure_ips = None
self.trusted_id_providers = None
self.trusted_id_provider_state = None
self.new_tier = None
self.current_tier = None
[docs]class EncryptionConfig(_serialization.Model):
"""The encryption configuration for the account.
All required parameters must be populated in order to send to Azure.
:ivar type: The type of encryption configuration being used. Currently the only supported types
are 'UserManaged' and 'ServiceManaged'. Required. Known values are: "UserManaged" and
"ServiceManaged".
:vartype type: str or ~azure.mgmt.datalake.store.models.EncryptionConfigType
:ivar key_vault_meta_info: The Key Vault information for connecting to user managed encryption
keys.
:vartype key_vault_meta_info: ~azure.mgmt.datalake.store.models.KeyVaultMetaInfo
"""
_validation = {
"type": {"required": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"key_vault_meta_info": {"key": "keyVaultMetaInfo", "type": "KeyVaultMetaInfo"},
}
def __init__(
self,
*,
type: Union[str, "_models.EncryptionConfigType"],
key_vault_meta_info: Optional["_models.KeyVaultMetaInfo"] = None,
**kwargs: Any
) -> None:
"""
:keyword type: The type of encryption configuration being used. Currently the only supported
types are 'UserManaged' and 'ServiceManaged'. Required. Known values are: "UserManaged" and
"ServiceManaged".
:paramtype type: str or ~azure.mgmt.datalake.store.models.EncryptionConfigType
:keyword key_vault_meta_info: The Key Vault information for connecting to user managed
encryption keys.
:paramtype key_vault_meta_info: ~azure.mgmt.datalake.store.models.KeyVaultMetaInfo
"""
super().__init__(**kwargs)
self.type = type
self.key_vault_meta_info = key_vault_meta_info
[docs]class EncryptionIdentity(_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.
:ivar type: The type of encryption being used. Currently the only supported type is
'SystemAssigned'. Required. Default value is "SystemAssigned".
:vartype type: str
:ivar principal_id: The principal identifier associated with the encryption.
:vartype principal_id: str
:ivar tenant_id: The tenant identifier associated with the encryption.
:vartype tenant_id: str
"""
_validation = {
"type": {"required": True, "constant": True},
"principal_id": {"readonly": True},
"tenant_id": {"readonly": True},
}
_attribute_map = {
"type": {"key": "type", "type": "str"},
"principal_id": {"key": "principalId", "type": "str"},
"tenant_id": {"key": "tenantId", "type": "str"},
}
type = "SystemAssigned"
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.principal_id = None
self.tenant_id = None
[docs]class SubResource(_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.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.id = None
self.name = None
self.type = None
[docs]class FirewallRule(SubResource):
"""Data Lake Store firewall rule information.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar start_ip_address: The start IP address for the firewall rule. This can be either ipv4 or
ipv6. Start and End should be in the same protocol.
:vartype start_ip_address: str
:ivar end_ip_address: The end IP address for the firewall rule. This can be either ipv4 or
ipv6. Start and End should be in the same protocol.
:vartype end_ip_address: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"start_ip_address": {"readonly": True},
"end_ip_address": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"start_ip_address": {"key": "properties.startIpAddress", "type": "str"},
"end_ip_address": {"key": "properties.endIpAddress", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.start_ip_address = None
self.end_ip_address = None
[docs]class FirewallRuleListResult(_serialization.Model):
"""Data Lake Store firewall rule list information.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: The results of the list operation.
:vartype value: list[~azure.mgmt.datalake.store.models.FirewallRule]
:ivar next_link: The link (url) to the next page of results.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[FirewallRule]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class Operation(_serialization.Model):
"""An available operation for Data Lake Store.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: The name of the operation.
:vartype name: str
:ivar display: The display information for the operation.
:vartype display: ~azure.mgmt.datalake.store.models.OperationDisplay
:ivar origin: The intended executor of the operation. Known values are: "user", "system", and
"user,system".
:vartype origin: str or ~azure.mgmt.datalake.store.models.OperationOrigin
"""
_validation = {
"name": {"readonly": True},
"origin": {"readonly": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"display": {"key": "display", "type": "OperationDisplay"},
"origin": {"key": "origin", "type": "str"},
}
def __init__(self, *, display: Optional["_models.OperationDisplay"] = None, **kwargs: Any) -> None:
"""
:keyword display: The display information for the operation.
:paramtype display: ~azure.mgmt.datalake.store.models.OperationDisplay
"""
super().__init__(**kwargs)
self.name = None
self.display = display
self.origin = None
[docs]class OperationDisplay(_serialization.Model):
"""The display information for a particular operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar provider: The resource provider of the operation.
:vartype provider: str
:ivar resource: The resource type of the operation.
:vartype resource: str
:ivar operation: A friendly name of the operation.
:vartype operation: str
:ivar description: A friendly description of the operation.
:vartype description: str
"""
_validation = {
"provider": {"readonly": True},
"resource": {"readonly": True},
"operation": {"readonly": True},
"description": {"readonly": True},
}
_attribute_map = {
"provider": {"key": "provider", "type": "str"},
"resource": {"key": "resource", "type": "str"},
"operation": {"key": "operation", "type": "str"},
"description": {"key": "description", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.provider = None
self.resource = None
self.operation = None
self.description = None
[docs]class OperationListResult(_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.
:ivar value: The results of the list operation.
:vartype value: list[~azure.mgmt.datalake.store.models.Operation]
:ivar next_link: The link (url) to the next page of results.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[Operation]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class TrustedIdProvider(SubResource):
"""Data Lake Store trusted identity provider information.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar id_provider: The URL of this trusted identity provider.
:vartype id_provider: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"id_provider": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"id_provider": {"key": "properties.idProvider", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.id_provider = None
[docs]class TrustedIdProviderListResult(_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.
:ivar value: The results of the list operation.
:vartype value: list[~azure.mgmt.datalake.store.models.TrustedIdProvider]
:ivar next_link: The link (url) to the next page of results.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[TrustedIdProvider]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None
[docs]class UpdateDataLakeStoreAccountParameters(_serialization.Model):
"""Data Lake Store account information to update.
:ivar tags: Resource tags.
:vartype tags: dict[str, str]
:ivar default_group: The default owner group for all new folders and files created in the Data
Lake Store account.
:vartype default_group: str
:ivar encryption_config: Used for rotation of user managed Key Vault keys. Can only be used to
rotate a user managed encryption Key Vault key.
:vartype encryption_config: ~azure.mgmt.datalake.store.models.UpdateEncryptionConfig
:ivar firewall_rules: The list of firewall rules associated with this Data Lake Store account.
:vartype firewall_rules:
list[~azure.mgmt.datalake.store.models.UpdateFirewallRuleWithAccountParameters]
:ivar virtual_network_rules: The list of virtual network rules associated with this Data Lake
Store account.
:vartype virtual_network_rules:
list[~azure.mgmt.datalake.store.models.UpdateVirtualNetworkRuleWithAccountParameters]
:ivar firewall_state: 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".
:vartype firewall_state: str or ~azure.mgmt.datalake.store.models.FirewallState
:ivar firewall_allow_azure_ips: 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".
:vartype firewall_allow_azure_ips: str or
~azure.mgmt.datalake.store.models.FirewallAllowAzureIpsState
:ivar trusted_id_providers: The list of trusted identity providers associated with this Data
Lake Store account.
:vartype trusted_id_providers:
list[~azure.mgmt.datalake.store.models.UpdateTrustedIdProviderWithAccountParameters]
:ivar trusted_id_provider_state: 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".
:vartype trusted_id_provider_state: str or
~azure.mgmt.datalake.store.models.TrustedIdProviderState
:ivar new_tier: 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".
:vartype new_tier: str or ~azure.mgmt.datalake.store.models.TierType
"""
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"default_group": {"key": "properties.defaultGroup", "type": "str"},
"encryption_config": {"key": "properties.encryptionConfig", "type": "UpdateEncryptionConfig"},
"firewall_rules": {"key": "properties.firewallRules", "type": "[UpdateFirewallRuleWithAccountParameters]"},
"virtual_network_rules": {
"key": "properties.virtualNetworkRules",
"type": "[UpdateVirtualNetworkRuleWithAccountParameters]",
},
"firewall_state": {"key": "properties.firewallState", "type": "str"},
"firewall_allow_azure_ips": {"key": "properties.firewallAllowAzureIps", "type": "str"},
"trusted_id_providers": {
"key": "properties.trustedIdProviders",
"type": "[UpdateTrustedIdProviderWithAccountParameters]",
},
"trusted_id_provider_state": {"key": "properties.trustedIdProviderState", "type": "str"},
"new_tier": {"key": "properties.newTier", "type": "str"},
}
def __init__(
self,
*,
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
) -> None:
"""
:keyword tags: Resource tags.
:paramtype tags: dict[str, str]
:keyword default_group: The default owner group for all new folders and files created in the
Data Lake Store account.
:paramtype default_group: str
:keyword encryption_config: Used for rotation of user managed Key Vault keys. Can only be used
to rotate a user managed encryption Key Vault key.
:paramtype encryption_config: ~azure.mgmt.datalake.store.models.UpdateEncryptionConfig
:keyword firewall_rules: The list of firewall rules associated with this Data Lake Store
account.
:paramtype firewall_rules:
list[~azure.mgmt.datalake.store.models.UpdateFirewallRuleWithAccountParameters]
:keyword virtual_network_rules: The list of virtual network rules associated with this Data
Lake Store account.
:paramtype virtual_network_rules:
list[~azure.mgmt.datalake.store.models.UpdateVirtualNetworkRuleWithAccountParameters]
:keyword firewall_state: 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".
:paramtype firewall_state: str or ~azure.mgmt.datalake.store.models.FirewallState
:keyword firewall_allow_azure_ips: 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".
:paramtype firewall_allow_azure_ips: str or
~azure.mgmt.datalake.store.models.FirewallAllowAzureIpsState
:keyword trusted_id_providers: The list of trusted identity providers associated with this Data
Lake Store account.
:paramtype trusted_id_providers:
list[~azure.mgmt.datalake.store.models.UpdateTrustedIdProviderWithAccountParameters]
:keyword trusted_id_provider_state: 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".
:paramtype trusted_id_provider_state: str or
~azure.mgmt.datalake.store.models.TrustedIdProviderState
:keyword new_tier: 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".
:paramtype new_tier: str or ~azure.mgmt.datalake.store.models.TierType
"""
super().__init__(**kwargs)
self.tags = tags
self.default_group = default_group
self.encryption_config = encryption_config
self.firewall_rules = firewall_rules
self.virtual_network_rules = virtual_network_rules
self.firewall_state = firewall_state
self.firewall_allow_azure_ips = firewall_allow_azure_ips
self.trusted_id_providers = trusted_id_providers
self.trusted_id_provider_state = trusted_id_provider_state
self.new_tier = new_tier
[docs]class UpdateEncryptionConfig(_serialization.Model):
"""The encryption configuration used to update a user managed Key Vault key.
:ivar key_vault_meta_info: The updated Key Vault key to use in user managed key rotation.
:vartype key_vault_meta_info: ~azure.mgmt.datalake.store.models.UpdateKeyVaultMetaInfo
"""
_attribute_map = {
"key_vault_meta_info": {"key": "keyVaultMetaInfo", "type": "UpdateKeyVaultMetaInfo"},
}
def __init__(
self, *, key_vault_meta_info: Optional["_models.UpdateKeyVaultMetaInfo"] = None, **kwargs: Any
) -> None:
"""
:keyword key_vault_meta_info: The updated Key Vault key to use in user managed key rotation.
:paramtype key_vault_meta_info: ~azure.mgmt.datalake.store.models.UpdateKeyVaultMetaInfo
"""
super().__init__(**kwargs)
self.key_vault_meta_info = key_vault_meta_info
[docs]class UpdateFirewallRuleParameters(_serialization.Model):
"""The parameters used to update a firewall rule.
:ivar start_ip_address: The start IP address for the firewall rule. This can be either ipv4 or
ipv6. Start and End should be in the same protocol.
:vartype start_ip_address: str
:ivar end_ip_address: The end IP address for the firewall rule. This can be either ipv4 or
ipv6. Start and End should be in the same protocol.
:vartype end_ip_address: str
"""
_attribute_map = {
"start_ip_address": {"key": "properties.startIpAddress", "type": "str"},
"end_ip_address": {"key": "properties.endIpAddress", "type": "str"},
}
def __init__(
self, *, start_ip_address: Optional[str] = None, end_ip_address: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword start_ip_address: The start IP address for the firewall rule. This can be either ipv4
or ipv6. Start and End should be in the same protocol.
:paramtype start_ip_address: str
:keyword end_ip_address: The end IP address for the firewall rule. This can be either ipv4 or
ipv6. Start and End should be in the same protocol.
:paramtype end_ip_address: str
"""
super().__init__(**kwargs)
self.start_ip_address = start_ip_address
self.end_ip_address = end_ip_address
[docs]class UpdateFirewallRuleWithAccountParameters(_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.
:ivar name: The unique name of the firewall rule to update. Required.
:vartype name: str
:ivar start_ip_address: The start IP address for the firewall rule. This can be either ipv4 or
ipv6. Start and End should be in the same protocol.
:vartype start_ip_address: str
:ivar end_ip_address: The end IP address for the firewall rule. This can be either ipv4 or
ipv6. Start and End should be in the same protocol.
:vartype end_ip_address: str
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"start_ip_address": {"key": "properties.startIpAddress", "type": "str"},
"end_ip_address": {"key": "properties.endIpAddress", "type": "str"},
}
def __init__(
self, *, name: str, start_ip_address: Optional[str] = None, end_ip_address: Optional[str] = None, **kwargs: Any
) -> None:
"""
:keyword name: The unique name of the firewall rule to update. Required.
:paramtype name: str
:keyword start_ip_address: The start IP address for the firewall rule. This can be either ipv4
or ipv6. Start and End should be in the same protocol.
:paramtype start_ip_address: str
:keyword end_ip_address: The end IP address for the firewall rule. This can be either ipv4 or
ipv6. Start and End should be in the same protocol.
:paramtype end_ip_address: str
"""
super().__init__(**kwargs)
self.name = name
self.start_ip_address = start_ip_address
self.end_ip_address = end_ip_address
[docs]class UpdateTrustedIdProviderParameters(_serialization.Model):
"""The parameters used to update a trusted identity provider.
:ivar id_provider: The URL of this trusted identity provider.
:vartype id_provider: str
"""
_attribute_map = {
"id_provider": {"key": "properties.idProvider", "type": "str"},
}
def __init__(self, *, id_provider: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword id_provider: The URL of this trusted identity provider.
:paramtype id_provider: str
"""
super().__init__(**kwargs)
self.id_provider = id_provider
[docs]class UpdateTrustedIdProviderWithAccountParameters(_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.
:ivar name: The unique name of the trusted identity provider to update. Required.
:vartype name: str
:ivar id_provider: The URL of this trusted identity provider.
:vartype id_provider: str
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"id_provider": {"key": "properties.idProvider", "type": "str"},
}
def __init__(self, *, name: str, id_provider: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword name: The unique name of the trusted identity provider to update. Required.
:paramtype name: str
:keyword id_provider: The URL of this trusted identity provider.
:paramtype id_provider: str
"""
super().__init__(**kwargs)
self.name = name
self.id_provider = id_provider
[docs]class UpdateVirtualNetworkRuleParameters(_serialization.Model):
"""The parameters used to update a virtual network rule.
:ivar subnet_id: The resource identifier for the subnet.
:vartype subnet_id: str
"""
_attribute_map = {
"subnet_id": {"key": "properties.subnetId", "type": "str"},
}
def __init__(self, *, subnet_id: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword subnet_id: The resource identifier for the subnet.
:paramtype subnet_id: str
"""
super().__init__(**kwargs)
self.subnet_id = subnet_id
[docs]class UpdateVirtualNetworkRuleWithAccountParameters(_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.
:ivar name: The unique name of the virtual network rule to update. Required.
:vartype name: str
:ivar subnet_id: The resource identifier for the subnet.
:vartype subnet_id: str
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"subnet_id": {"key": "properties.subnetId", "type": "str"},
}
def __init__(self, *, name: str, subnet_id: Optional[str] = None, **kwargs: Any) -> None:
"""
:keyword name: The unique name of the virtual network rule to update. Required.
:paramtype name: str
:keyword subnet_id: The resource identifier for the subnet.
:paramtype subnet_id: str
"""
super().__init__(**kwargs)
self.name = name
self.subnet_id = subnet_id
[docs]class Usage(_serialization.Model):
"""Describes the Resource Usage.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar unit: Gets the unit of measurement. Known values are: "Count", "Bytes", "Seconds",
"Percent", "CountsPerSecond", and "BytesPerSecond".
:vartype unit: str or ~azure.mgmt.datalake.store.models.UsageUnit
:ivar id: Resource identifier.
:vartype id: str
:ivar current_value: Gets the current count of the allocated resources in the subscription.
:vartype current_value: int
:ivar limit: Gets the maximum count of the resources that can be allocated in the subscription.
:vartype limit: int
:ivar name: Gets the name of the type of usage.
:vartype name: ~azure.mgmt.datalake.store.models.UsageName
"""
_validation = {
"unit": {"readonly": True},
"id": {"readonly": True},
"current_value": {"readonly": True},
"limit": {"readonly": True},
"name": {"readonly": True},
}
_attribute_map = {
"unit": {"key": "unit", "type": "str"},
"id": {"key": "id", "type": "str"},
"current_value": {"key": "currentValue", "type": "int"},
"limit": {"key": "limit", "type": "int"},
"name": {"key": "name", "type": "UsageName"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.unit = None
self.id = None
self.current_value = None
self.limit = None
self.name = None
[docs]class UsageListResult(_serialization.Model):
"""The response from the List Usages operation.
:ivar value: Gets or sets the list of Storage Resource Usages.
:vartype value: list[~azure.mgmt.datalake.store.models.Usage]
"""
_attribute_map = {
"value": {"key": "value", "type": "[Usage]"},
}
def __init__(self, *, value: Optional[List["_models.Usage"]] = None, **kwargs: Any) -> None:
"""
:keyword value: Gets or sets the list of Storage Resource Usages.
:paramtype value: list[~azure.mgmt.datalake.store.models.Usage]
"""
super().__init__(**kwargs)
self.value = value
[docs]class UsageName(_serialization.Model):
"""The usage names that can be used.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar value: Gets a string describing the resource name.
:vartype value: str
:ivar localized_value: Gets a localized string describing the resource name.
:vartype localized_value: str
"""
_validation = {
"value": {"readonly": True},
"localized_value": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "str"},
"localized_value": {"key": "localizedValue", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.localized_value = None
[docs]class VirtualNetworkRule(SubResource):
"""Data Lake Store virtual network rule information.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The resource identifier.
:vartype id: str
:ivar name: The resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar subnet_id: The resource identifier for the subnet.
:vartype subnet_id: str
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True},
"type": {"readonly": True},
"subnet_id": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"subnet_id": {"key": "properties.subnetId", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.subnet_id = None
[docs]class VirtualNetworkRuleListResult(_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.
:ivar value: The results of the list operation.
:vartype value: list[~azure.mgmt.datalake.store.models.VirtualNetworkRule]
:ivar next_link: The link (url) to the next page of results.
:vartype next_link: str
"""
_validation = {
"value": {"readonly": True},
"next_link": {"readonly": True},
}
_attribute_map = {
"value": {"key": "value", "type": "[VirtualNetworkRule]"},
"next_link": {"key": "nextLink", "type": "str"},
}
def __init__(self, **kwargs: Any) -> None:
""" """
super().__init__(**kwargs)
self.value = None
self.next_link = None