DatabaseAccountGetResults interface

套件:

@azure/arm-cosmosdb

Azure Cosmos DB 資料庫帳戶。

Extends

ARMResourceProperties

屬性

analyticalStorageConfiguration	分析記憶體特定屬性。
apiProperties	API 特定屬性。
backupPolicy	物件，表示在帳戶上建立備份的原則。
capabilities	帳戶的 Cosmos DB 功能清單
capacity	物件，表示帳戶上與容量強制執行相關的所有屬性。
connectorOffer	cassandra 連接器提供 Cosmos DB 資料庫 C* 帳戶的類型。
consistencyPolicy	Cosmos DB 資料庫帳戶的一致性原則。
cors	Cosmos DB 資料庫帳戶的 CORS 原則。
createMode	列舉，表示帳戶建立模式。
customerManagedKeyStatus	指出帳戶上客戶管理金鑰功能的狀態。 如果發生錯誤，屬性會提供疑難解答指引。
databaseAccountOfferType	Cosmos DB 資料庫帳戶的供應項目類型。 默認值：標準。 注意：這個屬性不會串行化。 它只能由伺服器填入。
defaultIdentity	用來存取客戶管理金鑰等功能中使用的金鑰保存庫的預設身分識別。 用戶必須明確設定預設身分識別。 它可以是 “FirstPartyIdentity”、“SystemAssignedIdentity” 等等。
disableKeyBasedMetadataWriteAccess	透過帳戶金鑰停用元資料資源的寫入作業（資料庫、容器、輸送量）
disableLocalAuth	退出宣告本機驗證，並確保只能使用 MSI 和 AAD 進行驗證。
documentEndpoint	Cosmos DB 資料庫帳戶的連接端點。 注意：這個屬性不會串行化。 它只能由伺服器填入。
enableAnalyticalStorage	旗標，指出是否要啟用記憶體分析。
enableAutomaticFailover	在罕見事件中啟用寫入區域的自動故障轉移，因為區域因中斷而無法使用。 自動故障轉移會導致帳戶的新寫入區域，並根據為帳戶設定的故障轉移優先順序來選擇。
enableBurstCapacity	指出帳戶上啟用/停用高載容量功能的旗標
enableCassandraConnector	在 Cosmos DB C* 帳戶上啟用 cassandra 連接器
enableFreeTier	旗標，指出是否啟用免費層。
enableMultipleWriteLocations	可讓帳戶在多個位置寫入
enablePartitionMerge	指出在帳戶上啟用/停用數據分割合併功能的旗標
failoverPolicies	數位，包含依其故障轉移優先順序排序的區域。 注意：這個屬性不會串行化。 它只能由伺服器填入。
identity	資源的身分識別。
instanceId	指派給資料庫帳戶的唯一標識元注意：此屬性將不會串行化。 它只能由伺服器填入。
ipRules	IpRules 清單。
isVirtualNetworkFilterEnabled	旗標，指出是否啟用/停用虛擬網路 ACL 規則。
keysMetadata	物件，表示Cosmos DB帳戶之帳戶金鑰的元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
keyVaultKeyUri	金鑰保存庫的 URI
kind	指出資料庫帳戶的類型。 這隻能在建立資料庫帳戶時設定。
locations	數位，包含針對Cosmos DB帳戶啟用的所有位置。 注意：這個屬性不會串行化。 它只能由伺服器填入。
minimalTlsVersion	表示允許的 Tls 版本下限。 預設值為 Tls 1.2。 Cassandra 和 Mongo API 僅適用於 Tls 1.2。
networkAclBypass	指出允許哪些服務略過防火牆檢查。
networkAclBypassResourceIds	數位，其中包含Cosmos DB帳戶的網路 Acl 略過資源識別碼。
privateEndpointConnections	為 Cosmos DB 帳戶設定的私人端點連線清單。 注意：這個屬性不會串行化。 它只能由伺服器填入。
provisioningState	呼叫作業時 Cosmos DB 帳戶的狀態。 狀態可以是下列其中一項。 'Creating' – 正在建立 Cosmos DB 帳戶。 當帳戶處於建立狀態時，只會傳回指定為建立Cosmos DB帳戶作業輸入的屬性。 'Succeeded' – Cosmos DB 帳戶作用中以供使用。 「正在更新」– 正在更新 Cosmos DB 帳戶。 'Delete' – 正在刪除 Cosmos DB 帳戶。 'Failed' – Cosmos DB 帳戶建立失敗。 'DeletionFailed' – Cosmos DB 帳戶刪除失敗。 注意：這個屬性不會串行化。 它只能由伺服器填入。
publicNetworkAccess	是否允許來自公用網路的要求
readLocations	數位，其中包含為Cosmos DB帳戶啟用的讀取位置。 注意：這個屬性不會串行化。 它只能由伺服器填入。
restoreParameters	用來指出還原相關信息的參數。
systemData	與此資源相關的系統元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
virtualNetworkRules	為 Cosmos DB 帳戶設定的虛擬網路 ACL 規則清單。
writeLocations	數位，包含Cosmos DB帳戶的寫入位置。 注意：這個屬性不會串行化。 它只能由伺服器填入。

