Database Accounts - Update

Referência

Serviço:: Cosmos DB Resource Provider

Versão da API:: 2024-11-15

Atualiza as propriedades de uma conta de banco de dados existente do Azure Cosmos DB.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}?api-version=2024-11-15

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	Nome da conta do banco de dados do Cosmos DB. Padrão Regex: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
identity	ManagedServiceIdentity	Identidade do recurso.
location	string	O local do grupo de recursos ao qual o recurso pertence.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Propriedades específicas de armazenamento analítico.
properties.apiProperties	ApiProperties	Propriedades específicas da API. Atualmente, suportado apenas para a API do MongoDB.
properties.backupPolicy	BackupPolicy: PeriodicModeBackupPolicy ContinuousModeBackupPolicy	O objeto que representa a política para fazer backups em uma conta.
properties.capabilities	Capability[]	Lista de recursos do Cosmos DB para a conta
properties.capacity	Capacity	O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.
properties.connectorOffer	ConnectorOffer	O conector cassandra oferece o tipo de oferta para a conta C* do banco de dados do Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	A política de consistência para a conta do Cosmos DB.
properties.cors	CorsPolicy[]	A política CORS para a conta de banco de dados do Cosmos DB.
properties.customerManagedKeyStatus	string	Indica o status do recurso Chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece orientação para solução de problemas.
properties.defaultIdentity	string	A identidade padrão para acessar o cofre de chaves usada em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais.
properties.disableKeyBasedMetadataWriteAccess	boolean	Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta
properties.disableLocalAuth	boolean	Desative a autenticação local e garanta que apenas MSI e AAD possam ser usados exclusivamente para autenticação.
properties.enableAnalyticalStorage	boolean	Sinalizador para indicar se a análise de armazenamento deve ser habilitada.
properties.enableAutomaticFailover	boolean	Permite o failover automático da região de gravação no caso raro de a região não estar disponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta.
properties.enableBurstCapacity	boolean	Sinalizador para indicar a ativação/desativação do recurso Capacidade de intermitência na conta
properties.enableCassandraConnector	boolean	Ativa o conector cassandra na conta C* do Cosmos DB
properties.enableFreeTier	boolean	Sinalizador para indicar se o Nível Livre está habilitado.
properties.enableMultipleWriteLocations	boolean	Permite que a conta escreva em vários locais
properties.enablePartitionMerge	boolean	Sinalizador para indicar a ativação/desativação do recurso Mesclagem de Partições na conta
properties.enablePerRegionPerPartitionAutoscale	boolean	Sinalizador para indicar a ativação/desativação do recurso PerRegionPerPartitionAutoscale na conta
properties.ipRules	IpAddressOrRange[]	Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Sinalizador para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas.
properties.keyVaultKeyUri	string	O URI do cofre de chaves
properties.locations	Location[]	Uma matriz que contém os locais de replicação geográfica habilitados para a conta do Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Indica a versão mínima permitida do Tls. O valor padrão é Tls 1.2. As APIs Cassandra e Mongo só funcionam com Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Indica quais serviços têm permissão para ignorar as verificações de firewall.
properties.networkAclBypassResourceIds	string[]	Uma matriz que contém as Ids de Recursos para Desvio de Acl de Rede para a conta do Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Se as solicitações da Rede Pública são permitidas
properties.virtualNetworkRules	VirtualNetworkRule[]	Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB.
tags	object	As tags são uma lista de pares chave-valor que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 tags podem ser fornecidas para um recurso. Cada tag deve ter uma chave não superior a 128 caracteres e um valor não superior a 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".

Respostas

Name	Tipo	Description
200 OK	DatabaseAccountGetResults	A operação de atualização da conta de banco de dados será concluída de forma assíncrona.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Exemplos

CosmosDBDatabaseAccountPatch

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1?api-version=2024-11-15

