Partager via

Microsoft.DocumentDB databaseAccounts/gremlinDatabases 2023-09-15-preview

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/gremlinDatabases peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-09-15-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'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
ressource Format JSON standard d’une base de données Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (obligatoire)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nom Description Valeur
createMode Énumération pour indiquer le mode de création de ressources. 'Default'
'PointInTimeRestore'
'Restore'
id Nom de la base de données Gremlin Cosmos DB chaîne (obligatoire)
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Nom Description Valeur
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : databaseAccounts
Propriétés Propriétés permettant de créer et de mettre à jour une base de données Gremlin Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ResourceRestoreParameters

Nom Description Valeur
restoreSource ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}} corde
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). corde

Étiquettes

Nom Description Valeur

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
créer un compte Azure Cosmos DB pour l' de l’API Gremlin Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique utilisant un débit dédié.
Créer un compte Azure Cosmos DB pour la mise à l’échelle automatique de l’API Gremlin Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique à l’aide du débit de mise à l’échelle automatique.

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts/gremlinDatabases peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
  "apiVersion": "2023-09-15-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"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
ressource Format JSON standard d’une base de données Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (obligatoire)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nom Description Valeur
createMode Énumération pour indiquer le mode de création de ressources. 'Default'
'PointInTimeRestore'
'Restore'
id Nom de la base de données Gremlin Cosmos DB chaîne (obligatoire)
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Nom Description Valeur
apiVersion Version de l’API '2023-09-15-preview'
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour une base de données Gremlin Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases'

ResourceRestoreParameters

Nom Description Valeur
restoreSource ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}} corde
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). corde

Étiquettes

Nom Description Valeur

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
créer un compte Azure Cosmos DB pour l' de l’API Gremlin

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique utilisant un débit dédié.
Créer un compte Azure Cosmos DB pour la mise à l’échelle automatique de l’API Gremlin

Déployer sur Azure 		Ce modèle crée un compte Azure Cosmos DB pour l’API Gremlin dans deux régions avec une base de données et un graphique à l’aide du débit de mise à l’échelle automatique.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/gremlinDatabases peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, ajoutez la terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-09-15-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"
        }
      }
    }
  })
}

Valeurs de propriété

Mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. Int

GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOptions
ressource Format JSON standard d’une base de données Gremlin GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource (obligatoire)

GremlinDatabaseResourceOrGremlinDatabaseGetPropertiesResource

Nom Description Valeur
createMode Énumération pour indiquer le mode de création de ressources. 'Default'
'PointInTimeRestore'
'Restore'
id Nom de la base de données Gremlin Cosmos DB chaîne (obligatoire)
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases

Nom Description Valeur
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts
Propriétés Propriétés permettant de créer et de mettre à jour une base de données Gremlin Azure Cosmos DB. GremlinDatabaseCreateUpdatePropertiesOrGremlinDatabaseGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-09-15-preview »

ResourceRestoreParameters

Nom Description Valeur
restoreSource ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}} corde
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). corde

Étiquettes

Nom Description Valeur