DatabaseAccountGetResults interface
Azure Cosmos DB データベース アカウント。
- Extends
プロパティ
analytical |
分析ストレージ固有のプロパティ。 |
api |
API 固有のプロパティ。 |
backup |
アカウントでバックアップを作成するためのポリシーを表す オブジェクト。 |
capabilities | アカウントの Cosmos DB 機能の一覧 |
capacity | アカウントの容量の適用に関連するすべてのプロパティを表す オブジェクト。 |
connector |
Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。 |
consistency |
Cosmos DB データベース アカウントの整合性ポリシー。 |
cors | Cosmos DB データベース アカウントの CORS ポリシー。 |
create |
アカウントの作成モードを示す列挙型。 |
customer |
アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合、プロパティはトラブルシューティング ガイダンスを提供します。 |
database |
Cosmos DB データベース アカウントのオファーの種類。 既定値: Standard。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
default |
カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "FirstPartyIdentity"、"SystemAssignedIdentity" などを指定できます。 |
disable |
アカウント キーを使用してメタデータ リソース (データベース、コンテナー、スループット) に対する書き込み操作を無効にする |
disable |
ローカル認証をオプトアウトし、MSI と AAD のみを認証専用に使用できることを確認します。 |
document |
Cosmos DB データベース アカウントの接続エンドポイント。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
enable |
ストレージ分析を有効にするかどうかを示すフラグ。 |
enable |
障害が原因でリージョンが使用できないまれな場合に、書き込みリージョンの自動フェールオーバーを有効にします。 自動フェールオーバーでは、アカウントの新しい書き込みリージョンが作成され、アカウント用に構成されたフェールオーバーの優先順位に基づいて選択されます。 |
enable |
アカウントでバースト容量プレビュー機能を有効または無効にすることを示すフラグ |
enable |
Cosmos DB C* アカウントで cassandra コネクタを有効にします |
enable |
Free レベルが有効かどうかを示すフラグ。 |
enable |
アカウントを複数の場所に書き込むことができます |
enable |
アカウントでのパーティションマージ機能の有効化/無効化を示すフラグ |
failover |
フェールオーバーの優先順位で並べ替えられたリージョンを含む配列。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
identity | リソースの ID。 |
instance |
データベース アカウントに割り当てられた一意識別子注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
ip |
IpRules の一覧。 |
is |
ACL 規則を有効または無効にするかどうかを示すフラグVirtual Network設定します。 |
keys |
Cosmos DB アカウントのアカウント キーのメタデータを表す オブジェクト。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
key |
キー コンテナーの URI |
kind | データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。 |
locations | Cosmos DB アカウントで有効になっているすべての場所を含む配列。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
minimal |
許可される Tls の最小バージョンを示します。 既定値は Tls 1.2 です。 Cassandra API と Mongo API は Tls 1.2 でのみ機能します。 |
network |
ファイアウォール チェックをバイパスできるサービスを示します。 |
network |
Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。 |
private |
Cosmos DB アカウント用に構成Connectionsプライベート エンドポイントの一覧。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
provisioning |
操作が呼び出されたときの Cosmos DB アカウントの状態。 状態は、次のいずれかになります。 'Creating' – Cosmos DB アカウントが作成されています。 アカウントが作成中状態の場合、Cosmos DB アカウントの作成操作の入力として指定されたプロパティのみが返されます。 'Succeeded' – Cosmos DB アカウントがアクティブで使用されています。 '更新中' – Cosmos DB アカウントが更新されています。 '削除中' – Cosmos DB アカウントが削除されています。 'Failed' – Cosmos DB アカウントの作成に失敗しました。 'DeleteFailed' – Cosmos DB アカウントの削除に失敗しました。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
public |
パブリック ネットワークからの要求が許可されるかどうか |
read |
Cosmos DB アカウントで有効になっている読み取り場所を含む配列。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
restore |
復元に関する情報を示すパラメーター。 |
system |
このリソースに関連するシステム メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
virtual |
Cosmos DB アカウント用に構成されたVirtual Network ACL 規則の一覧。 |
write |
Cosmos DB アカウントの書き込み場所を含む配列。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
継承されたプロパティ
id | ARM リソースの一意のリソース識別子。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
location | リソースが属しているリソース グループの場所。 |
name | ARM リソースの名前。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 |
type | Azure リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
プロパティの詳細
analyticalStorageConfiguration
分析ストレージ固有のプロパティ。
analyticalStorageConfiguration?: AnalyticalStorageConfiguration
プロパティ値
apiProperties
backupPolicy
capabilities
capacity
connectorOffer
Cosmos DB データベース C* アカウントの cassandra コネクタ オファーの種類。
connectorOffer?: string
プロパティ値
string
consistencyPolicy
cors
createMode
アカウントの作成モードを示す列挙型。
createMode?: string
プロパティ値
string
customerManagedKeyStatus
アカウントのカスタマー マネージド キー機能の状態を示します。 エラーが発生した場合、プロパティはトラブルシューティング ガイダンスを提供します。
customerManagedKeyStatus?: string
プロパティ値
string
databaseAccountOfferType
Cosmos DB データベース アカウントのオファーの種類。 既定値: Standard。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
databaseAccountOfferType?: "Standard"
プロパティ値
"Standard"
defaultIdentity
カスタマー マネージド キーなどの機能で使用されるキー コンテナーにアクセスするための既定の ID。 既定の ID は、ユーザーが明示的に設定する必要があります。 "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
Free レベルが有効かどうかを示すフラグ。
enableFreeTier?: boolean
プロパティ値
boolean
enableMultipleWriteLocations
アカウントを複数の場所に書き込むことができます
enableMultipleWriteLocations?: boolean
プロパティ値
boolean
enablePartitionMerge
アカウントでのパーティションマージ機能の有効化/無効化を示すフラグ
enablePartitionMerge?: boolean
プロパティ値
boolean
failoverPolicies
フェールオーバーの優先順位で並べ替えられたリージョンを含む配列。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
failoverPolicies?: FailoverPolicy[]
プロパティ値
identity
instanceId
データベース アカウントに割り当てられた一意識別子注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
instanceId?: string
プロパティ値
string
ipRules
isVirtualNetworkFilterEnabled
ACL 規則を有効または無効にするかどうかを示すフラグVirtual Network設定します。
isVirtualNetworkFilterEnabled?: boolean
プロパティ値
boolean
keysMetadata
Cosmos DB アカウントのアカウント キーのメタデータを表す オブジェクト。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
keysMetadata?: DatabaseAccountKeysMetadata
プロパティ値
keyVaultKeyUri
キー コンテナーの URI
keyVaultKeyUri?: string
プロパティ値
string
kind
データベース アカウントの種類を示します。 これは、データベース アカウントの作成時にのみ設定できます。
kind?: string
プロパティ値
string
locations
Cosmos DB アカウントで有効になっているすべての場所を含む配列。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
locations?: Location_2[]
プロパティ値
Location[]
minimalTlsVersion
許可される Tls の最小バージョンを示します。 既定値は Tls 1.2 です。 Cassandra API と Mongo API は Tls 1.2 でのみ機能します。
minimalTlsVersion?: string
プロパティ値
string
networkAclBypass
networkAclBypassResourceIds
Cosmos DB アカウントのネットワーク ACL バイパスのリソース ID を含む配列。
networkAclBypassResourceIds?: string[]
プロパティ値
string[]
privateEndpointConnections
Cosmos DB アカウント用に構成Connectionsプライベート エンドポイントの一覧。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
privateEndpointConnections?: PrivateEndpointConnection[]
プロパティ値
provisioningState
操作が呼び出されたときの Cosmos DB アカウントの状態。 状態は、次のいずれかになります。 'Creating' – Cosmos DB アカウントが作成されています。 アカウントが作成中状態の場合、Cosmos DB アカウントの作成操作の入力として指定されたプロパティのみが返されます。 'Succeeded' – Cosmos DB アカウントがアクティブで使用されています。 '更新中' – Cosmos DB アカウントが更新されています。 '削除中' – Cosmos DB アカウントが削除されています。 'Failed' – Cosmos DB アカウントの作成に失敗しました。 'DeleteFailed' – Cosmos DB アカウントの削除に失敗しました。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
provisioningState?: string
プロパティ値
string
publicNetworkAccess
パブリック ネットワークからの要求が許可されるかどうか
publicNetworkAccess?: string
プロパティ値
string
readLocations
Cosmos DB アカウントで有効になっている読み取り場所を含む配列。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
readLocations?: Location_2[]
プロパティ値
Location[]
restoreParameters
systemData
このリソースに関連するシステム メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
systemData?: SystemData
プロパティ値
virtualNetworkRules
Cosmos DB アカウント用に構成されたVirtual Network ACL 規則の一覧。
virtualNetworkRules?: VirtualNetworkRule[]
プロパティ値
writeLocations
Cosmos DB アカウントの書き込み場所を含む配列。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
writeLocations?: Location_2[]
プロパティ値
Location[]
継承されたプロパティの詳細
id
ARM リソースの一意のリソース識別子。 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。
id?: string
プロパティ値
string
location
name
ARM リソースの名前。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
name?: string
プロパティ値
string
tags
タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。
tags?: {[propertyName: string]: string}
プロパティ値
{[propertyName: string]: string}
type
Azure リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
type?: string
プロパティ値
string