{
  "location": "westus",
  "tags": {
    "dept": "finance"
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  },
  "properties": {
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "isVirtualNetworkFilterEnabled": true,
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "ignoreMissingVNetServiceEndpoint": false
      }
    ],
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "enablePerRegionPerPartitionAutoscale": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Local"
      }
    },
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "enablePartitionMerge": true,
    "minimalTlsVersion": "Tls"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1",
  "name": "ddb1",
  "location": "West US",
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "kind": "GlobalDocumentDB",
  "tags": {
    "dept": "finance"
  },
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "principalId": "52f4fef3-3c3f-4ff3-b52e-b5c9eeb68656",
    "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d",
    "userAssignedIdentities": {
      "/subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/eu2cgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "fbe75b66-01c5-4f87-a220-233af3270436",
        "principalId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d"
      }
    }
  },
  "properties": {
    "provisioningState": "Succeeded",
    "documentEndpoint": "https://ddb1.documents.azure.com:443/",
    "databaseAccountOfferType": "Standard",
    "ipRules": [
      {
        "ipAddressOrRange": "23.43.230.120"
      },
      {
        "ipAddressOrRange": "110.12.240.0/12"
      }
    ],
    "isVirtualNetworkFilterEnabled": true,
    "disableKeyBasedMetadataWriteAccess": false,
    "consistencyPolicy": {
      "defaultConsistencyLevel": "BoundedStaleness",
      "maxIntervalInSeconds": 10,
      "maxStalenessPrefix": 200
    },
    "writeLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "readLocations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "locations": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/",
        "provisioningState": "Succeeded",
        "failoverPriority": 0
      }
    ],
    "failoverPolicies": [
      {
        "id": "ddb1-eastus",
        "locationName": "East US",
        "failoverPriority": 0
      }
    ],
    "virtualNetworkRules": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
        "ignoreMissingVNetServiceEndpoint": false
      }
    ],
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "cors": [],
    "defaultIdentity": "FirstPartyIdentity",
    "enableFreeTier": false,
    "apiProperties": {},
    "enableAnalyticalStorage": true,
    "enableBurstCapacity": true,
    "analyticalStorageConfiguration": {
      "schemaType": "WellDefined"
    },
    "backupPolicy": {
      "type": "Periodic",
      "periodicModeProperties": {
        "backupIntervalInMinutes": 240,
        "backupRetentionIntervalInHours": 720,
        "backupStorageRedundancy": "Local"
      }
    },
    "networkAclBypass": "AzureServices",
    "networkAclBypassResourceIds": [
      "/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.Synapse/workspaces/workspaceName"
    ],
    "capacity": {
      "totalThroughputLimit": 2000
    },
    "keysMetadata": {
      "primaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "primaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      },
      "secondaryReadonlyMasterKey": {
        "generationTime": "2022-02-25T20:30:11Z"
      }
    },
    "enablePartitionMerge": true,
    "minimalTlsVersion": "Tls"
  }
}

Definições

Name	Description
AccountKeyMetadata	Os metadados relacionados a uma chave de acesso para uma determinada conta de banco de dados.
AnalyticalStorageConfiguration	Propriedades específicas de armazenamento analítico.
AnalyticalStorageSchemaType	Descreve os tipos de esquema para armazenamento analítico.
ApiProperties
BackupPolicyMigrationState	O objeto que representa o estado da migração entre as políticas de backup.
BackupPolicyMigrationStatus	Descreve o status da migração entre tipos de política de backup.
BackupPolicyType	Descreve o modo de backups.
BackupStorageRedundancy	Enum para indicar o tipo de redundância de armazenamento de backup.
Capability	Objeto de capacidade do Cosmos DB
Capacity	O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.
ConnectorOffer	O conector cassandra oferece o tipo de oferta para a conta de banco de dados C* do Cosmos DB.
ConsistencyPolicy	A política de consistência para a conta de banco de dados do Cosmos DB.
ContinuousModeBackupPolicy	O objeto que representa a política de backup em modo contínuo.
ContinuousModeProperties	Valores de configuração para backup de modo periódico
ContinuousTier	Enum para indicar o tipo de camada de backup contínuo.
CorsPolicy	A política CORS para a conta de banco de dados do Cosmos DB.
createdByType	O tipo de identidade que criou o recurso.
CreateMode	Enum para indicar o modo de criação da conta.
DatabaseAccountGetResults	Uma conta de banco de dados do Azure Cosmos DB.
DatabaseAccountKeysMetadata	Os metadados relacionados a cada chave de acesso para determinada conta de banco de dados do Cosmos DB.
DatabaseAccountKind	Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados.
DatabaseAccountOfferType	O tipo de oferta para a conta de banco de dados do Cosmos DB.
DatabaseAccountUpdateParameters	Parâmetros para aplicar patches nas propriedades da conta de banco de dados do Azure Cosmos DB.
DatabaseRestoreResource	Bases de Dados específicas para restaurar.
DefaultConsistencyLevel	O nível de consistência padrão e as definições de configuração da conta do Cosmos DB.
FailoverPolicy	A política de failover para uma determinada região de uma conta de banco de dados.
GremlinDatabaseRestoreResource	Bancos de dados Gremlin específicos para restaurar.
IpAddressOrRange	Objeto IpAddressOrRange
Location	Uma região na qual a conta de banco de dados do Azure Cosmos DB é implantada.
ManagedServiceIdentity	Identidade do recurso.
MinimalTlsVersion	Indica a versão mínima permitida do Tls. O valor padrão é Tls 1.2. As APIs Cassandra e Mongo só funcionam com Tls 1.2.
NetworkAclBypass	Indica quais serviços têm permissão para ignorar as verificações de firewall.
PeriodicModeBackupPolicy	O objeto que representa a política de backup de modo periódico.
PeriodicModeProperties	Valores de configuração para backup de modo periódico
PrivateEndpointConnection	Uma conexão de ponto de extremidade privada
PrivateEndpointProperty	Ponto de extremidade privado ao qual a conexão pertence.
PrivateLinkServiceConnectionStateProperty	Estado da Conexão da Conexão de Ponto Final Privado.
PublicNetworkAccess	Se as solicitações da Rede Pública são permitidas
ResourceIdentityType	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.
RestoreMode	Descreve o modo da restauração.
RestoreParameters	Parâmetros para indicar as informações sobre a restauração.
ServerVersion	Descreve a versão da conta MongoDB.
systemData	Metadados referentes à criação e última modificação do recurso.
UserAssignedIdentities	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
VirtualNetworkRule	Objeto de regra de ACL de rede virtual