繼承的屬性

id	ARM 資源的唯一資源標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。
location	資源所屬資源群組的位置。
name	ARM 資源的名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
tags	標籤是描述資源的索引鍵/值組清單。 這些標籤可用於檢視和群組此資源（跨資源群組）。 最多可為資源提供15個標籤。 每個標記的索引鍵不得大於 128 個字元，且值不大於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。
type	Azure 資源的類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

屬性詳細資料

analyticalStorageConfiguration

分析記憶體特定屬性。

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

屬性值

AnalyticalStorageConfiguration

apiProperties

API 特定屬性。

apiProperties?: ApiProperties

屬性值

ApiProperties

backupPolicy

物件，表示在帳戶上建立備份的原則。

backupPolicy?: BackupPolicyUnion

屬性值

BackupPolicyUnion

capabilities

帳戶的 Cosmos DB 功能清單

capabilities?: Capability[]

屬性值

Capability[]

capacity

物件，表示帳戶上與容量強制執行相關的所有屬性。

capacity?: Capacity

屬性值

Capacity

connectorOffer

cassandra 連接器提供 Cosmos DB 資料庫 C* 帳戶的類型。

connectorOffer?: string

屬性值

string

consistencyPolicy

Cosmos DB 資料庫帳戶的一致性原則。

consistencyPolicy?: ConsistencyPolicy

屬性值

ConsistencyPolicy

cors

Cosmos DB 資料庫帳戶的 CORS 原則。

cors?: CorsPolicy[]

屬性值

CorsPolicy[]

createMode

列舉，表示帳戶建立模式。

createMode?: string

屬性值

string

customerManagedKeyStatus

指出帳戶上客戶管理金鑰功能的狀態。 如果發生錯誤，屬性會提供疑難解答指引。

customerManagedKeyStatus?: string

屬性值

string

databaseAccountOfferType

Cosmos DB 資料庫帳戶的供應項目類型。 默認值：標準。 注意：這個屬性不會串行化。 它只能由伺服器填入。

databaseAccountOfferType?: "Standard"

屬性值

"Standard"

defaultIdentity

用來存取客戶管理金鑰等功能中使用的金鑰保存庫的預設身分識別。 用戶必須明確設定預設身分識別。 它可以是 “FirstPartyIdentity”、“SystemAssignedIdentity” 等等。

defaultIdentity?: string

屬性值

string

disableKeyBasedMetadataWriteAccess

透過帳戶金鑰停用元資料資源的寫入作業（資料庫、容器、輸送量）

disableKeyBasedMetadataWriteAccess?: boolean

屬性值

boolean

disableLocalAuth

退出宣告本機驗證，並確保只能使用 MSI 和 AAD 進行驗證。

disableLocalAuth?: boolean

屬性值

boolean

documentEndpoint

Cosmos DB 資料庫帳戶的連接端點。 注意：這個屬性不會串行化。 它只能由伺服器填入。

documentEndpoint?: string

屬性值

string

enableAnalyticalStorage

旗標，指出是否要啟用記憶體分析。

enableAnalyticalStorage?: boolean

屬性值

boolean

enableAutomaticFailover

在罕見事件中啟用寫入區域的自動故障轉移，因為區域因中斷而無法使用。 自動故障轉移會導致帳戶的新寫入區域，並根據為帳戶設定的故障轉移優先順序來選擇。

enableAutomaticFailover?: boolean

屬性值

boolean

enableBurstCapacity

指出帳戶上啟用/停用高載容量功能的旗標

enableBurstCapacity?: boolean

屬性值

boolean

enableCassandraConnector

在 Cosmos DB C* 帳戶上啟用 cassandra 連接器

enableCassandraConnector?: boolean

屬性值

boolean

enableFreeTier

旗標，指出是否啟用免費層。

enableFreeTier?: boolean

屬性值

boolean

enableMultipleWriteLocations

可讓帳戶在多個位置寫入

enableMultipleWriteLocations?: boolean

屬性值

boolean

enablePartitionMerge

指出在帳戶上啟用/停用數據分割合併功能的旗標

enablePartitionMerge?: boolean

屬性值

