Bicep リソース定義
databaseAccounts/gremlinDatabases リソースの種類は、次をターゲットとする操作でデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2025-05-01-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
}
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases
名前 |
形容 |
価値 |
同一性 |
リソースの ID。 |
ManagedServiceIdentity の |
場所 |
リソースが属するリソース グループの場所。 |
糸 |
名前 |
リソース名 |
string (必須) |
親 |
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。
詳細については、「親リソースの外部 子リソース」を参照してください。 |
種類のリソースのシンボリック名: databaseAccounts |
プロパティ |
Azure Cosmos DB Gremlin データベースを作成および更新するためのプロパティ。 |
GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (必須) |
タグ |
リソース タグ |
タグ名と値のディクショナリ。 テンプレート の タグを参照してください |
Autoscale設定
名前 |
形容 |
価値 |
最大スループット |
リソースをスケールアップできる最大スループットを表します。 |
整数 (int) |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsまたはGremlinDatabaseGetPropertiesOptions
名前 |
形容 |
価値 |
自動スケール設定 |
自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 |
Autoscale設定 |
スループット |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
整数 (int) |
GremlinDatabaseCreateUpdatePropertiesまたはGremlinDatabaseGetProperties
GremlinDatabaseResourceまたはGremlinDatabaseGetPropertiesResource
名前 |
形容 |
価値 |
クリエイトモード |
リソースの作成モードを示す列挙型。 |
デフォルト 「復元」 |
身分証明書 |
Cosmos DB Gremlin データベースの名前 |
string (必須) |
restoreParameters (リストアパラメータ) |
復元に関する情報を示すパラメーター |
リソース復元パラメーター |
マネージドサービスアイデンティティ
名前 |
形容 |
価値 |
種類 |
リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 |
「なし」 'システム割り当て' 'システム割り当て済み、ユーザー割り当て済み' 'UserAssigned' |
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) |
リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 |
ManagedServiceIdentityUserAssignedIdentities の |
ManagedServiceIdentityUserAssignedIdentities
リソース復元パラメーター
名前 |
形容 |
価値 |
リストアソース |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
糸 |
restoreTimestampInUTCの |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
糸 |
restoreWithTtlDisabled (英語) |
復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 |
ブール (bool) |
使用例
Azure クイック スタートのサンプル
次 Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。
Bicep ファイル |
形容 |
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": "2025-05-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
}
}
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases
名前 |
形容 |
価値 |
apiVersion (英語) |
API のバージョン |
「2025-05-01-プレビュー」 |
同一性 |
リソースの ID。 |
ManagedServiceIdentity の |
場所 |
リソースが属するリソース グループの場所。 |
糸 |
名前 |
リソース名 |
string (必須) |
プロパティ |
Azure Cosmos DB Gremlin データベースを作成および更新するためのプロパティ。 |
GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (必須) |
タグ |
リソース タグ |
タグ名と値のディクショナリ。 テンプレート の タグを参照してください |
種類 |
リソースの種類 |
'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases' |
Autoscale設定
名前 |
形容 |
価値 |
最大スループット |
リソースをスケールアップできる最大スループットを表します。 |
整数 (int) |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsまたはGremlinDatabaseGetPropertiesOptions
名前 |
形容 |
価値 |
自動スケール設定 |
自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 |
Autoscale設定 |
スループット |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
整数 (int) |
GremlinDatabaseCreateUpdatePropertiesまたはGremlinDatabaseGetProperties
GremlinDatabaseResourceまたはGremlinDatabaseGetPropertiesResource
名前 |
形容 |
価値 |
クリエイトモード |
リソースの作成モードを示す列挙型。 |
デフォルト 「復元」 |
身分証明書 |
Cosmos DB Gremlin データベースの名前 |
string (必須) |
restoreParameters (リストアパラメータ) |
復元に関する情報を示すパラメーター |
リソース復元パラメーター |
マネージドサービスアイデンティティ
名前 |
形容 |
価値 |
種類 |
リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 |
「なし」 'システム割り当て' 'システム割り当て済み、ユーザー割り当て済み' 'UserAssigned' |
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) |
リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 |
ManagedServiceIdentityUserAssignedIdentities の |
ManagedServiceIdentityUserAssignedIdentities
リソース復元パラメーター
名前 |
形容 |
価値 |
リストアソース |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
糸 |
restoreTimestampInUTCの |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
糸 |
restoreWithTtlDisabled (英語) |
復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 |
ブール (bool) |
使用例
Azure のクイック スタート テンプレート
このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。
テンプレート |
形容 |
Gremlin API 用の Azure Cosmos DB アカウントを作成する
Azure にデプロイする |
このテンプレートは、専用スループットを使用して、1 つのデータベースと 1 つのグラフを含む 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。 |
Gremlin API 自動スケール 用の Azure Cosmos DB アカウントを作成する
Azure にデプロイする |
このテンプレートでは、自動スケーリング スループットを使用して、1 つのデータベースと 1 つのグラフを含む 2 つのリージョンに Gremlin API 用の Azure Cosmos DB アカウントを作成します。 |
databaseAccounts/gremlinDatabases リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2025-05-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
}
}
}
}
プロパティ値
Microsoft.DocumentDB/databaseAccounts/gremlinDatabases
Autoscale設定
名前 |
形容 |
価値 |
最大スループット |
リソースをスケールアップできる最大スループットを表します。 |
整数 (int) |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsまたはGremlinDatabaseGetPropertiesOptions
名前 |
形容 |
価値 |
自動スケール設定 |
自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 |
Autoscale設定 |
スループット |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
整数 (int) |
GremlinDatabaseCreateUpdatePropertiesまたはGremlinDatabaseGetProperties
GremlinDatabaseResourceまたはGremlinDatabaseGetPropertiesResource
名前 |
形容 |
価値 |
クリエイトモード |
リソースの作成モードを示す列挙型。 |
デフォルト 「復元」 |
身分証明書 |
Cosmos DB Gremlin データベースの名前 |
string (必須) |
restoreParameters (リストアパラメータ) |
復元に関する情報を示すパラメーター |
リソース復元パラメーター |
マネージドサービスアイデンティティ
名前 |
形容 |
価値 |
種類 |
リソースに使用される ID の種類。 型 'SystemAssigned,UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、サービスからすべての ID を削除します。 |
「なし」 'システム割り当て' 'システム割り当て済み、ユーザー割り当て済み' 'UserAssigned' |
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) |
リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。 |
ManagedServiceIdentityUserAssignedIdentities の |
ManagedServiceIdentityUserAssignedIdentities
リソース復元パラメーター
名前 |
形容 |
価値 |
リストアソース |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
糸 |
restoreTimestampInUTCの |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
糸 |
restoreWithTtlDisabled (英語) |
復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 |
ブール (bool) |