AccountKeyMetadata

Os metadados relacionados a uma chave de acesso para uma determinada conta de banco de dados.

Name	Tipo	Description
generationTime	string	Tempo de geração em UTC da chave no formato ISO-8601. Se o valor estiver ausente do objeto, isso significa que a última regeneração de chave foi acionada antes de 2022-06-18.

AnalyticalStorageConfiguration

Propriedades específicas de armazenamento analítico.

Name	Tipo	Description
schemaType	AnalyticalStorageSchemaType	Descreve os tipos de esquema para armazenamento analítico.

AnalyticalStorageSchemaType

Descreve os tipos de esquema para armazenamento analítico.

Name	Tipo	Description
FullFidelity	string
WellDefined	string

ApiProperties

Name	Tipo	Description
serverVersion	ServerVersion	Descreve a versão da conta MongoDB.

BackupPolicyMigrationState

O objeto que representa o estado da migração entre as políticas de backup.

Name	Tipo	Description
startTime	string	Momento em que a migração da política de backup foi iniciada (formato ISO-8601).
status	BackupPolicyMigrationStatus	Descreve o status da migração entre tipos de política de backup.
targetType	BackupPolicyType	Descreve o tipo de política de backup de destino da migração da política de backup.

BackupPolicyMigrationStatus

Descreve o status da migração entre tipos de política de backup.

Name	Tipo	Description
Completed	string
Failed	string
InProgress	string
Invalid	string

BackupPolicyType

Descreve o modo de backups.

Name	Tipo	Description
Continuous	string
Periodic	string

BackupStorageRedundancy

Enum para indicar o tipo de redundância de armazenamento de backup.

Name	Tipo	Description
Geo	string
Local	string
Zone	string

Capability

Objeto de capacidade do Cosmos DB

Name	Tipo	Description
name	string	Nome do recurso do Cosmos DB. Por exemplo, "nome": "EnableCassandra". Os valores atuais também incluem "EnableTable" e "EnableGremlin".

Capacity

O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.

Name	Tipo	Description
totalThroughputLimit	integer	O limite de taxa de transferência total imposto à conta. Um totalThroughputLimit de 2000 impõe um limite estrito de taxa de transferência máxima que pode ser provisionado nessa conta para ser 2000. Um totalThroughputLimit de -1 indica que não há limites no provisionamento da taxa de transferência.

ConnectorOffer

O conector cassandra oferece o tipo de oferta para a conta de banco de dados C* do Cosmos DB.

Name	Tipo	Description
Small	string

ConsistencyPolicy

A política de consistência para a conta de banco de dados do Cosmos DB.

