azure.mgmt.storage.v2017_10_01.operations module¶
-
class
azure.mgmt.storage.v2017_10_01.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client Api Version. Constant value: “2017-10-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the available Storage Rest API operations.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Operation
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.storage.v2017_10_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storage/v2017_10_01/models/__init__.py'>¶
-
class
azure.mgmt.storage.v2017_10_01.operations.
SkusOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SkusOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client Api Version. Constant value: “2017-10-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists the available SKUs supported by Microsoft.Storage for given subscription.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Sku
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.storage.v2017_10_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storage/v2017_10_01/models/__init__.py'>¶
-
class
azure.mgmt.storage.v2017_10_01.operations.
StorageAccountsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
StorageAccountsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client Api Version. Constant value: “2017-10-01”.
-
check_name_availability
(name, custom_headers=None, raw=False, **operation_config)[source]¶ Checks that the storage account name is valid and is not already in use.
Parameters: - name (str) – The storage account name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: CheckNameAvailabilityResult or ClientRawResponse if raw=true
Return type: CheckNameAvailabilityResult or ClientRawResponse
Raises: CloudError
-
create
(resource_group_name, account_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ 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.
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.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns StorageAccount or ClientRawResponse<StorageAccount> if raw==True
Return type: AzureOperationPoller[StorageAccount] or AzureOperationPoller[ClientRawResponse[StorageAccount]]
Raises: CloudError
-
delete
(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a storage account in Microsoft Azure.
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.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises: CloudError
-
get_properties
(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶ 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.
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.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StorageAccount or ClientRawResponse if raw=true
Return type: StorageAccount or ClientRawResponse
Raises: CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of StorageAccount
Return type: Raises: CloudError
-
list_account_sas
(resource_group_name, account_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ List SAS credentials of a storage account.
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 (AccountSasParameters) – The parameters to provide to list SAS credentials for the storage account.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ListAccountSasResponse or ClientRawResponse if raw=true
Return type: ListAccountSasResponse or ClientRawResponse
Raises: CloudError
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.
Parameters: - resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of StorageAccount
Return type: Raises: CloudError
-
list_keys
(resource_group_name, account_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the access keys for the specified storage account.
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.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StorageAccountListKeysResult or ClientRawResponse if raw=true
Return type: StorageAccountListKeysResult or ClientRawResponse
Raises: CloudError
-
list_service_sas
(resource_group_name, account_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ List service SAS credentials of a specific resource.
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 (ServiceSasParameters) – The parameters to provide to list service SAS credentials.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: ListServiceSasResponse or ClientRawResponse if raw=true
Return type: ListServiceSasResponse or ClientRawResponse
Raises: CloudError
-
regenerate_key
(resource_group_name, account_name, key_name, custom_headers=None, raw=False, **operation_config)[source]¶ Regenerates one of the access keys for the specified storage account.
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.
- key_name (str) – The name of storage keys that want to be regenerated, possible vaules are key1, key2.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StorageAccountListKeysResult or ClientRawResponse if raw=true
Return type: StorageAccountListKeysResult or ClientRawResponse
Raises: CloudError
-
update
(resource_group_name, account_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ 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.
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 (StorageAccountUpdateParameters) – The parameters to provide for the updated account.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: StorageAccount or ClientRawResponse if raw=true
Return type: StorageAccount or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.storage.v2017_10_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storage/v2017_10_01/models/__init__.py'>¶
-
class
azure.mgmt.storage.v2017_10_01.operations.
UsageOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
UsageOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Client Api Version. Constant value: “2017-10-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets the current usage count and the limit for the resources under the subscription.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Usage
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.storage.v2017_10_01.models' from '/usr/lib/python3/dist-packages/azure/mgmt/storage/v2017_10_01/models/__init__.py'>¶