DatabaseAccountCreateUpdateParameters interface

パッケージ:

@azure/arm-cosmosdb

Cosmos DB データベース アカウントを作成および更新するためのパラメーター。

Extends

ARMResourceProperties

プロパティ

analyticalStorageConfiguration	分析ストレージ固有のプロパティ。
apiProperties	API 固有のプロパティ。 現在、MongoDB API でのみサポートされています。
backupPolicy	アカウントでバックアップを作成するためのポリシーを表す オブジェクト。
capabilities	アカウントの Cosmos DB 機能の一覧
capacity	アカウントの容量の適用に関連するすべてのプロパティを表す オブジェクト。
connectorOffer	Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。
consistencyPolicy	Cosmos DB アカウントの整合性ポリシー。
cors	Cosmos DB データベース アカウントの CORS ポリシー。
createMode	アカウントの作成モードを示す列挙型。
customerManagedKeyStatus	アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合は、 プロパティでトラブルシューティング ガイダンスが提供されます。
databaseAccountOfferType	データベースのオファーの種類
defaultIdentity	カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "FirstPartyIdentity"、"SystemAssignedIdentity" などです。
disableKeyBasedMetadataWriteAccess	アカウント キーを使用してメタデータ リソース (データベース、コンテナー、スループット) に対する書き込み操作を無効にする
disableLocalAuth	ローカル認証をオプトアウトし、MSI と AAD のみを認証専用に使用できるようにします。
enableAnalyticalStorage	ストレージ分析を有効にするかどうかを示すフラグ。
enableAutomaticFailover	障害が原因でリージョンが使用できないまれな場合に、書き込みリージョンの自動フェールオーバーを有効にします。 自動フェールオーバーにより、アカウントの新しい書き込みリージョンが作成され、アカウントに構成されているフェールオーバーの優先順位に基づいて選択されます。
enableBurstCapacity	アカウントでのバースト容量プレビュー機能の有効化/無効化を示すフラグ
enableCassandraConnector	Cosmos DB C* アカウントで cassandra コネクタを有効にします
enableFreeTier	Free レベルが有効かどうかを示すフラグ。
enableMultipleWriteLocations	アカウントを複数の場所に書き込むことができます
enablePartitionMerge	アカウントでのパーティション マージ機能の有効化/無効化を示すフラグ
identity	リソースの ID。
ipRules	IpRules の一覧。
isVirtualNetworkFilterEnabled	VIRTUAL NETWORK ACL 規則を有効または無効にするかどうかを示すフラグ。
keysMetadata	メタデータは読み取り専用であるため、更新/作成操作中は、このプロパティは無視されます。 オブジェクトは、Cosmos DB アカウントのアカウント キーのメタデータを表します。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
keyVaultKeyUri	キー コンテナーの URI
kind	データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。
locations	Cosmos DB アカウントで有効になっている georeplication の場所を含む配列。
minimalTlsVersion	許可されている Tls の最小バージョンを示します。 既定値は Tls 1.2 です。 Cassandra と Mongo API は Tls 1.2 でのみ機能します。
networkAclBypass	ファイアウォール チェックをバイパスできるサービスを示します。
networkAclBypassResourceIds	Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。
publicNetworkAccess	パブリック ネットワークからの要求を許可するかどうか
restoreParameters	復元に関する情報を示すパラメーター。
virtualNetworkRules	Cosmos DB アカウント用に構成Virtual Network ACL 規則の一覧。

継承されたプロパティ

id	ARM リソースの一意のリソース識別子。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
location	リソースが属しているリソース グループの場所。
name	ARM リソースの名前。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
tags	タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。
type	Azure リソースの種類。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

プロパティの詳細

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

Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。

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

データベースのオファーの種類

databaseAccountOfferType: "Standard"

プロパティ値

"Standard"

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

リソースの ID。

identity?: ManagedServiceIdentity

プロパティ値

ManagedServiceIdentity

ipRules

IpRules の一覧。

ipRules?: IpAddressOrRange[]

プロパティ値

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

VIRTUAL NETWORK ACL 規則を有効または無効にするかどうかを示すフラグ。

isVirtualNetworkFilterEnabled?: boolean

プロパティ値

boolean

keysMetadata

メタデータは読み取り専用であるため、更新/作成操作中は、このプロパティは無視されます。 オブジェクトは、Cosmos DB アカウントのアカウント キーのメタデータを表します。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。

keysMetadata?: DatabaseAccountKeysMetadata

プロパティ値

DatabaseAccountKeysMetadata

keyVaultKeyUri

キー コンテナーの URI

keyVaultKeyUri?: string

プロパティ値

string

kind

データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。

kind?: string

プロパティ値

string

locations

Cosmos DB アカウントで有効になっている georeplication の場所を含む配列。

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 バイパスのリソース ID を含む配列。

networkAclBypassResourceIds?: string[]

プロパティ値

string[]

publicNetworkAccess

パブリック ネットワークからの要求を許可するかどうか

publicNetworkAccess?: string

プロパティ値

string

restoreParameters

復元に関する情報を示すパラメーター。

restoreParameters?: RestoreParameters

プロパティ値

RestoreParameters

virtualNetworkRules

Cosmos DB アカウント用に構成Virtual Network ACL 規則の一覧。

virtualNetworkRules?: VirtualNetworkRule[]

プロパティ値

VirtualNetworkRule[]

継承されたプロパティの詳細

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から継承