Name	Tipo	Description
defaultConsistencyLevel	DefaultConsistencyLevel	O nível de consistência padrão e as definições de configuração da conta do Cosmos DB.
maxIntervalInSeconds	integer	Quando usado com o nível de consistência Bounded Staleness, esse valor representa a quantidade de tempo de atraso (em segundos) tolerada. O intervalo aceite para este valor é 5 - 86400. Necessário quando defaultConsistencyPolicy está definido como 'BoundedStaleness'.
maxStalenessPrefix	integer	Quando usado com o nível de consistência Bounded Staleness, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para este valor é 1 – 2.147.483.647. Necessário quando defaultConsistencyPolicy está definido como 'BoundedStaleness'.

ContinuousModeBackupPolicy

O objeto que representa a política de backup em modo contínuo.

Name	Tipo	Description
continuousModeProperties	ContinuousModeProperties	Valores de configuração para backup em modo contínuo
migrationState	BackupPolicyMigrationState	O objeto que representa o estado da migração entre as políticas de backup.
type	string: Continuous	Descreve o modo de backups.

ContinuousModeProperties

Valores de configuração para backup de modo periódico

Name	Tipo	Description
tier	ContinuousTier	Enum para indicar o tipo de modo de backup contínuo

ContinuousTier

Enum para indicar o tipo de camada de backup contínuo.

Name	Tipo	Description
Continuous30Days	string
Continuous7Days	string

CorsPolicy

A política CORS para a conta de banco de dados do Cosmos DB.

Name	Tipo	Description
allowedHeaders	string	Os cabeçalhos de solicitação que o domínio de origem pode especificar na solicitação CORS.
allowedMethods	string	Os métodos (verbos de solicitação HTTP) que o domínio de origem pode usar para uma solicitação CORS.
allowedOrigins	string	Os domínios de origem que têm permissão para fazer uma solicitação contra o serviço via CORS.
exposedHeaders	string	Os cabeçalhos de resposta que podem ser enviados na resposta à solicitação CORS e expostos pelo navegador ao emissor da solicitação.
maxAgeInSeconds	integer	O tempo máximo que um navegador deve armazenar em cache a solicitação OPTIONS de comprovação.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

CreateMode

Enum para indicar o modo de criação da conta.

Name	Tipo	Description
Default	string
Restore	string

DatabaseAccountGetResults

Uma conta de banco de dados do Azure Cosmos DB.

