StorageAccountsOperations Class
StorageAccountsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectStorageAccountsOperations
Constructor
StorageAccountsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| begin_create |
Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed. |
| check_name_availability |
Checks that the storage account name is valid and is not already in use. |
| create_or_update_management_policies |
Sets the data policy rules associated with the specified storage account. |
| delete |
Deletes a storage account in Microsoft Azure. |
| delete_management_policies |
Deletes the data policy rules associated with the specified storage account. |
| get_management_policies |
Gets the data policy rules associated with the specified storage account. |
| get_properties |
Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys. |
| list |
Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this. |
| list_account_sas |
List SAS credentials of a storage account. |
| list_by_resource_group |
Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this. |
| list_keys |
Lists the access keys for the specified storage account. |
| list_service_sas |
List service SAS credentials of a specific resource. |
| regenerate_key |
Regenerates one of the access keys for the specified storage account. |
| update |
The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation. |
begin_create
Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.
begin_create(resource_group_name: str, account_name: str, parameters: azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountCreateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccount]Parameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- parameters
- StorageAccountCreateParameters
The parameters to provide for the created account.
- 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 StorageAccount or the result of cls(response)
Return type
Exceptions
check_name_availability
Checks that the storage account name is valid and is not already in use.
check_name_availability(account_name: azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountCheckNameAvailabilityParameters, **kwargs: Any) -> azure.mgmt.storage.v2018_03_01_preview.models._models_py3.CheckNameAvailabilityResultParameters
- account_name
- StorageAccountCheckNameAvailabilityParameters
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CheckNameAvailabilityResult, or the result of cls(response)
Return type
Exceptions
create_or_update_management_policies
Sets the data policy rules associated with the specified storage account.
create_or_update_management_policies(resource_group_name: str, account_name: str, management_policy_name: Union[str, azure.mgmt.storage.v2018_03_01_preview.models._storage_management_client_enums.ManagementPolicyName], properties: azure.mgmt.storage.v2018_03_01_preview.models._models_py3.ManagementPoliciesRulesSetParameter, **kwargs: Any) -> azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountManagementPoliciesParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- management_policy_name
- str or ManagementPolicyName
The name of the Storage Account Management Policy. It should always be 'default'.
- properties
- ManagementPoliciesRulesSetParameter
The data policy rules to set to a storage account.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StorageAccountManagementPolicies, or the result of cls(response)
Return type
Exceptions
delete
Deletes a storage account in Microsoft Azure.
delete(resource_group_name: str, account_name: str, **kwargs: Any) -> NoneParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
delete_management_policies
Deletes the data policy rules associated with the specified storage account.
delete_management_policies(resource_group_name: str, account_name: str, management_policy_name: Union[str, azure.mgmt.storage.v2018_03_01_preview.models._storage_management_client_enums.ManagementPolicyName], **kwargs: Any) -> NoneParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- management_policy_name
- str or ManagementPolicyName
The name of the Storage Account Management Policy. It should always be 'default'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
None, or the result of cls(response)
Return type
Exceptions
get_management_policies
Gets the data policy rules associated with the specified storage account.
get_management_policies(resource_group_name: str, account_name: str, management_policy_name: Union[str, azure.mgmt.storage.v2018_03_01_preview.models._storage_management_client_enums.ManagementPolicyName], **kwargs: Any) -> azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountManagementPoliciesParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- management_policy_name
- str or ManagementPolicyName
The name of the Storage Account Management Policy. It should always be 'default'.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StorageAccountManagementPolicies, or the result of cls(response)
Return type
Exceptions
get_properties
Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.
get_properties(resource_group_name: str, account_name: str, **kwargs: Any) -> azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StorageAccount, or the result of cls(response)
Return type
Exceptions
list
Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.
list(**kwargs: Any) -> Iterable[azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StorageAccountListResult or the result of cls(response)
Return type
Exceptions
list_account_sas
List SAS credentials of a storage account.
list_account_sas(resource_group_name: str, account_name: str, parameters: azure.mgmt.storage.v2018_03_01_preview.models._models_py3.AccountSasParameters, **kwargs: Any) -> azure.mgmt.storage.v2018_03_01_preview.models._models_py3.ListAccountSasResponseParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- parameters
- AccountSasParameters
The parameters to provide to list SAS credentials for the storage account.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ListAccountSasResponse, or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountListResult]Parameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either StorageAccountListResult or the result of cls(response)
Return type
Exceptions
list_keys
Lists the access keys for the specified storage account.
list_keys(resource_group_name: str, account_name: str, **kwargs: Any) -> azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountListKeysResultParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StorageAccountListKeysResult, or the result of cls(response)
Return type
Exceptions
list_service_sas
List service SAS credentials of a specific resource.
list_service_sas(resource_group_name: str, account_name: str, parameters: azure.mgmt.storage.v2018_03_01_preview.models._models_py3.ServiceSasParameters, **kwargs: Any) -> azure.mgmt.storage.v2018_03_01_preview.models._models_py3.ListServiceSasResponseParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ListServiceSasResponse, or the result of cls(response)
Return type
Exceptions
regenerate_key
Regenerates one of the access keys for the specified storage account.
regenerate_key(resource_group_name: str, account_name: str, regenerate_key: azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountRegenerateKeyParameters, **kwargs: Any) -> azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountListKeysResultParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- regenerate_key
- StorageAccountRegenerateKeyParameters
Specifies name of the key which should be regenerated – key1 or key2.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StorageAccountListKeysResult, or the result of cls(response)
Return type
Exceptions
update
The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.
update(resource_group_name: str, account_name: str, parameters: azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountUpdateParameters, **kwargs: Any) -> azure.mgmt.storage.v2018_03_01_preview.models._models_py3.StorageAccountParameters
- resource_group_name
- str
The name of the resource group within the user's subscription. The name is case insensitive.
- account_name
- str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- parameters
- StorageAccountUpdateParameters
The parameters to provide for the updated account.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
StorageAccount, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.storage.v2018_03_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\storage\\v2018_03_01_preview\\models\\__init__.py'>Feedback
Submit and view feedback for