DatabaseAccountGetResults interface

Pacote:

@azure/arm-cosmosdb

Uma conta de banco de dados do Azure Cosmos DB.

Extends

ARMResourceProperties

Propriedades

analyticalStorageConfiguration	Propriedades específicas do armazenamento analítico.
apiProperties	Propriedades específicas da API.
backupPolicy	O objeto que representa a política para fazer backups em uma conta.
capabilities	Lista de recursos do Cosmos DB para a conta
capacity	O objeto que representa todas as propriedades relacionadas à imposição de capacidade em uma conta.
connectorOffer	O tipo de oferta do conector do Cassandra para a conta C* do banco de dados do Cosmos DB.
consistencyPolicy	A política de consistência da conta de banco de dados do Cosmos DB.
cors	A política CORS para a conta de banco de dados do Cosmos DB.
createMode	Enumerar para indicar o modo de criação da conta.
customerManagedKeyStatus	Indica o status do recurso chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece diretrizes de solução de problemas.
databaseAccountOfferType	O tipo de oferta para a conta de banco de dados do Cosmos DB. Valor padrão: Standard. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
defaultIdentity	A identidade padrão para acessar o cofre de chaves usado 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.
defaultPriorityLevel	Enumerar para indicar o nível de prioridade padrão da solicitação para execução baseada em prioridade.
disableKeyBasedMetadataWriteAccess	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
disableLocalAuth	Opte pela autenticação local e verifique se apenas a MSI e o AAD podem ser usados exclusivamente para autenticação.
documentEndpoint	O ponto de extremidade de conexão da conta de banco de dados do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
enableAnalyticalStorage	Sinalizar para indicar se a análise de armazenamento deve ser habilitada.
enableAutomaticFailover	Habilita o failover automático da região de gravação no evento raro em que a região está indisponí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.
enableBurstCapacity	Sinalizar para indicar a habilitação/desabilitação do recurso capacidade de intermitência na conta
enableCassandraConnector	Habilita o conector do Cassandra na conta do C* do Cosmos DB
enableFreeTier	Sinalizar para indicar se a Camada Livre está habilitada.
enableMultipleWriteLocations	Permite que a conta escreva em vários locais
enablePartitionMerge	Sinalizar para indicar a habilitação/desabilitação do recurso mesclagem de partição na conta
enablePerRegionPerPartitionAutoscale	Sinalizador para indicar a habilitação/desabilitação do recurso PerRegionPerPartitionAutoscale na conta
enablePriorityBasedExecution	Sinalizar para indicar a habilitação/desabilitação do recurso de Visualização de Execução Baseada em Prioridade na conta
failoverPolicies	Uma matriz que contém as regiões ordenadas por suas prioridades de failover. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
identity	Identidade do recurso.
instanceId	Um identificador exclusivo atribuído à conta de banco de dados OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
ipRules	Lista de IpRules.
isVirtualNetworkFilterEnabled	Sinalizar para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas.
keysMetadata	O objeto que representa os metadados das Chaves de Conta da conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
keyVaultKeyUri	O URI do cofre de chaves
keyVaultKeyUriVersion	A versão da Chave Gerenciada pelo Cliente atualmente usada pela conta NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
kind	Indica o tipo de conta de banco de dados. Isso só pode ser definido na criação da conta de banco de dados.
locations	Uma matriz que contém todos os locais habilitados para a conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
minimalTlsVersion	Indica a versão mínima de TLS permitida. 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 verificações de firewall.
networkAclBypassResourceIds	Uma matriz que contém as IDs de Recurso para Bypass de Acl de Rede para a conta do Cosmos DB.
privateEndpointConnections	Lista de conexões de ponto de extremidade privado configuradas para a conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
provisioningState	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á em Criando estado, somente as propriedades especificadas como entrada para a operação de conta Criar Cosmos DB são retornadas. 'Êxito' – a conta do Cosmos DB está ativa para uso. 'Atualizando' – a conta do Cosmos DB está sendo atualizada. 'Excluindo' – a conta do Cosmos DB está sendo excluída. 'Falha' – falha na criação da conta do Cosmos DB. 'DeletionFailed' – falha na exclusão da conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
publicNetworkAccess	Se as solicitações da Rede Pública são permitidas
readLocations	Uma matriz que contém os locais de leitura habilitados para a conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
restoreParameters	Parâmetros para indicar as informações sobre a restauração.
systemData	Os metadados do sistema relacionados a esse recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
virtualNetworkRules	Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB.
writeLocations	Uma matriz que contém o local de gravação da conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Propriedades herdadas