Name	Tipo	Default value	Description
id	string		O identificador de recurso exclusivo do recurso ARM.
identity	ManagedServiceIdentity		Identidade do recurso.
kind	DatabaseAccountKind	GlobalDocumentDB	Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados.
location	string		O local do grupo de recursos ao qual o recurso pertence.
name	string		O nome do recurso ARM.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration		Propriedades específicas de armazenamento analítico.
properties.apiProperties	ApiProperties		Propriedades específicas da API.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy		O objeto que representa a política para fazer backups em uma conta.
properties.capabilities	Capability[]		Lista de recursos do Cosmos DB para a conta
properties.capacity	Capacity		O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.
properties.connectorOffer	ConnectorOffer		O conector cassandra oferece o tipo de oferta para a conta C* do banco de dados do Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy		A política de consistência para a conta de banco de dados do Cosmos DB.
properties.cors	CorsPolicy[]		A política CORS para a conta de banco de dados do Cosmos DB.
properties.createMode	CreateMode	Default	Enum para indicar o modo de criação da conta.
properties.customerManagedKeyStatus	string		Indica o status do recurso Chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece orientação para solução de problemas.
properties.databaseAccountOfferType	DatabaseAccountOfferType		O tipo de oferta para a conta de banco de dados do Cosmos DB. Valor padrão: Padrão.
properties.defaultIdentity	string		A identidade padrão para acessar o cofre de chaves usada em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais.
properties.disableKeyBasedMetadataWriteAccess	boolean		Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta
properties.disableLocalAuth	boolean		Desative a autenticação local e garanta que apenas MSI e AAD possam ser usados exclusivamente para autenticação.
properties.documentEndpoint	string		O ponto de extremidade de conexão para a conta de banco de dados do Cosmos DB.
properties.enableAnalyticalStorage	boolean		Sinalizador para indicar se a análise de armazenamento deve ser habilitada.
properties.enableAutomaticFailover	boolean		Permite o failover automático da região de gravação no caso raro de a região não estar disponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta.
properties.enableBurstCapacity	boolean		Sinalizador para indicar a ativação/desativação do recurso Capacidade de intermitência na conta
properties.enableCassandraConnector	boolean		Ativa o conector cassandra na conta C* do Cosmos DB
properties.enableFreeTier	boolean		Sinalizador para indicar se o Nível Livre está habilitado.
properties.enableMultipleWriteLocations	boolean		Permite que a conta escreva em vários locais
properties.enablePartitionMerge	boolean		Sinalizador para indicar a ativação/desativação do recurso Mesclagem de Partições na conta
properties.enablePerRegionPerPartitionAutoscale	boolean		Sinalizador para indicar a ativação/desativação do recurso PerRegionPerPartitionAutoscale na conta
properties.failoverPolicies	FailoverPolicy[]		Uma matriz que contém as regiões ordenadas por suas prioridades de failover.
properties.instanceId	string		Um identificador exclusivo atribuído à conta do banco de dados
properties.ipRules	IpAddressOrRange[]		Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean		Sinalizador para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas.
properties.keyVaultKeyUri	string		O URI do cofre de chaves
properties.keysMetadata	DatabaseAccountKeysMetadata		O objeto que representa os metadados para as chaves de conta da conta do Cosmos DB.
properties.locations	Location[]		Uma matriz que contém todos os locais habilitados para a conta do Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion		Indica a versão mínima permitida do Tls. O valor padrão é Tls 1.2. As APIs Cassandra e Mongo só funcionam com Tls 1.2.
properties.networkAclBypass	NetworkAclBypass		Indica quais serviços têm permissão para ignorar as verificações de firewall.
properties.networkAclBypassResourceIds	string[]		Uma matriz que contém as Ids de Recursos para Desvio de Acl de Rede para a conta do Cosmos DB.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de Conexões de Ponto Final Privadas configuradas para a conta do Cosmos DB.
properties.provisioningState	string		O status da conta do Cosmos DB no momento em que a operação foi chamada. O status pode ser um dos seguintes. 'Criando' – a conta do Cosmos DB está sendo criada. Quando uma conta está no estado Create, somente as propriedades especificadas como entrada para a operação Create Cosmos DB account são retornadas. 'Sucedido' – a conta do Cosmos DB está ativa para uso. 'Atualização' – a conta do Cosmos DB está sendo atualizada. 'Excluindo' – a conta do Cosmos DB está sendo excluída. 'Falhou' – a conta do Cosmos DB falhou na criação. 'DeletionFailed' – a exclusão da conta do Cosmos DB falhou.
properties.publicNetworkAccess	PublicNetworkAccess		Se as solicitações da Rede Pública são permitidas
properties.readLocations	Location[]		Uma matriz que contém os locais de leitura habilitados para a conta do Cosmos DB.
properties.restoreParameters	RestoreParameters		Parâmetros para indicar as informações sobre a restauração.
properties.virtualNetworkRules	VirtualNetworkRule[]		Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB.
properties.writeLocations	Location[]		Uma matriz que contém o local de gravação para a conta do Cosmos DB.
systemData	systemData		Os metadados do sistema relacionados a este recurso.
tags	object		As tags são uma lista de pares chave-valor que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 tags podem ser fornecidas para um recurso. Cada tag deve ter uma chave não superior a 128 caracteres e um valor não superior a 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".
type	string		O tipo de recurso do Azure.

DatabaseAccountKeysMetadata

Os metadados relacionados a cada chave de acesso para determinada conta de banco de dados do Cosmos DB.

Name	Tipo	Description
primaryMasterKey	AccountKeyMetadata	Os metadados relacionados à Chave de Read-Write Primária para a conta de banco de dados do Cosmos DB fornecida.
primaryReadonlyMasterKey	AccountKeyMetadata	Os metadados relacionados à Chave de Read-Only Primária para a conta de banco de dados do Cosmos DB fornecida.
secondaryMasterKey	AccountKeyMetadata	Os metadados relacionados à Secondary Read-Write Key para uma determinada conta de banco de dados do Cosmos DB.
secondaryReadonlyMasterKey	AccountKeyMetadata	Os metadados relacionados à Secondary Read-Only Key para uma determinada conta de banco de dados do Cosmos DB.

DatabaseAccountKind

Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados.

