azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations
name: DatabaseAccountsOperations
fullName: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations
module: azure.mgmt.cosmosdb.aio.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.cosmosdb.aio.CosmosDBManagementClient>'s\n\
  >\n> <xref:database_accounts> attribute.\n>"
constructor:
  syntax: DatabaseAccountsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.begin_create_or_update
  name: begin_create_or_update
  summary: 'Creates or updates an Azure Cosmos DB database account. The "Update" method
    is preferred when

    performing updates on an account.'
  signature: 'async begin_create_or_update(resource_group_name: str, account_name:
    str, create_update_parameters: _models.DatabaseAccountCreateUpdateParameters,
    *, content_type: str = ''application/json'', **kwargs: Any) -> AsyncLROPoller[_models.DatabaseAccountGetResults]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: create_update_parameters
    description: 'The parameters to provide for the current database account. Is

      either a DatabaseAccountCreateUpdateParameters type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.cosmosdb.models.DatabaseAccountCreateUpdateParameters>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of AsyncLROPoller that returns either DatabaseAccountGetResults
      or the

      result of cls(response)'
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:azure.mgmt.cosmosdb.models.DatabaseAccountGetResults>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.begin_delete
  name: begin_delete
  summary: Deletes an existing Azure Cosmos DB database account.
  signature: 'async begin_delete(resource_group_name: str, account_name: str, **kwargs:
    Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.begin_failover_priority_change
  name: begin_failover_priority_change
  summary: 'Changes the failover priority for the Azure Cosmos DB database account.
    A failover priority of

    0 indicates a write region. The maximum value for a failover priority = (total
    number of

    regions - 1). Failover priority values must be unique for each of the regions
    in which the

    database account exists.'
  signature: 'async begin_failover_priority_change(resource_group_name: str, account_name:
    str, failover_parameters: _models.FailoverPolicies, *, content_type: str = ''application/json'',
    **kwargs: Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: failover_parameters
    description: 'The new failover policies for the database account. Is either a

      FailoverPolicies type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.cosmosdb.models.FailoverPolicies>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.begin_offline_region
  name: begin_offline_region
  summary: Offline the specified region for the specified Azure Cosmos DB database
    account.
  signature: 'async begin_offline_region(resource_group_name: str, account_name: str,
    region_parameter_for_offline: _models.RegionForOnlineOffline, *, content_type:
    str = ''application/json'', **kwargs: Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: region_parameter_for_offline
    description: 'Cosmos DB region to offline for the database account. Is

      either a RegionForOnlineOffline type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.cosmosdb.models.RegionForOnlineOffline>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.begin_online_region
  name: begin_online_region
  summary: Online the specified region for the specified Azure Cosmos DB database
    account.
  signature: 'async begin_online_region(resource_group_name: str, account_name: str,
    region_parameter_for_online: _models.RegionForOnlineOffline, *, content_type:
    str = ''application/json'', **kwargs: Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: region_parameter_for_online
    description: 'Cosmos DB region to online for the database account. Is

      either a RegionForOnlineOffline type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.cosmosdb.models.RegionForOnlineOffline>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.begin_regenerate_key
  name: begin_regenerate_key
  summary: Regenerates an access key for the specified Azure Cosmos DB database account.
  signature: 'async begin_regenerate_key(resource_group_name: str, account_name: str,
    key_to_regenerate: _models.DatabaseAccountRegenerateKeyParameters, *, content_type:
    str = ''application/json'', **kwargs: Any) -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: key_to_regenerate
    description: 'The name of the key to regenerate. Is either a

      DatabaseAccountRegenerateKeyParameters type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.cosmosdb.models.DatabaseAccountRegenerateKeyParameters>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.begin_update
  name: begin_update
  summary: Updates the properties of an existing Azure Cosmos DB database account.
  signature: 'async begin_update(resource_group_name: str, account_name: str, update_parameters:
    _models.DatabaseAccountUpdateParameters, *, content_type: str = ''application/json'',
    **kwargs: Any) -> AsyncLROPoller[_models.DatabaseAccountGetResults]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: update_parameters
    description: 'The parameters to provide for the current database account. Is either

      a DatabaseAccountUpdateParameters type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.cosmosdb.models.DatabaseAccountUpdateParameters>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: 'An instance of AsyncLROPoller that returns either DatabaseAccountGetResults
      or the

      result of cls(response)'
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:azure.mgmt.cosmosdb.models.DatabaseAccountGetResults>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.check_name_exists
  name: check_name_exists
  summary: 'Checks that the Azure Cosmos DB account name already exists. A valid account
    name may contain

    only lowercase letters, numbers, and the ''-'' character, and must be between
    3 and 50

    characters.'
  signature: 'async check_name_exists(account_name: str, **kwargs: Any) -> bool'
  parameters:
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: bool or the result of cls(response)
    types:
    - <xref:bool>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.get
  name: get
  summary: Retrieves the properties of an existing Azure Cosmos DB database account.
  signature: 'async get(resource_group_name: str, account_name: str, **kwargs: Any)
    -> DatabaseAccountGetResults'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: DatabaseAccountGetResults or the result of cls(response)
    types:
    - <xref:azure.mgmt.cosmosdb.models.DatabaseAccountGetResults>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.get_read_only_keys
  name: get_read_only_keys
  summary: Lists the read-only access keys for the specified Azure Cosmos DB database
    account.
  signature: 'async get_read_only_keys(resource_group_name: str, account_name: str,
    **kwargs: Any) -> DatabaseAccountListReadOnlyKeysResult'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: DatabaseAccountListReadOnlyKeysResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.cosmosdb.models.DatabaseAccountListReadOnlyKeysResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.list
  name: list
  summary: Lists all the Azure Cosmos DB database accounts available under the subscription.
  signature: 'list(**kwargs: Any) -> AsyncIterable[DatabaseAccountGetResults]'
  return:
    description: 'An iterator like instance of either DatabaseAccountGetResults or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.cosmosdb.models.DatabaseAccountGetResults>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.list_by_resource_group
  name: list_by_resource_group
  summary: Lists all the Azure Cosmos DB database accounts available under the given
    resource group.
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[DatabaseAccountGetResults]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: 'An iterator like instance of either DatabaseAccountGetResults or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.cosmosdb.models.DatabaseAccountGetResults>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.list_connection_strings
  name: list_connection_strings
  summary: Lists the connection strings for the specified Azure Cosmos DB database
    account.
  signature: 'async list_connection_strings(resource_group_name: str, account_name:
    str, **kwargs: Any) -> DatabaseAccountListConnectionStringsResult'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: DatabaseAccountListConnectionStringsResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.cosmosdb.models.DatabaseAccountListConnectionStringsResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.list_keys
  name: list_keys
  summary: Lists the access keys for the specified Azure Cosmos DB database account.
  signature: 'async list_keys(resource_group_name: str, account_name: str, **kwargs:
    Any) -> DatabaseAccountListKeysResult'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: DatabaseAccountListKeysResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.cosmosdb.models.DatabaseAccountListKeysResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.list_metric_definitions
  name: list_metric_definitions
  summary: Retrieves metric definitions for the given database account.
  signature: 'list_metric_definitions(resource_group_name: str, account_name: str,
    **kwargs: Any) -> AsyncIterable[MetricDefinition]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either MetricDefinition or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.cosmosdb.models.MetricDefinition>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.list_metrics
  name: list_metrics
  summary: Retrieves the metrics determined by the given filter for the given database
    account.
  signature: 'list_metrics(resource_group_name: str, account_name: str, filter: str,
    **kwargs: Any) -> AsyncIterable[Metric]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: 'An OData filter expression that describes a subset of metrics to
      return. The

      parameters that can be filtered are name.value (name of the metric, can have
      an or of multiple

      names), startTime, endTime, and timeGrain. The supported operator is eq. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either Metric or the result of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.cosmosdb.models.Metric>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.list_read_only_keys
  name: list_read_only_keys
  summary: Lists the read-only access keys for the specified Azure Cosmos DB database
    account.
  signature: 'async list_read_only_keys(resource_group_name: str, account_name: str,
    **kwargs: Any) -> DatabaseAccountListReadOnlyKeysResult'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: DatabaseAccountListReadOnlyKeysResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.cosmosdb.models.DatabaseAccountListReadOnlyKeysResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.list_usages
  name: list_usages
  summary: Retrieves the usages (most recent data) for the given database account.
  signature: 'list_usages(resource_group_name: str, account_name: str, filter: str
    | None = None, **kwargs: Any) -> AsyncIterable[Usage]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: Cosmos DB database account name. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: 'An OData filter expression that describes a subset of usages to
      return. The

      supported parameter is name.value (name of the metric, can have an or of multiple
      names).

      Default value is None.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either Usage or the result of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.cosmosdb.models.Usage>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.cosmosdb.aio.operations.DatabaseAccountsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>