azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations
name: StorageAccountsOperations
fullName: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations
module: azure.mgmt.storage.v2018_07_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.storage.v2018_07_01.StorageManagementClient>'s\n\
  >\n> <xref:storage_accounts> attribute.\n>"
constructor:
  syntax: StorageAccountsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.begin_create
  name: begin_create
  summary: '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.'
  signature: 'begin_create(resource_group_name: str, account_name: str, parameters:
    _models.StorageAccountCreateParameters, *, content_type: str = ''application/json'',
    **kwargs: Any) -> LROPoller[_models.StorageAccount]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The parameters to provide for the created account. Is either a

      StorageAccountCreateParameters type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.StorageAccountCreateParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: 'Default waiting time between two polls for LRO operations if no

      Retry-After header is present.'
    types:
    - <xref:int>
  return:
    description: 'An instance of LROPoller that returns either StorageAccount or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.storage.v2018_07_01.models.StorageAccount>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.begin_failover
  name: begin_failover
  summary: 'Failover request can be triggered for a storage account in case of availability
    issues. The

    failover occurs from the storage account''s primary cluster to secondary cluster
    for RA-GRS

    accounts. The secondary cluster will become primary after failover.'
  signature: 'begin_failover(resource_group_name: str, account_name: str, **kwargs:
    Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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. Required.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: 'Default waiting time between two polls for LRO operations if no

      Retry-After header is present.'
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.check_name_availability
  name: check_name_availability
  summary: Checks that the storage account name is valid and is not already in use.
  signature: 'check_name_availability(account_name: _models.StorageAccountCheckNameAvailabilityParameters,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.CheckNameAvailabilityResult'
  parameters:
  - name: account_name
    description: '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. Is either a StorageAccountCheckNameAvailabilityParameters
      type or a IO

      type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.StorageAccountCheckNameAvailabilityParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: CheckNameAvailabilityResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.CheckNameAvailabilityResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.delete
  name: delete
  summary: Deletes a storage account in Microsoft Azure.
  signature: 'delete(resource_group_name: str, account_name: str, **kwargs: Any) ->
    None'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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. Required.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.get_properties
  name: get_properties
  summary: '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.'
  signature: 'get_properties(resource_group_name: str, account_name: str, expand:
    Literal[''geoReplicationStats''] = ''geoReplicationStats'', **kwargs: Any) ->
    StorageAccount'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: expand
    description: 'May be used to expand the properties within account''s properties.
      By default,

      data is not included when fetching properties. Currently we only support geoReplicationStats.

      Known values are "geoReplicationStats" and None. Default value is "geoReplicationStats".'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StorageAccount or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.StorageAccount>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.list
  name: list
  summary: 'Lists all the storage accounts available under the subscription. Note
    that storage keys are not

    returned; use the ListKeys operation for this.'
  signature: 'list(**kwargs: Any) -> Iterable[StorageAccount]'
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either StorageAccount or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.storage.v2018_07_01.models.StorageAccount>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.list_account_sas
  name: list_account_sas
  summary: List SAS credentials of a storage account.
  signature: 'list_account_sas(resource_group_name: str, account_name: str, parameters:
    _models.AccountSasParameters, *, content_type: str = ''application/json'', **kwargs:
    Any) -> _models.ListAccountSasResponse'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The parameters to provide to list SAS credentials for the storage
      account.

      Is either a AccountSasParameters type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.AccountSasParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ListAccountSasResponse or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.ListAccountSasResponse>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.list_by_resource_group
  name: list_by_resource_group
  summary: 'Lists all the storage accounts available under the given resource group.
    Note that storage keys

    are not returned; use the ListKeys operation for this.'
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[StorageAccount]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either StorageAccount or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.storage.v2018_07_01.models.StorageAccount>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.list_keys
  name: list_keys
  summary: Lists the access keys for the specified storage account.
  signature: 'list_keys(resource_group_name: str, account_name: str, **kwargs: Any)
    -> StorageAccountListKeysResult'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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. Required.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StorageAccountListKeysResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.StorageAccountListKeysResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.list_service_sas
  name: list_service_sas
  summary: List service SAS credentials of a specific resource.
  signature: 'list_service_sas(resource_group_name: str, account_name: str, parameters:
    _models.ServiceSasParameters, *, content_type: str = ''application/json'', **kwargs:
    Any) -> _models.ListServiceSasResponse'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The parameters to provide to list service SAS credentials. Is either
      a

      ServiceSasParameters type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.ServiceSasParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ListServiceSasResponse or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.ListServiceSasResponse>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.regenerate_key
  name: regenerate_key
  summary: Regenerates one of the access keys for the specified storage account.
  signature: 'regenerate_key(resource_group_name: str, account_name: str, regenerate_key:
    _models.StorageAccountRegenerateKeyParameters, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.StorageAccountListKeysResult'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: regenerate_key
    description: "Specifies name of the key which should be regenerated \u2013 key1\
      \ or key2.\nIs either a StorageAccountRegenerateKeyParameters type or a IO type.\
      \ Required."
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.StorageAccountRegenerateKeyParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StorageAccountListKeysResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.StorageAccountListKeysResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.update
  name: update
  summary: '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.'
  signature: 'update(resource_group_name: str, account_name: str, parameters: _models.StorageAccountUpdateParameters,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.StorageAccount'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The parameters to provide for the updated account. Is either a

      StorageAccountUpdateParameters type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.StorageAccountUpdateParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: StorageAccount or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2018_07_01.models.StorageAccount>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.storage.v2018_07_01.operations.StorageAccountsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.storage.v2018_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2018_07_01\\models\\__init__.py'>