DatabaseAccountUpdateParameters interface
Azure Cosmos DB データベース アカウントのプロパティに修正プログラムを適用するためのパラメーター。
プロパティ
analytical |
分析ストレージ固有のプロパティ。 |
api |
API 固有のプロパティ。 現在、MongoDB API でのみサポートされています。 |
backup |
アカウントでバックアップを作成するためのポリシーを表す オブジェクト。 |
capabilities | アカウントの Cosmos DB 機能の一覧 |
capacity | アカウントの容量の適用に関連するすべてのプロパティを表す オブジェクト。 |
connector |
Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。 |
consistency |
Cosmos DB アカウントの整合性ポリシー。 |
cors | Cosmos DB データベース アカウントの CORS ポリシー。 |
customer |
アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合は、 プロパティでトラブルシューティング ガイダンスが提供されます。 |
default |
カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "FirstPartyIdentity"、"SystemAssignedIdentity" などです。 |
disable |
アカウント キーを使用してメタデータ リソース (データベース、コンテナー、スループット) に対する書き込み操作を無効にする |
disable |
ローカル認証をオプトアウトし、MSI と AAD のみを認証専用に使用できるようにします。 |
enable |
ストレージ分析を有効にするかどうかを示すフラグ。 |
enable |
障害が原因でリージョンが使用できないまれな場合に、書き込みリージョンの自動フェールオーバーを有効にします。 自動フェールオーバーにより、アカウントの新しい書き込みリージョンが作成され、アカウントに構成されているフェールオーバーの優先順位に基づいて選択されます。 |
enable |
アカウントでのバースト容量プレビュー機能の有効化/無効化を示すフラグ |
enable |
Cosmos DB C* アカウントで cassandra コネクタを有効にします |
enable |
Free レベルが有効かどうかを示すフラグ。 |
enable |
アカウントを複数の場所に書き込むことができます |
enable |
アカウントでのパーティション マージ機能の有効化/無効化を示すフラグ |
identity | リソースの ID。 |
ip |
IpRules の一覧。 |
is |
VIRTUAL NETWORK ACL 規則を有効または無効にするかどうかを示すフラグ。 |
keys |
メタデータは読み取り専用であるため、更新操作中は、このプロパティは無視されます。 オブジェクトは、Cosmos DB アカウントのアカウント キーのメタデータを表します。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
key |
キー コンテナーの URI |
location | リソースが属しているリソース グループの場所。 |
locations | Cosmos DB アカウントで有効になっている georeplication の場所を含む配列。 |
minimal |
許可されている Tls の最小バージョンを示します。 既定値は Tls 1.2 です。 Cassandra と Mongo API は Tls 1.2 でのみ機能します。 |
network |
ファイアウォール チェックをバイパスできるサービスを示します。 |
network |
Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。 |
public |
パブリック ネットワークからの要求を許可するかどうか |
tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 |
virtual |
Cosmos DB アカウント用に構成Virtual Network ACL 規則の一覧。 |
プロパティの詳細
analyticalStorageConfiguration
分析ストレージ固有のプロパティ。
analyticalStorageConfiguration?: AnalyticalStorageConfiguration
プロパティ値
apiProperties
backupPolicy
capabilities
capacity
connectorOffer
Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。
connectorOffer?: string
プロパティ値
string
consistencyPolicy
cors
customerManagedKeyStatus
アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合は、 プロパティでトラブルシューティング ガイダンスが提供されます。
customerManagedKeyStatus?: string
プロパティ値
string
defaultIdentity
カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "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
Free レベルが有効かどうかを示すフラグ。
enableFreeTier?: boolean
プロパティ値
boolean
enableMultipleWriteLocations
アカウントを複数の場所に書き込むことができます
enableMultipleWriteLocations?: boolean
プロパティ値
boolean
enablePartitionMerge
アカウントでのパーティション マージ機能の有効化/無効化を示すフラグ
enablePartitionMerge?: boolean
プロパティ値
boolean
identity
ipRules
isVirtualNetworkFilterEnabled
VIRTUAL NETWORK ACL 規則を有効または無効にするかどうかを示すフラグ。
isVirtualNetworkFilterEnabled?: boolean
プロパティ値
boolean
keysMetadata
メタデータは読み取り専用であるため、更新操作中は、このプロパティは無視されます。 オブジェクトは、Cosmos DB アカウントのアカウント キーのメタデータを表します。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
keysMetadata?: DatabaseAccountKeysMetadata
プロパティ値
keyVaultKeyUri
キー コンテナーの URI
keyVaultKeyUri?: string
プロパティ値
string
location
リソースが属しているリソース グループの場所。
location?: string
プロパティ値
string
locations
minimalTlsVersion
許可されている Tls の最小バージョンを示します。 既定値は Tls 1.2 です。 Cassandra と Mongo API は Tls 1.2 でのみ機能します。
minimalTlsVersion?: string
プロパティ値
string
networkAclBypass
networkAclBypassResourceIds
Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。
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 アカウント用に構成Virtual Network ACL 規則の一覧。
virtualNetworkRules?: VirtualNetworkRule[]