Name	Tipo	Description
GlobalDocumentDB	string
MongoDB	string
Parse	string

DatabaseAccountOfferType

O tipo de oferta para a conta de banco de dados do Cosmos DB.

Name	Tipo	Description
Standard	string

DatabaseAccountUpdateParameters

Parâmetros para aplicar patches nas propriedades da conta de banco de dados do Azure Cosmos DB.

Name	Tipo	Description
identity	ManagedServiceIdentity	Identidade do recurso.
location	string	O local do grupo de recursos ao qual o recurso pertence.
properties.analyticalStorageConfiguration	AnalyticalStorageConfiguration	Propriedades específicas de armazenamento analítico.
properties.apiProperties	ApiProperties	Propriedades específicas da API. Atualmente, suportado apenas para a API do MongoDB.
properties.backupPolicy	BackupPolicy: ContinuousModeBackupPolicy PeriodicModeBackupPolicy	O objeto que representa a política para fazer backups em uma conta.
properties.capabilities	Capability[]	Lista de recursos do Cosmos DB para a conta
properties.capacity	Capacity	O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.
properties.connectorOffer	ConnectorOffer	O conector cassandra oferece o tipo de oferta para a conta C* do banco de dados do Cosmos DB.
properties.consistencyPolicy	ConsistencyPolicy	A política de consistência para a conta do Cosmos DB.
properties.cors	CorsPolicy[]	A política CORS para a conta de banco de dados do Cosmos DB.
properties.customerManagedKeyStatus	string	Indica o status do recurso Chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece orientação para solução de problemas.
properties.defaultIdentity	string	A identidade padrão para acessar o cofre de chaves usada em recursos como chaves gerenciadas pelo cliente. A identidade padrão precisa ser definida explicitamente pelos usuários. Pode ser "FirstPartyIdentity", "SystemAssignedIdentity" e muito mais.
properties.disableKeyBasedMetadataWriteAccess	boolean	Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta
properties.disableLocalAuth	boolean	Desative a autenticação local e garanta que apenas MSI e AAD possam ser usados exclusivamente para autenticação.
properties.enableAnalyticalStorage	boolean	Sinalizador para indicar se a análise de armazenamento deve ser habilitada.
properties.enableAutomaticFailover	boolean	Permite o failover automático da região de gravação no caso raro de a região não estar disponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta.
properties.enableBurstCapacity	boolean	Sinalizador para indicar a ativação/desativação do recurso Capacidade de intermitência na conta
properties.enableCassandraConnector	boolean	Ativa o conector cassandra na conta C* do Cosmos DB
properties.enableFreeTier	boolean	Sinalizador para indicar se o Nível Livre está habilitado.
properties.enableMultipleWriteLocations	boolean	Permite que a conta escreva em vários locais
properties.enablePartitionMerge	boolean	Sinalizador para indicar a ativação/desativação do recurso Mesclagem de Partições na conta
properties.enablePerRegionPerPartitionAutoscale	boolean	Sinalizador para indicar a ativação/desativação do recurso PerRegionPerPartitionAutoscale na conta
properties.ipRules	IpAddressOrRange[]	Lista de IpRules.
properties.isVirtualNetworkFilterEnabled	boolean	Sinalizador para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas.
properties.keyVaultKeyUri	string	O URI do cofre de chaves
properties.keysMetadata	DatabaseAccountKeysMetadata	Essa propriedade é ignorada durante a operação de atualização, pois os metadados são somente leitura. O objeto representa os metadados para as chaves de conta da conta do Cosmos DB.
properties.locations	Location[]	Uma matriz que contém os locais de replicação geográfica habilitados para a conta do Cosmos DB.
properties.minimalTlsVersion	MinimalTlsVersion	Indica a versão mínima permitida do Tls. O valor padrão é Tls 1.2. As APIs Cassandra e Mongo só funcionam com Tls 1.2.
properties.networkAclBypass	NetworkAclBypass	Indica quais serviços têm permissão para ignorar as verificações de firewall.
properties.networkAclBypassResourceIds	string[]	Uma matriz que contém as Ids de Recursos para Desvio de Acl de Rede para a conta do Cosmos DB.
properties.publicNetworkAccess	PublicNetworkAccess	Se as solicitações da Rede Pública são permitidas
properties.virtualNetworkRules	VirtualNetworkRule[]	Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB.
tags	object	As tags são uma lista de pares chave-valor que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 tags podem ser fornecidas para um recurso. Cada tag deve ter uma chave não superior a 128 caracteres e um valor não superior a 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".

