azure.mgmt.datalake.store.operations module¶
-
class
azure.mgmt.datalake.store.operations.
AccountsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
DataLakeStoreAccountManagementClient
’saccounts
attribute.-
begin_create
(resource_group_name: str, account_name: str, parameters: _models.CreateDataLakeStoreAccountParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataLakeStoreAccount][source]¶ -
begin_create
(resource_group_name: str, account_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataLakeStoreAccount] Creates the specified Data Lake Store account.
- Parameters
resource_group_name (str) – The name of the Azure resource group. Required.
account_name (str) – The name of the Data Lake Store account. Required.
parameters (CreateDataLakeStoreAccountParameters or IO) – Parameters supplied to create the Data Lake Store account. Is either a CreateDataLakeStoreAccountParameters type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either DataLakeStoreAccount or the result of cls(response)
- Return type
- Raises
-
begin_delete
(resource_group_name: str, account_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes the specified Data Lake Store account.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
-
begin_update
(resource_group_name: str, account_name: str, parameters: _models.UpdateDataLakeStoreAccountParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataLakeStoreAccount][source]¶ -
begin_update
(resource_group_name: str, account_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DataLakeStoreAccount] Updates the specified Data Lake Store account information.
- Parameters
resource_group_name (str) – The name of the Azure resource group. Required.
account_name (str) – The name of the Data Lake Store account. Required.
parameters (UpdateDataLakeStoreAccountParameters or IO) – Parameters supplied to update the Data Lake Store account. Is either a UpdateDataLakeStoreAccountParameters type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of LROPoller that returns either DataLakeStoreAccount or the result of cls(response)
- Return type
- Raises
-
check_name_availability
(location: str, parameters: _models.CheckNameAvailabilityParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NameAvailabilityInformation[source]¶ -
check_name_availability
(location: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NameAvailabilityInformation Checks whether the specified account name is available or taken.
- Parameters
location (str) – The resource location without whitespace. Required.
parameters (CheckNameAvailabilityParameters or IO) – Parameters supplied to check the Data Lake Store account name availability. Is either a CheckNameAvailabilityParameters type or a IO type. Required.
- Keyword Arguments
- Returns
NameAvailabilityInformation or the result of cls(response)
- Return type
- Raises
-
enable_key_vault
(resource_group_name: str, account_name: str, **kwargs: Any) → None[source]¶ Attempts to enable a user managed Key Vault for encryption of the specified Data Lake Store account.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.datalake.store.models._models_py3.DataLakeStoreAccount[source]¶ Gets the specified Data Lake Store account.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DataLakeStoreAccount or the result of cls(response)
- Return type
- Raises
-
list
(filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, orderby: Optional[str] = None, count: Optional[bool] = None, **kwargs: Any) → Iterable[azure.mgmt.datalake.store.models._models_py3.DataLakeStoreAccountBasic][source]¶ Lists the Data Lake Store accounts within the subscription. The response includes a link to the next page of results, if any.
- Parameters
filter (str) – OData filter. Optional. Default value is None.
top (int) – The number of items to return. Optional. Default value is None.
skip (int) – The number of items to skip over before returning elements. Optional. Default value is None.
select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. Default value is None.
orderby (str) – OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. Default value is None.
count (bool) – The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either DataLakeStoreAccountBasic or the result of cls(response)
- Return type
- Raises
-
list_by_resource_group
(resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, select: Optional[str] = None, orderby: Optional[str] = None, count: Optional[bool] = None, **kwargs: Any) → Iterable[azure.mgmt.datalake.store.models._models_py3.DataLakeStoreAccountBasic][source]¶ Lists the Data Lake Store accounts within a specific resource group. The response includes a link to the next page of results, if any.
- Parameters
resource_group_name (str) – The name of the Azure resource group. Required.
filter (str) – OData filter. Optional. Default value is None.
top (int) – The number of items to return. Optional. Default value is None.
skip (int) – The number of items to skip over before returning elements. Optional. Default value is None.
select (str) – OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. Default value is None.
orderby (str) – OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional. Default value is None.
count (bool) – A Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional. Default value is None.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either DataLakeStoreAccountBasic or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.datalake.store.models' from '/mnt/vss/_work/1/s/sdk/datalake/azure-mgmt-datalake-store/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datalake/store/models/__init__.py'>¶
-
-
class
azure.mgmt.datalake.store.operations.
FirewallRulesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
DataLakeStoreAccountManagementClient
’sfirewall_rules
attribute.-
create_or_update
(resource_group_name: str, account_name: str, firewall_rule_name: str, parameters: _models.CreateOrUpdateFirewallRuleParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.FirewallRule[source]¶ -
create_or_update
(resource_group_name: str, account_name: str, firewall_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.FirewallRule Creates or updates the specified firewall rule. During update, the firewall rule with the specified name will be replaced with this new firewall rule.
- Parameters
resource_group_name (str) – The name of the Azure resource group. Required.
account_name (str) – The name of the Data Lake Store account. Required.
firewall_rule_name (str) – The name of the firewall rule to create or update. Required.
parameters (CreateOrUpdateFirewallRuleParameters or IO) – Parameters supplied to create or update the firewall rule. Is either a CreateOrUpdateFirewallRuleParameters type or a IO type. Required.
- Keyword Arguments
- Returns
FirewallRule or the result of cls(response)
- Return type
- Raises
-
delete
(resource_group_name: str, account_name: str, firewall_rule_name: str, **kwargs: Any) → None[source]¶ Deletes the specified firewall rule from the specified Data Lake Store account.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, account_name: str, firewall_rule_name: str, **kwargs: Any) → azure.mgmt.datalake.store.models._models_py3.FirewallRule[source]¶ Gets the specified Data Lake Store firewall rule.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
FirewallRule or the result of cls(response)
- Return type
- Raises
-
list_by_account
(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.datalake.store.models._models_py3.FirewallRule][source]¶ Lists the Data Lake Store firewall rules within the specified Data Lake Store account.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either FirewallRule or the result of cls(response)
- Return type
- Raises
-
update
(resource_group_name: str, account_name: str, firewall_rule_name: str, parameters: Optional[_models.UpdateFirewallRuleParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.FirewallRule[source]¶ -
update
(resource_group_name: str, account_name: str, firewall_rule_name: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.FirewallRule Updates the specified firewall rule.
- Parameters
resource_group_name (str) – The name of the Azure resource group. Required.
account_name (str) – The name of the Data Lake Store account. Required.
firewall_rule_name (str) – The name of the firewall rule to update. Required.
parameters (UpdateFirewallRuleParameters or IO) – Parameters supplied to update the firewall rule. Is either a UpdateFirewallRuleParameters type or a IO type. Default value is None.
- Keyword Arguments
- Returns
FirewallRule or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.datalake.store.models' from '/mnt/vss/_work/1/s/sdk/datalake/azure-mgmt-datalake-store/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datalake/store/models/__init__.py'>¶
-
-
class
azure.mgmt.datalake.store.operations.
LocationsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
DataLakeStoreAccountManagementClient
’slocations
attribute.-
get_capability
(location: str, **kwargs: Any) → Optional[azure.mgmt.datalake.store.models._models_py3.CapabilityInformation][source]¶ Gets subscription-level properties and limits for Data Lake Store specified by resource location.
-
get_usage
(location: str, **kwargs: Any) → Iterable[azure.mgmt.datalake.store.models._models_py3.Usage][source]¶ Gets the current usage count and the limit for the resources of the location under the subscription.
-
models
= <module 'azure.mgmt.datalake.store.models' from '/mnt/vss/_work/1/s/sdk/datalake/azure-mgmt-datalake-store/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datalake/store/models/__init__.py'>¶
-
-
class
azure.mgmt.datalake.store.operations.
Operations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
DataLakeStoreAccountManagementClient
’soperations
attribute.-
list
(**kwargs: Any) → azure.mgmt.datalake.store.models._models_py3.OperationListResult[source]¶ Lists all of the available Data Lake Store REST API operations.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
OperationListResult or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.datalake.store.models' from '/mnt/vss/_work/1/s/sdk/datalake/azure-mgmt-datalake-store/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datalake/store/models/__init__.py'>¶
-
-
class
azure.mgmt.datalake.store.operations.
TrustedIdProvidersOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
DataLakeStoreAccountManagementClient
’strusted_id_providers
attribute.-
create_or_update
(resource_group_name: str, account_name: str, trusted_id_provider_name: str, parameters: _models.CreateOrUpdateTrustedIdProviderParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TrustedIdProvider[source]¶ -
create_or_update
(resource_group_name: str, account_name: str, trusted_id_provider_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TrustedIdProvider Creates or updates the specified trusted identity provider. During update, the trusted identity provider with the specified name will be replaced with this new provider.
- Parameters
resource_group_name (str) – The name of the Azure resource group. Required.
account_name (str) – The name of the Data Lake Store account. Required.
trusted_id_provider_name (str) – The name of the trusted identity provider. This is used for differentiation of providers in the account. Required.
parameters (CreateOrUpdateTrustedIdProviderParameters or IO) – Parameters supplied to create or replace the trusted identity provider. Is either a CreateOrUpdateTrustedIdProviderParameters type or a IO type. Required.
- Keyword Arguments
- Returns
TrustedIdProvider or the result of cls(response)
- Return type
- Raises
-
delete
(resource_group_name: str, account_name: str, trusted_id_provider_name: str, **kwargs: Any) → None[source]¶ Deletes the specified trusted identity provider from the specified Data Lake Store account.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, account_name: str, trusted_id_provider_name: str, **kwargs: Any) → azure.mgmt.datalake.store.models._models_py3.TrustedIdProvider[source]¶ Gets the specified Data Lake Store trusted identity provider.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
TrustedIdProvider or the result of cls(response)
- Return type
- Raises
-
list_by_account
(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.datalake.store.models._models_py3.TrustedIdProvider][source]¶ Lists the Data Lake Store trusted identity providers within the specified Data Lake Store account.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either TrustedIdProvider or the result of cls(response)
- Return type
- Raises
-
update
(resource_group_name: str, account_name: str, trusted_id_provider_name: str, parameters: Optional[_models.UpdateTrustedIdProviderParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TrustedIdProvider[source]¶ -
update
(resource_group_name: str, account_name: str, trusted_id_provider_name: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TrustedIdProvider Updates the specified trusted identity provider.
- Parameters
resource_group_name (str) – The name of the Azure resource group. Required.
account_name (str) – The name of the Data Lake Store account. Required.
trusted_id_provider_name (str) – The name of the trusted identity provider. This is used for differentiation of providers in the account. Required.
parameters (UpdateTrustedIdProviderParameters or IO) – Parameters supplied to update the trusted identity provider. Is either a UpdateTrustedIdProviderParameters type or a IO type. Default value is None.
- Keyword Arguments
- Returns
TrustedIdProvider or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.datalake.store.models' from '/mnt/vss/_work/1/s/sdk/datalake/azure-mgmt-datalake-store/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datalake/store/models/__init__.py'>¶
-
-
class
azure.mgmt.datalake.store.operations.
VirtualNetworkRulesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
DataLakeStoreAccountManagementClient
’svirtual_network_rules
attribute.-
create_or_update
(resource_group_name: str, account_name: str, virtual_network_rule_name: str, parameters: _models.CreateOrUpdateVirtualNetworkRuleParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.VirtualNetworkRule[source]¶ -
create_or_update
(resource_group_name: str, account_name: str, virtual_network_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.VirtualNetworkRule Creates or updates the specified virtual network rule. During update, the virtual network rule with the specified name will be replaced with this new virtual network rule.
- Parameters
resource_group_name (str) – The name of the Azure resource group. Required.
account_name (str) – The name of the Data Lake Store account. Required.
virtual_network_rule_name (str) – The name of the virtual network rule to create or update. Required.
parameters (CreateOrUpdateVirtualNetworkRuleParameters or IO) – Parameters supplied to create or update the virtual network rule. Is either a CreateOrUpdateVirtualNetworkRuleParameters type or a IO type. Required.
- Keyword Arguments
- Returns
VirtualNetworkRule or the result of cls(response)
- Return type
- Raises
-
delete
(resource_group_name: str, account_name: str, virtual_network_rule_name: str, **kwargs: Any) → None[source]¶ Deletes the specified virtual network rule from the specified Data Lake Store account.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None or the result of cls(response)
- Return type
- Raises
-
get
(resource_group_name: str, account_name: str, virtual_network_rule_name: str, **kwargs: Any) → azure.mgmt.datalake.store.models._models_py3.VirtualNetworkRule[source]¶ Gets the specified Data Lake Store virtual network rule.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VirtualNetworkRule or the result of cls(response)
- Return type
- Raises
-
list_by_account
(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[azure.mgmt.datalake.store.models._models_py3.VirtualNetworkRule][source]¶ Lists the Data Lake Store virtual network rules within the specified Data Lake Store account.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either VirtualNetworkRule or the result of cls(response)
- Return type
- Raises
-
update
(resource_group_name: str, account_name: str, virtual_network_rule_name: str, parameters: Optional[_models.UpdateVirtualNetworkRuleParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.VirtualNetworkRule[source]¶ -
update
(resource_group_name: str, account_name: str, virtual_network_rule_name: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.VirtualNetworkRule Updates the specified virtual network rule.
- Parameters
resource_group_name (str) – The name of the Azure resource group. Required.
account_name (str) – The name of the Data Lake Store account. Required.
virtual_network_rule_name (str) – The name of the virtual network rule to update. Required.
parameters (UpdateVirtualNetworkRuleParameters or IO) – Parameters supplied to update the virtual network rule. Is either a UpdateVirtualNetworkRuleParameters type or a IO type. Default value is None.
- Keyword Arguments
- Returns
VirtualNetworkRule or the result of cls(response)
- Return type
- Raises
-
models
= <module 'azure.mgmt.datalake.store.models' from '/mnt/vss/_work/1/s/sdk/datalake/azure-mgmt-datalake-store/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/datalake/store/models/__init__.py'>¶
-