Microsoft。DocumentDB databaseAccounts 2020-06-01-preview

Bicepリソースの定義

databaseAccounts リソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

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

リソース形式

Microsoftを作るために。DocumentDB/databaseAccounts リソースで、テンプレートに以下のBicepを追加してください。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2020-06-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    connectorOffer: 'string'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    databaseAccountOfferType: 'Standard'
    disableKeyBasedMetadataWriteAccess: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
    createMode: 'string'
    // For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
  }
  tags: {
    {customized property}: 'string'
  }
}

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties オブジェクト

createMode プロパティを設定して、オブジェクトの種類を指定します。

既定 の場合は、次の値を使用します。

{
  createMode: 'Default'
}

復元の場合は、次を使用します。

{
  createMode: 'Restore'
  restoreParameters: {
    databasesToRestore: [
      {
        collectionNames: [
          'string'
        ]
        databaseName: 'string'
      }
    ]
    restoreMode: 'string'
    restoreSource: 'string'
    restoreTimestampInUtc: 'string'
  }
}

BackupPolicy オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

連続 の場合は、次の値を使用します。

{
  type: 'Continuous'
}

定期的なには、次を使用します。

{
  periodicModeProperties: {
    backupIntervalInMinutes: int
    backupRetentionIntervalInHours: int
    backupStorageRedundancy: 'string'
  }
  type: 'Periodic'
}

プロパティ値

Microsoft。DocumentDB/databaseAccounts

ApiProperties

BackupPolicy

Capability

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DefaultRequestDatabaseAccountCreateUpdateProperties

IpAddressOrRange

Location

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

RestoreReqeustDatabaseAccountCreateUpdateProperties

Tags

VirtualNetworkRule

使用例

Bicep サンプル

CosmosDB (正式名称: DocumentDB) アカウントをデプロイする基本的な例です。

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: []
    consistencyPolicy: {
      defaultConsistencyLevel: 'BoundedStaleness'
      maxIntervalInSeconds: 10
      maxStalenessPrefix: 200
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

Azure Verified Modules

以下のAzure検証済みモジュールはこのリソースタイプの展開に使用できます。

Azure Quickstart Samples

以下の Azure クイックスタートテンプレートには、このリソースタイプのデプロイのためのBicepサンプルが含まれています。

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

databaseAccounts リソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

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

リソース形式

Microsoftを作るために。DocumentDB/databaseAccounts リソースで、テンプレートに以下のJSONを追加してください。

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2020-06-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "connectorOffer": "string",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "databaseAccountOfferType": "Standard",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ],
    "createMode": "string"
    // For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
  },
  "tags": {
    "{customized property}": "string"
  }
}

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties オブジェクト

createMode プロパティを設定して、オブジェクトの種類を指定します。

既定 の場合は、次の値を使用します。

{
  "createMode": "Default"
}

復元の場合は、次を使用します。

{
  "createMode": "Restore",
  "restoreParameters": {
    "databasesToRestore": [
      {
        "collectionNames": [ "string" ],
        "databaseName": "string"
      }
    ],
    "restoreMode": "string",
    "restoreSource": "string",
    "restoreTimestampInUtc": "string"
  }
}

BackupPolicy オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

連続 の場合は、次の値を使用します。

{
  "type": "Continuous"
}

定期的なには、次を使用します。

{
  "periodicModeProperties": {
    "backupIntervalInMinutes": "int",
    "backupRetentionIntervalInHours": "int",
    "backupStorageRedundancy": "string"
  },
  "type": "Periodic"
}

プロパティ値

Microsoft。DocumentDB/databaseAccounts

ApiProperties

BackupPolicy

Capability

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DefaultRequestDatabaseAccountCreateUpdateProperties

IpAddressOrRange

Location

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

RestoreReqeustDatabaseAccountCreateUpdateProperties

Tags

VirtualNetworkRule

使用例

Azure Quickstart Templates

以下のAzureクイックスタートテンプレートはこのリソースタイプを展開します。

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

databaseAccounts リソースの種類は、次をターゲットとする操作と共にデプロイできます。

• リソース グループ

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

リソース形式

Microsoftを作るために。DocumentDB/databaseAccounts リソースで、テンプレートに以下のTerraformを追加してください。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2020-06-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      connectorOffer = "string"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      databaseAccountOfferType = "Standard"
      disableKeyBasedMetadataWriteAccess = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
      createMode = "string"
      // For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
    }
  }
}

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties オブジェクト

createMode プロパティを設定して、オブジェクトの種類を指定します。

既定 の場合は、次の値を使用します。

{
  createMode = "Default"
}

復元の場合は、次を使用します。

{
  createMode = "Restore"
  restoreParameters = {
    databasesToRestore = [
      {
        collectionNames = [
          "string"
        ]
        databaseName = "string"
      }
    ]
    restoreMode = "string"
    restoreSource = "string"
    restoreTimestampInUtc = "string"
  }
}

BackupPolicy オブジェクト

型 プロパティを設定して、オブジェクトの型を指定します。

連続 の場合は、次の値を使用します。

{
  type = "Continuous"
}

定期的なには、次を使用します。

{
  periodicModeProperties = {
    backupIntervalInMinutes = int
    backupRetentionIntervalInHours = int
    backupStorageRedundancy = "string"
  }
  type = "Periodic"
}

プロパティ値

Microsoft。DocumentDB/databaseAccounts

ApiProperties

BackupPolicy

Capability

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DefaultRequestDatabaseAccountCreateUpdateProperties

IpAddressOrRange

Location

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

RestoreReqeustDatabaseAccountCreateUpdateProperties

Tags

VirtualNetworkRule

使用例

Terraformサンプル

CosmosDB (正式名称: DocumentDB) アカウントをデプロイする基本的な例です。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "BoundedStaleness"
        maxIntervalInSeconds    = 10
        maxStalenessPrefix      = 200
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}