DatabaseRestoreResource

Bases de Dados específicas para restaurar.

Name	Tipo	Description
collectionNames	string[]	Os nomes das coleções disponíveis para restauração.
databaseName	string	O nome do banco de dados disponível para restauração.

DefaultConsistencyLevel

O nível de consistência padrão e as definições de configuração da conta do Cosmos DB.

Name	Tipo	Description
BoundedStaleness	string
ConsistentPrefix	string
Eventual	string
Session	string
Strong	string

FailoverPolicy

A política de failover para uma determinada região de uma conta de banco de dados.

Name	Tipo	Description
failoverPriority	integer	A prioridade de failover da região. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões - 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões nas quais a conta de banco de dados existe.
id	string	O identificador exclusivo da região na qual a conta de banco de dados é replicada. Exemplo: <accountName>-<locationName>.
locationName	string	O nome da região na qual a conta de banco de dados existe.

GremlinDatabaseRestoreResource

Bancos de dados Gremlin específicos para restaurar.

Name	Tipo	Description
databaseName	string	O nome do banco de dados gremlin disponível para restauração.
graphNames	string[]	Os nomes dos gráficos disponíveis para restauração.

IpAddressOrRange

Objeto IpAddressOrRange

Name	Tipo	Description
ipAddressOrRange	string	Um único endereço IPv4 ou um único intervalo de endereços IPv4 no formato CIDR. Os IPs fornecidos devem estar bem formatados e não podem estar contidos em um dos seguintes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, uma vez que não são aplicáveis pelo filtro de endereço IP. Exemplo de entradas válidas: "23.40.210.245" ou "23.40.210.0/8".

Location

Uma região na qual a conta de banco de dados do Azure Cosmos DB é implantada.

Name	Tipo	Description
documentEndpoint	string	O ponto de extremidade de conexão para a região específica. Exemplo: https://<accountName>-<locationName>.documents.azure.com:443/
failoverPriority	integer	A prioridade de failover da região. Uma prioridade de failover de 0 indica uma região de gravação. O valor máximo para uma prioridade de failover = (número total de regiões - 1). Os valores de prioridade de failover devem ser exclusivos para cada uma das regiões nas quais a conta de banco de dados existe.
id	string	O identificador exclusivo da região na conta do banco de dados. Exemplo: <accountName>-<locationName>.
isZoneRedundant	boolean	Sinalizador para indicar se esta região é ou não uma região AvailabilityZone
locationName	string	O nome da região.
provisioningState	string	O status da conta do Cosmos DB no momento em que a operação foi chamada. O status pode ser um dos seguintes. 'Criando' – a conta do Cosmos DB está sendo criada. Quando uma conta está no estado Create, somente as propriedades especificadas como entrada para a operação Create Cosmos DB account são retornadas. 'Sucedido' – a conta do Cosmos DB está ativa para uso. 'Atualização' – a conta do Cosmos DB está sendo atualizada. 'Excluindo' – a conta do Cosmos DB está sendo excluída. 'Falhou' – a conta do Cosmos DB falhou na criação. 'DeletionFailed' – a exclusão da conta do Cosmos DB falhou.

ManagedServiceIdentity

Identidade do recurso.

Name	Tipo	Description
principalId	string	O id principal da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
tenantId	string	A ID do locatário da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.
type	ResourceIdentityType	O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.
userAssignedIdentities	UserAssignedIdentities	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

MinimalTlsVersion

Indica a versão mínima permitida do Tls. O valor padrão é Tls 1.2. As APIs Cassandra e Mongo só funcionam com Tls 1.2.

Name	Tipo	Description
Tls	string
Tls11	string
Tls12	string

NetworkAclBypass

Indica quais serviços têm permissão para ignorar as verificações de firewall.

Name	Tipo	Description
AzureServices	string
None	string

PeriodicModeBackupPolicy

O objeto que representa a política de backup de modo periódico.

Name	Tipo	Description
migrationState	BackupPolicyMigrationState	O objeto que representa o estado da migração entre as políticas de backup.
periodicModeProperties	PeriodicModeProperties	Valores de configuração para backup de modo periódico
type	string: Periodic	Descreve o modo de backups.

