DatabaseAccountUpdateParameters interface

套件:

@azure/arm-cosmosdb

修補 Azure Cosmos DB 資料庫帳戶屬性的參數。

屬性

analyticalStorageConfiguration	分析記憶體特定屬性。
apiProperties	API 特定屬性。 目前僅支援 MongoDB API。
backupPolicy	物件，表示在帳戶上建立備份的原則。
capabilities	帳戶的 Cosmos DB 功能清單
capacity	物件，表示帳戶上與容量強制執行相關的所有屬性。
connectorOffer	cassandra 連接器提供 Cosmos DB 資料庫 C* 帳戶的類型。
consistencyPolicy	Cosmos DB 帳戶的一致性原則。
cors	Cosmos DB 資料庫帳戶的 CORS 原則。
customerManagedKeyStatus	指出帳戶上客戶管理金鑰功能的狀態。 如果發生錯誤，屬性會提供疑難解答指引。
defaultIdentity	用來存取客戶管理金鑰等功能中使用的金鑰保存庫的預設身分識別。 用戶必須明確設定預設身分識別。 它可以是 “FirstPartyIdentity”、“SystemAssignedIdentity” 等等。
disableKeyBasedMetadataWriteAccess	透過帳戶金鑰停用元資料資源的寫入作業（資料庫、容器、輸送量）
disableLocalAuth	退出宣告本機驗證，並確保只能使用 MSI 和 AAD 進行驗證。
enableAnalyticalStorage	旗標，指出是否要啟用記憶體分析。
enableAutomaticFailover	在罕見事件中啟用寫入區域的自動故障轉移，因為區域因中斷而無法使用。 自動故障轉移會導致帳戶的新寫入區域，並根據為帳戶設定的故障轉移優先順序來選擇。
enableBurstCapacity	指出帳戶上啟用/停用高載容量功能的旗標
enableCassandraConnector	在 Cosmos DB C* 帳戶上啟用 cassandra 連接器
enableFreeTier	旗標，指出是否啟用免費層。
enableMultipleWriteLocations	可讓帳戶在多個位置寫入
enablePartitionMerge	指出在帳戶上啟用/停用數據分割合併功能的旗標
identity	資源的身分識別。
ipRules	IpRules 清單。
isVirtualNetworkFilterEnabled	旗標，指出是否啟用/停用虛擬網路 ACL 規則。
keysMetadata	更新作業期間會忽略這個屬性，因為元數據是唯讀的。 物件代表 Cosmos DB 帳戶之帳戶金鑰的元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
keyVaultKeyUri	金鑰保存庫的 URI
location	資源所屬資源群組的位置。
locations	數位，其中包含為Cosmos DB帳戶啟用的地理複製位置。
minimalTlsVersion	表示允許的 Tls 版本下限。 預設值為 Tls 1.2。 Cassandra 和 Mongo API 僅適用於 Tls 1.2。
networkAclBypass	指出允許哪些服務略過防火牆檢查。
networkAclBypassResourceIds	數位，其中包含Cosmos DB帳戶的網路 Acl 略過資源識別碼。
publicNetworkAccess	是否允許來自公用網路的要求
tags	標籤是描述資源的索引鍵/值組清單。 這些標籤可用於檢視和群組此資源（跨資源群組）。 最多可為資源提供15個標籤。 每個標記的索引鍵不得大於 128 個字元，且值不大於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。
virtualNetworkRules	為 Cosmos DB 帳戶設定的虛擬網路 ACL 規則清單。

屬性詳細資料

analyticalStorageConfiguration

分析記憶體特定屬性。

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

屬性值

AnalyticalStorageConfiguration

apiProperties

API 特定屬性。 目前僅支援 MongoDB 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[]

customerManagedKeyStatus

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

customerManagedKeyStatus?: string

屬性值

string

defaultIdentity

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

defaultIdentity?: string

屬性值

string

disableKeyBasedMetadataWriteAccess

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

disableKeyBasedMetadataWriteAccess?: boolean

屬性值

boolean

disableLocalAuth

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

disableLocalAuth?: boolean

屬性值

boolean

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

identity

資源的身分識別。

identity?: ManagedServiceIdentity

屬性值

ManagedServiceIdentity

ipRules

IpRules 清單。

ipRules?: IpAddressOrRange[]

屬性值

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

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

isVirtualNetworkFilterEnabled?: boolean

屬性值

boolean

keysMetadata

更新作業期間會忽略這個屬性，因為元數據是唯讀的。 物件代表 Cosmos DB 帳戶之帳戶金鑰的元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

keysMetadata?: DatabaseAccountKeysMetadata

屬性值

DatabaseAccountKeysMetadata

keyVaultKeyUri

金鑰保存庫的 URI

keyVaultKeyUri?: string

屬性值

string

location

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

location?: 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[]

publicNetworkAccess

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

publicNetworkAccess?: string

屬性值

string

tags

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

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

屬性值

{[propertyName: string]: string}

virtualNetworkRules

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

virtualNetworkRules?: VirtualNetworkRule[]

屬性值

VirtualNetworkRule[]