Microsoft.DocumentDB databaseAccounts/gremlinDatabases 2023-03-15-preview
- 最新
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep リソース定義
databaseAccounts/gremlinDatabases リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-03-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
}
}
}
プロパティ値
databaseAccounts/gremlinDatabases
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| location | リソースが属しているリソース グループの場所。 | string |
| tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
種類のリソースのシンボル名: databaseAccounts |
| identity | リソースの ID。 | ManagedServiceIdentity |
| properties | Azure Cosmos DB Gremlin データベースを作成および更新するためのプロパティ。 | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (必須) |
ManagedServiceIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| 名前 | 説明 | 値 |
|---|---|---|
| options | 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| resource | Gremlin データベースの標準 JSON 形式 | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (必須) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| 名前 | 説明 | 値 |
|---|---|---|
| autoscaleSettings | 自動スケーリング設定を指定します。 | AutoscaleSettings |
| throughput | 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 | INT |
AutoscaleSettings
| 名前 | 説明 | 値 |
|---|---|---|
| maxThroughput | リソースがスケールアップできる最大スループットを表します。 | INT |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| 名前 | 説明 | 値 |
|---|---|---|
| createMode | リソースの作成モードを示す列挙型。 | 'Default' 'PointInTimeRestore' 'Restore' |
| id | Cosmos DB Gremlin データベースの名前 | string (必須) |
| restoreParameters | 復元に関する情報を示すパラメーター | ResourceRestoreParameters |
ResourceRestoreParameters
| 名前 | 説明 | 値 |
|---|---|---|
| restoreSource | 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | アカウントを復元する必要がある時間 (ISO-8601 形式)。 | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
Gremlin API 用の Azure Cosmos DB アカウントを作成する |
このテンプレートは、専用スループットを使用して、1 つのデータベースと 1 つのグラフを含む 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。 |
| Gremlin API 自動スケーリング用の Azure Cosmos DB アカウントを作成する |
このテンプレートは、自動スケーリング スループットを使用して、1 つのデータベースと 1 つのグラフを含む 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。 |
ARM テンプレート リソース定義
databaseAccounts/gremlinDatabases リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases リソースを作成するには、テンプレートに次の JSON を追加します。
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
"apiVersion": "2023-03-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
}
}
}
}
プロパティ値
databaseAccounts/gremlinDatabases
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases' |
| apiVersion | リソース API のバージョン | '2023-03-15-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| location | リソースが属しているリソース グループの場所。 | string |
| tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| identity | リソースの ID。 | ManagedServiceIdentity |
| properties | Azure Cosmos DB Gremlin データベースを作成および更新するためのプロパティ。 | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (必須) |
ManagedServiceIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| 名前 | 説明 | 値 |
|---|---|---|
| options | 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| resource | Gremlin データベースの標準 JSON 形式 | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (必須) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| 名前 | 説明 | 値 |
|---|---|---|
| autoscaleSettings | 自動スケーリング設定を指定します。 | AutoscaleSettings |
| throughput | 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 | INT |
AutoscaleSettings
| 名前 | 説明 | 値 |
|---|---|---|
| maxThroughput | リソースがスケールアップできる最大スループットを表します。 | INT |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| 名前 | 説明 | 値 |
|---|---|---|
| createMode | リソースの作成モードを示す列挙型。 | 'Default' 'PointInTimeRestore' 'Restore' |
| id | Cosmos DB Gremlin データベースの名前 | string (必須) |
| restoreParameters | 復元に関する情報を示すパラメーター | ResourceRestoreParameters |
ResourceRestoreParameters
| 名前 | 説明 | 値 |
|---|---|---|
| restoreSource | 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | アカウントを復元する必要がある時間 (ISO-8601 形式)。 | string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| Gremlin API 用の Azure Cosmos DB アカウントを作成する |
このテンプレートは、専用スループットを使用して、1 つのデータベースと 1 つのグラフを含む 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。 |
| Gremlin API 自動スケーリング用の Azure Cosmos DB アカウントを作成する |
このテンプレートは、自動スケーリング スループットを使用して、1 つのデータベースと 1 つのグラフを含む 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。 |
Terraform (AzAPI プロバイダー) リソース定義
databaseAccounts/gremlinDatabases リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-03-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
}
}
})
}
プロパティ値
databaseAccounts/gremlinDatabases
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-03-15-preview" |
| name | リソース名 | string (必須) |
| location | リソースが属しているリソース グループの場所。 | string |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: databaseAccounts |
| tags | タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 | タグの名前と値のディクショナリ。 |
| identity | リソースの ID。 | ManagedServiceIdentity |
| properties | Azure Cosmos DB Gremlin データベースを作成および更新するためのプロパティ。 | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (必須) |
ManagedServiceIdentity
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" という形式の ARM リソース ID になります。 | ユーザー ID ID の配列。 |
ManagedServiceIdentityUserAssignedIdentities
| 名前 | 説明 | 値 |
|---|---|---|
| {カスタマイズされたプロパティ} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| 名前 | 説明 | 値 |
|---|---|---|
| options | 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されるヘッダーに対応します。 | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| resource | Gremlin データベースの標準 JSON 形式 | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (必須) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| 名前 | 説明 | 値 |
|---|---|---|
| autoscaleSettings | 自動スケーリング設定を指定します。 | AutoscaleSettings |
| throughput | 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 | INT |
AutoscaleSettings
| 名前 | 説明 | 値 |
|---|---|---|
| maxThroughput | リソースがスケールアップできる最大スループットを表します。 | INT |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| 名前 | 説明 | 値 |
|---|---|---|
| createMode | リソースの作成モードを示す列挙型。 | "Default" "PointInTimeRestore" "復元" |
| id | Cosmos DB Gremlin データベースの名前 | string (必須) |
| restoreParameters | 復元に関する情報を示すパラメーター | ResourceRestoreParameters |
ResourceRestoreParameters
| 名前 | 説明 | 値 |
|---|---|---|
| restoreSource | 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | アカウントを復元する必要がある時間 (ISO-8601 形式)。 | string |