id	O identificador de recurso exclusivo do recurso do ARM. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
location	O local do grupo de recursos ao qual o recurso pertence.
name	O nome do recurso do ARM. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
tags	As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave não maior que 128 caracteres e o valor não seja maior que 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	O tipo de recurso do Azure. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da propriedade

analyticalStorageConfiguration

Propriedades específicas do armazenamento analítico.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Valor da propriedade

AnalyticalStorageConfiguration

apiProperties

Propriedades específicas da API.

apiProperties?: ApiProperties

Valor da propriedade

ApiProperties

backupPolicy

O objeto que representa a política para fazer backups em uma conta.

backupPolicy?: BackupPolicyUnion

Valor da propriedade

BackupPolicyUnion

capabilities

Lista de recursos do Cosmos DB para a conta

capabilities?: Capability[]

Valor da propriedade

Capability[]

capacity

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

capacity?: Capacity

Valor da propriedade

Capacity

connectorOffer

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

connectorOffer?: string

Valor da propriedade

string

consistencyPolicy

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

consistencyPolicy?: ConsistencyPolicy

Valor da propriedade

ConsistencyPolicy

cors

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

cors?: CorsPolicy[]

Valor da propriedade

CorsPolicy[]

createMode

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

createMode?: string

Valor da propriedade

string

customerManagedKeyStatus

Indica o status do recurso chave gerenciada pelo cliente na conta. Caso haja erros, a propriedade fornece diretrizes de solução de problemas.

customerManagedKeyStatus?: string

Valor da propriedade

string

databaseAccountOfferType

O tipo de oferta para a conta de banco de dados do Cosmos DB. Valor padrão: Standard. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

databaseAccountOfferType?: "Standard"

Valor da propriedade

"Standard"

defaultIdentity

A identidade padrão para acessar o cofre de chaves usado 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.

defaultIdentity?: string

Valor da propriedade

string

defaultPriorityLevel

Enumerar para indicar o nível de prioridade padrão da solicitação para execução baseada em prioridade.

defaultPriorityLevel?: string

Valor da propriedade

string

disableKeyBasedMetadataWriteAccess

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

disableKeyBasedMetadataWriteAccess?: boolean

Valor da propriedade

boolean

disableLocalAuth

Opte pela autenticação local e verifique se apenas a MSI e o AAD podem ser usados exclusivamente para autenticação.

disableLocalAuth?: boolean

Valor da propriedade

boolean

documentEndpoint

O ponto de extremidade de conexão da conta de banco de dados do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

documentEndpoint?: string

Valor da propriedade

string

enableAnalyticalStorage

Sinalizar para indicar se a análise de armazenamento deve ser habilitada.

enableAnalyticalStorage?: boolean

Valor da propriedade

boolean

enableAutomaticFailover

Habilita o failover automático da região de gravação no evento raro em que a região está indisponí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.

enableAutomaticFailover?: boolean

Valor da propriedade

boolean

enableBurstCapacity

Sinalizar para indicar a habilitação/desabilitação do recurso capacidade de intermitência na conta

enableBurstCapacity?: boolean

Valor da propriedade

boolean

enableCassandraConnector

Habilita o conector do Cassandra na conta do C* do Cosmos DB

enableCassandraConnector?: boolean

Valor da propriedade

boolean

enableFreeTier

Sinalizar para indicar se a Camada Livre está habilitada.

enableFreeTier?: boolean

Valor da propriedade

boolean

enableMultipleWriteLocations

Permite que a conta escreva em vários locais

enableMultipleWriteLocations?: boolean

Valor da propriedade

boolean

enablePartitionMerge

Sinalizar para indicar a habilitação/desabilitação do recurso mesclagem de partição na conta

enablePartitionMerge?: boolean

Valor da propriedade

boolean

enablePerRegionPerPartitionAutoscale

Sinalizador para indicar a habilitação/desabilitação do recurso PerRegionPerPartitionAutoscale na conta

enablePerRegionPerPartitionAutoscale?: boolean

Valor da propriedade

boolean

enablePriorityBasedExecution

Sinalizar para indicar a habilitação/desabilitação do recurso de Visualização de Execução Baseada em Prioridade na conta