boolean

failoverPolicies

數位，包含依其故障轉移優先順序排序的區域。 注意：這個屬性不會串行化。 它只能由伺服器填入。

failoverPolicies?: FailoverPolicy[]

屬性值

FailoverPolicy[]

identity

資源的身分識別。

identity?: ManagedServiceIdentity

屬性值

ManagedServiceIdentity

instanceId

指派給資料庫帳戶的唯一標識元注意：此屬性將不會串行化。 它只能由伺服器填入。

instanceId?: string

屬性值

string

ipRules

IpRules 清單。

ipRules?: IpAddressOrRange[]

屬性值

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

旗標，指出是否啟用/停用虛擬網路 ACL 規則。

isVirtualNetworkFilterEnabled?: boolean

屬性值

boolean

keysMetadata

物件，表示Cosmos DB帳戶之帳戶金鑰的元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

keysMetadata?: DatabaseAccountKeysMetadata

屬性值

DatabaseAccountKeysMetadata

keyVaultKeyUri

金鑰保存庫的 URI

keyVaultKeyUri?: string

屬性值

string

kind

指出資料庫帳戶的類型。 這隻能在建立資料庫帳戶時設定。

kind?: string

屬性值

string

locations

數位，包含針對Cosmos DB帳戶啟用的所有位置。 注意：這個屬性不會串行化。 它只能由伺服器填入。

locations?: Location_2[]

屬性值

Location[]

minimalTlsVersion

表示允許的 Tls 版本下限。 預設值為 Tls 1.2。 Cassandra 和 Mongo API 僅適用於 Tls 1.2。

minimalTlsVersion?: string

屬性值

string

networkAclBypass

指出允許哪些服務略過防火牆檢查。

networkAclBypass?: NetworkAclBypass

屬性值

NetworkAclBypass

networkAclBypassResourceIds

數位，其中包含Cosmos DB帳戶的網路 Acl 略過資源識別碼。

networkAclBypassResourceIds?: string[]

屬性值

string[]

privateEndpointConnections

為 Cosmos DB 帳戶設定的私人端點連線清單。 注意：這個屬性不會串行化。 它只能由伺服器填入。

privateEndpointConnections?: PrivateEndpointConnection[]

屬性值

PrivateEndpointConnection[]

provisioningState

呼叫作業時 Cosmos DB 帳戶的狀態。 狀態可以是下列其中一項。 'Creating' – 正在建立 Cosmos DB 帳戶。 當帳戶處於建立狀態時，只會傳回指定為建立Cosmos DB帳戶作業輸入的屬性。 'Succeeded' – Cosmos DB 帳戶作用中以供使用。 「正在更新」– 正在更新 Cosmos DB 帳戶。 'Delete' – 正在刪除 Cosmos DB 帳戶。 'Failed' – Cosmos DB 帳戶建立失敗。 'DeletionFailed' – Cosmos DB 帳戶刪除失敗。 注意：這個屬性不會串行化。 它只能由伺服器填入。

provisioningState?: string

屬性值

string

publicNetworkAccess

是否允許來自公用網路的要求

publicNetworkAccess?: string

屬性值

string

readLocations

數位，其中包含為Cosmos DB帳戶啟用的讀取位置。 注意：這個屬性不會串行化。 它只能由伺服器填入。

readLocations?: Location_2[]

屬性值

Location[]

restoreParameters

用來指出還原相關信息的參數。

restoreParameters?: RestoreParameters

屬性值

RestoreParameters

systemData

與此資源相關的系統元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

systemData?: SystemData

屬性值

SystemData

virtualNetworkRules

為 Cosmos DB 帳戶設定的虛擬網路 ACL 規則清單。

virtualNetworkRules?: VirtualNetworkRule[]

屬性值

VirtualNetworkRule[]

writeLocations

數位，包含Cosmos DB帳戶的寫入位置。 注意：這個屬性不會串行化。 它只能由伺服器填入。

writeLocations?: Location_2[]

屬性值

Location[]

繼承的屬性詳細資料

id

ARM 資源的唯一資源標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自ARMResourceProperties.id

location

資源所屬資源群組的位置。

location?: string

屬性值

string

繼承自ARMResourceProperties.location

name

ARM 資源的名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自ARMResourceProperties.name

tags

標籤是描述資源的索引鍵/值組清單。 這些標籤可用於檢視和群組此資源（跨資源群組）。 最多可為資源提供15個標籤。 每個標記的索引鍵不得大於 128 個字元，且值不大於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。

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

屬性值

{[propertyName: string]: string}

繼承自ARMResourceProperties.tags

type

Azure 資源的類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自ARMResourceProperties.type