Throughput Pool Account - Create

Serviço:

Cosmos DB Resource Provider

Versão da API:

2025-05-01-preview

Cria ou atualiza uma conta do ThroughputPool do Azure Cosmos DB. O método "Update" é preferencial ao executar atualizações em uma conta.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/throughputPools/{throughputPoolName}/throughputPoolAccounts/{throughputPoolAccountName}?api-version=2025-05-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
throughputPoolAccountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Conta de banco de dados global do Cosmos DB em um pool de taxa de transferência
throughputPoolName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nome do Pool de Taxa de Transferência do Cosmos DB.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.accountLocation	string	O local da conta de banco de dados global no throughputPool.
properties.accountResourceIdentifier	string	O identificador de recurso da conta de banco de dados global no throughputPool.

Respostas

Nome	Tipo	Description
200 OK	ThroughputPoolAccountResource	O recurso de conta do Pool de Taxa de Transferência foi recuperado com êxito.
201 Created	ThroughputPoolAccountResource	A conta do pool de taxa de transferência está sendo criada ou atualizada de forma assíncrona. Sondagem para status=Bem-sucedido para localizar quando a operação for concluída.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	Assumir a identidade da sua conta de usuário

Exemplos

CosmosDB ThroughputPool Account Create

Solicitação de exemplo

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1/throughputPoolAccounts/db1?api-version=2025-05-01-preview

{
  "properties": {
    "accountLocation": "West US",
    "accountResourceIdentifier": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DocumentDB/resourceGroup/rg1/databaseAccounts/db1/"
  }
}

Resposta de exemplo

Código de status:

200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1/throughputPoolAccounts/db1",
  "properties": {
    "provisioningState": "Succeeded",
    "accountResourceIdentifier": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/db1",
    "accountLocation": "west us",
    "accountInstanceId": "{instance-id1}"
  }
}

Código de status:

201

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/throughputPools/tp1/throughputPoolAccounts/db1",
  "properties": {
    "provisioningState": "Succeeded",
    "accountResourceIdentifier": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/db1",
    "accountLocation": "west us",
    "accountInstanceId": "{instance-id1}"
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
status	Um estado de provisionamento do ThroughputPool.
systemData	Metadados relativos à criação e última modificação do recurso.
ThroughputPoolAccountResource	Uma conta de taxa de transferência do Azure Cosmos DB

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

status

Enumeração

Um estado de provisionamento do ThroughputPool.

Valor	Description
Canceled
Failed
Succeeded
Updating

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

ThroughputPoolAccountResource

Objeto

Uma conta de taxa de transferência do Azure Cosmos DB

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.accountInstanceId	string	A ID da instância da conta de banco de dados global no throughputPool.
properties.accountLocation	string	O local da conta de banco de dados global no throughputPool.
properties.accountResourceIdentifier	string	O identificador de recurso da conta de banco de dados global no throughputPool.
properties.provisioningState	status	Um estado de provisionamento da conta de ThroughputPool.
systemData	systemData	Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"