PeriodicModeProperties

Valores de configuração para backup de modo periódico

Name	Tipo	Description
backupIntervalInMinutes	integer	Um inteiro que representa o intervalo em minutos entre dois backups
backupRetentionIntervalInHours	integer	Um inteiro que representa o tempo (em horas) em que cada backup é retido
backupStorageRedundancy	BackupStorageRedundancy	Enum para indicar o tipo de residência de backup

PrivateEndpointConnection

Uma conexão de ponto de extremidade privada

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.groupId	string	ID de grupo do ponto de extremidade privado.
properties.privateEndpoint	PrivateEndpointProperty	Ponto de extremidade privado ao qual a conexão pertence.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Estado da Conexão da Conexão de Ponto Final Privado.
properties.provisioningState	string	Estado de provisionamento do ponto de extremidade privado.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Ponto de extremidade privado ao qual a conexão pertence.

Name	Tipo	Description
id	string	ID do recurso do ponto de extremidade privado.

PrivateLinkServiceConnectionStateProperty

Estado da Conexão da Conexão de Ponto Final Privado.

Name	Tipo	Description
actionsRequired	string	Qualquer ação necessária além do fluxo de trabalho básico (aprovar/rejeitar/desconectar)
description	string	A descrição da conexão do serviço de link privado.
status	string	O status da conexão do serviço de link privado.

PublicNetworkAccess

Se as solicitações da Rede Pública são permitidas

Name	Tipo	Description
Disabled	string
Enabled	string
SecuredByPerimeter	string

ResourceIdentityType

O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades do serviço.

Name	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

RestoreMode

Descreve o modo da restauração.

Name	Tipo	Description
PointInTime	string

RestoreParameters

Parâmetros para indicar as informações sobre a restauração.

Name	Tipo	Description
databasesToRestore	DatabaseRestoreResource[]	Lista de bancos de dados específicos disponíveis para restauração.
gremlinDatabasesToRestore	GremlinDatabaseRestoreResource[]	Lista de bancos de dados gremlin específicos disponíveis para restauração.
restoreMode	RestoreMode	Descreve o modo da restauração.
restoreSource	string	A id da conta de banco de dados restaurável a partir da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Tempo para o qual a conta tem de ser restaurada (formato ISO-8601).
restoreWithTtlDisabled	boolean	Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida.
tablesToRestore	string[]	Lista de tabelas específicas disponíveis para restauração.

ServerVersion

Descreve a versão da conta MongoDB.

Name	Tipo	Description
3.2	string
3.6	string
4.0	string
4.2	string
5.0	string
6.0	string
7.0	string

systemData

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

Name	Tipo	Description
createdAt	string	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	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.

UserAssignedIdentities

A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name	Tipo	Description

VirtualNetworkRule

Objeto de regra de ACL de rede virtual

Name	Tipo	Description
id	string	ID de recurso de uma sub-rede, por exemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
ignoreMissingVNetServiceEndpoint	boolean	Crie uma regra de firewall antes que a rede virtual tenha o ponto de extremidade do serviço vnet habilitado.

Partilhar via

Database Accounts - Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

CosmosDBDatabaseAccountPatch

Pedido de amostra

Resposta da amostra

Definições

AccountKeyMetadata

AnalyticalStorageConfiguration

AnalyticalStorageSchemaType

ApiProperties

BackupPolicyMigrationState

BackupPolicyMigrationStatus

BackupPolicyType

BackupStorageRedundancy

Capability

Capacity

ConnectorOffer

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

ContinuousTier

CorsPolicy

createdByType

CreateMode

DatabaseAccountGetResults

DatabaseAccountKeysMetadata

DatabaseAccountKind

DatabaseAccountOfferType

DatabaseAccountUpdateParameters

DatabaseRestoreResource

DefaultConsistencyLevel

FailoverPolicy

GremlinDatabaseRestoreResource

IpAddressOrRange

Location

ManagedServiceIdentity

MinimalTlsVersion

NetworkAclBypass

PeriodicModeBackupPolicy

PeriodicModeProperties

PrivateEndpointConnection

PrivateEndpointProperty

PrivateLinkServiceConnectionStateProperty

PublicNetworkAccess

ResourceIdentityType

RestoreMode

RestoreParameters

ServerVersion

systemData

UserAssignedIdentities

VirtualNetworkRule

Recursos adicionais