enablePriorityBasedExecution?: boolean

Valor da propriedade

boolean

failoverPolicies

Uma matriz que contém as regiões ordenadas por suas prioridades de failover. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

failoverPolicies?: FailoverPolicy[]

Valor da propriedade

FailoverPolicy[]

identity

Identidade do recurso.

identity?: ManagedServiceIdentity

Valor da propriedade

ManagedServiceIdentity

instanceId

Um identificador exclusivo atribuído à conta de banco de dados OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

instanceId?: string

Valor da propriedade

string

ipRules

Lista de IpRules.

ipRules?: IpAddressOrRange[]

Valor da propriedade

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

Sinalizar para indicar se as regras de ACL da Rede Virtual devem ser habilitadas/desabilitadas.

isVirtualNetworkFilterEnabled?: boolean

Valor da propriedade

boolean

keysMetadata

O objeto que representa os metadados das Chaves de Conta da conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

keysMetadata?: DatabaseAccountKeysMetadata

Valor da propriedade

DatabaseAccountKeysMetadata

keyVaultKeyUri

O URI do cofre de chaves

keyVaultKeyUri?: string

Valor da propriedade

string

keyVaultKeyUriVersion

A versão da Chave Gerenciada pelo Cliente atualmente usada pela conta NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

keyVaultKeyUriVersion?: string

Valor da propriedade

string

kind

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

kind?: string

Valor da propriedade

string

locations

Uma matriz que contém todos os locais habilitados para a conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

locations?: Location[]

Valor da propriedade

Location[]

minimalTlsVersion

Indica a versão mínima de TLS permitida. O valor padrão é Tls 1.2. As APIs cassandra e mongo só funcionam com tls 1.2.

minimalTlsVersion?: string

Valor da propriedade

string

networkAclBypass

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

networkAclBypass?: NetworkAclBypass

Valor da propriedade

NetworkAclBypass

networkAclBypassResourceIds

Uma matriz que contém as IDs de Recurso para Bypass de Acl de Rede para a conta do Cosmos DB.

networkAclBypassResourceIds?: string[]

Valor da propriedade

string[]

privateEndpointConnections

Lista de conexões de ponto de extremidade privado configuradas para a conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

privateEndpointConnections?: PrivateEndpointConnection[]

Valor da propriedade

PrivateEndpointConnection[]

provisioningState

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á em Criando estado, somente as propriedades especificadas como entrada para a operação de conta Criar Cosmos DB são retornadas. 'Êxito' – a conta do Cosmos DB está ativa para uso. 'Atualizando' – a conta do Cosmos DB está sendo atualizada. 'Excluindo' – a conta do Cosmos DB está sendo excluída. 'Falha' – falha na criação da conta do Cosmos DB. 'DeletionFailed' – falha na exclusão da conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningState?: string

Valor da propriedade

string

publicNetworkAccess

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

publicNetworkAccess?: string

Valor da propriedade

string

readLocations

Uma matriz que contém os locais de leitura habilitados para a conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

readLocations?: Location[]

Valor da propriedade

Location[]

restoreParameters

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

restoreParameters?: RestoreParameters

Valor da propriedade

RestoreParameters

systemData

Os metadados do sistema relacionados a esse recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

systemData?: SystemData

Valor da propriedade

SystemData

virtualNetworkRules

Lista de regras de ACL de Rede Virtual configuradas para a conta do Cosmos DB.

virtualNetworkRules?: VirtualNetworkRule[]

Valor da propriedade

VirtualNetworkRule[]

writeLocations

Uma matriz que contém o local de gravação da conta do Cosmos DB. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

writeLocations?: Location[]

Valor da propriedade

Location[]

Detalhes das propriedades herdadas

id

O identificador de recurso exclusivo do recurso do ARM. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor da propriedade

string

herdado deARMResourceProperties.id

location

O local do grupo de recursos ao qual o recurso pertence.

location?: string

Valor da propriedade

string

Herdado deARMResourceProperties.location

name

O nome do recurso do ARM. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor da propriedade

string

herdado deARMResourceProperties.name

tags

As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave não maior que 128 caracteres e o valor não seja maior que 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".

tags?: {[propertyName: string]: string}

Valor da propriedade

{[propertyName: string]: string}

Herdado deARMResourceProperties.tags

type

O tipo de recurso do Azure. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor da propriedade

string

Herdado deARMResourceProperties.type