次の方法で共有

Microsoft.DocumentDB databaseAccounts/sqlDatabases 2024-12-01-preview

  • [アーティクル]

Bicep リソース定義

databaseAccounts/sqlDatabases リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/databaseAccounts/sqlDatabases リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-12-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'
  }
}

プロパティ値

AutoscaleSettings

名前 形容 価値
maxThroughput リソースをスケールアップできる最大スループットを表します。 int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

名前 形容 価値
autoscaleSettings 自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 AutoscaleSettings
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 int

ManagedServiceIdentity

名前 形容 価値
種類 リソースに使用される 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

名前 形容 価値

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

名前 形容 価値
同一性 リソースの ID。 ManagedServiceIdentity の
場所 リソースが属するリソース グループの場所。 糸
名前 リソース名 string (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: databaseAccounts
プロパティ Azure Cosmos DB SQL データベースを作成および更新するためのプロパティ。 SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

ResourceRestoreParameters

名前 形容 価値
restoreSource 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 糸
restoreTimestampInUtc アカウントを復元する必要がある時間 (ISO-8601 形式)。 糸
restoreWithTtlDisabled 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions の
資源 SQL データベースの標準 JSON 形式 SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (必須)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

名前 形容 価値
createMode リソースの作成モードを示す列挙型。 'Default'
'Restore'
身分証明書 Cosmos DB SQL データベースの名前 string (必須)
restoreParameters 復元に関する情報を示すパラメーター ResourceRestoreParameters

タグ

名前 形容 価値

クイック スタートのサンプル

次のクイック スタート サンプルでは、このリソースの種類をデプロイします。

Bicep ファイル 形容
分析ストア を使用して Azure Cosmos DB アカウント SQL API を する このテンプレートは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Free レベルの Azure Cosmos DB アカウント を作成する このテンプレートは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。
Core (SQL) API 用の Azure Cosmos DB アカウントを作成する このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、コア (SQL) API 用の Azure Cosmos アカウントを作成します。
自動スケール を使用して Azure Cosmos DB アカウント SQL API を作成する このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを使用するデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成 このテンプレートでは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーが作成されます。
Container Apps を使用して Dapr マイクロサービス アプリを作成する Container Apps を使用して Dapr マイクロサービス アプリを作成します。
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します Container Apps を使用して Dapr pub-sub servicebus アプリを作成します。
Cosmos DB 接続 を使用して Azure Data Explorer DB をデプロイする Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。

ARM テンプレート リソース定義

databaseAccounts/sqlDatabases リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/databaseAccounts/sqlDatabases リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2024-12-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"
  }
}

プロパティ値

AutoscaleSettings

名前 形容 価値
maxThroughput リソースをスケールアップできる最大スループットを表します。 int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

名前 形容 価値
autoscaleSettings 自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 AutoscaleSettings
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 int

ManagedServiceIdentity

名前 形容 価値
種類 リソースに使用される 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

名前 形容 価値

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

名前 形容 価値
apiVersion API のバージョン '2024-12-01-preview'
同一性 リソースの ID。 ManagedServiceIdentity の
場所 リソースが属するリソース グループの場所。 糸
名前 リソース名 string (必須)
プロパティ Azure Cosmos DB SQL データベースを作成および更新するためのプロパティ。 SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 リソースの種類 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases'

ResourceRestoreParameters

名前 形容 価値
restoreSource 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 糸
restoreTimestampInUtc アカウントを復元する必要がある時間 (ISO-8601 形式)。 糸
restoreWithTtlDisabled 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions の
資源 SQL データベースの標準 JSON 形式 SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (必須)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

名前 形容 価値
createMode リソースの作成モードを示す列挙型。 'Default'
'Restore'
身分証明書 Cosmos DB SQL データベースの名前 string (必須)
restoreParameters 復元に関する情報を示すパラメーター ResourceRestoreParameters

タグ

名前 形容 価値

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
分析ストア を使用して Azure Cosmos DB アカウント SQL API を する

Azure にデプロイする 		このテンプレートは、分析ストアで構成されたデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Free レベルの Azure Cosmos DB アカウント を作成する

Azure にデプロイする 		このテンプレートは、共有スループットとコンテナーを持つデータベースを使用して、SQL API 用の Free レベルの Azure Cosmos DB アカウントを作成します。
Core (SQL) API 用の Azure Cosmos DB アカウントを作成する

Azure にデプロイする 		このテンプレートでは、他の複数のオプションを含むスループットを持つデータベースとコンテナーを使用して、コア (SQL) API 用の Azure Cosmos アカウントを作成します。
自動スケール を使用して Azure Cosmos DB アカウント SQL API を作成する

Azure にデプロイする 		このテンプレートでは、他の複数のオプションを使用して、自動スケーリング スループットを使用するデータベースとコンテナーを使用して、Core (SQL) API 用の Azure Cosmos アカウントを作成します。
Azure Cosmos DB Core (SQL) API ストアド プロシージャを作成

Azure にデプロイする 		このテンプレートでは、Core (SQL) API 用の Azure Cosmos DB アカウントと、ストアド プロシージャ、トリガー、およびユーザー定義関数を含むコンテナーが作成されます。
Container Apps を使用して Dapr マイクロサービス アプリを作成する

Azure にデプロイする 		Container Apps を使用して Dapr マイクロサービス アプリを作成します。
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します

Azure にデプロイする 		Container Apps を使用して Dapr pub-sub servicebus アプリを作成します。
Cosmos DB 接続 を使用して Azure Data Explorer DB をデプロイする

Azure にデプロイする 		Cosmos DB 接続を使用して Azure Data Explorer DB をデプロイします。

Terraform (AzAPI プロバイダー) リソース定義

databaseAccounts/sqlDatabases リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/databaseAccounts/sqlDatabases リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  })
}

プロパティ値

AutoscaleSettings

名前 形容 価値
maxThroughput リソースをスケールアップできる最大スループットを表します。 int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名前 形容 価値

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

名前 形容 価値
autoscaleSettings 自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 AutoscaleSettings
スループット 1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 int

ManagedServiceIdentity

名前 形容 価値
種類 リソースに使用される 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

名前 形容 価値

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

名前 形容 価値
同一性 リソースの ID。 ManagedServiceIdentity の
場所 リソースが属するリソース グループの場所。 糸
名前 リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts
プロパティ Azure Cosmos DB SQL データベースを作成および更新するためのプロパティ。 SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (必須)
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2024-12-01-preview"

ResourceRestoreParameters

名前 形容 価値
restoreSource 復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} 糸
restoreTimestampInUtc アカウントを復元する必要がある時間 (ISO-8601 形式)。 糸
restoreWithTtlDisabled 復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

名前 形容 価値
オプション 要求に適用するオプションのキーと値のペア。 これは、要求と共に送信されたヘッダーに対応します。 CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions の
資源 SQL データベースの標準 JSON 形式 SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (必須)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

名前 形容 価値
createMode リソースの作成モードを示す列挙型。 'Default'
'Restore'
身分証明書 Cosmos DB SQL データベースの名前 string (必須)
restoreParameters 復元に関する情報を示すパラメーター ResourceRestoreParameters

タグ

名前 形容 価値