Base de données Microsoft.DocumentDBAccounts/gremlinDatabases 2024-05-15-preview
- La plus récente
- 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
- Préversion du 01/03/2023
- 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
- 15-06-2021
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 15-01-2021
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Définition de ressource Bicep
Le type de ressource databaseAccounts/gremlinDatabases peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-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'
restoreWithTtlDisabled: bool
}
}
}
}
Valeurs de propriétés
databaseAccounts/gremlinDatabases
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep. |
string (obligatoire) |
| location | Emplacement du groupe de ressources auquel appartient la ressource. | string |
| tags | Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| parent | Dans Bicep, vous pouvez spécifier la ressource parente pour 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 |
| identité | Identité de la ressource. | ManagedServiceIdentity |
| properties | Propriétés permettant de créer et de mettre à jour une base de données Gremlin Azure Cosmos DB. | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (obligatoire) |
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 sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| Nom | Description | Valeur |
|---|---|---|
| options | Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| resource | Format JSON standard d’une base de données Gremlin | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (obligatoire) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| Nom | Description | Valeur |
|---|---|---|
| autoscaleSettings | Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings sont requis, mais pas les deux. | AutoscaleSettings |
| throughput | Unités de requête par seconde. Par exemple, « débit » : 10000. | int |
Paramètres de mise à l’échelle automatique
| Nom | Description | Valeur |
|---|---|---|
| maxThroughput | Représente le débit maximal auquel la ressource peut effectuer un scale-up. | int |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| Nom | Description | Valeur |
|---|---|---|
| createMode | Énumérez pour indiquer le mode de création des ressources. | 'Par défaut' 'Restaurer' |
| id | Nom de la base de données Gremlin Cosmos DB | chaîne (obligatoire) |
| restoreParameters | Paramètres pour indiquer les informations sur la restauration | ResourceRestoreParameters |
ResourceRestoreParameters
| Nom | Description | Valeur |
|---|---|---|
| restoreSource | ID du compte de base de données restaurable à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Heure à laquelle le compte doit être restauré (format ISO-8601). | string |
| restoreWithTtlDisabled | Spécifie si la durée de vie du compte restauré sera désactivée lors de la restauration réussie. | bool |
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’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 d’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 ressources de modèle ARM
Le type de ressource databaseAccounts/gremlinDatabases peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
"apiVersion": "2024-05-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",
"restoreWithTtlDisabled": "bool"
}
}
}
}
Valeurs de propriétés
databaseAccounts/gremlinDatabases
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.DocumentDB/databaseAccounts/gremlinDatabases » |
| apiVersion | Version de l’API de ressource | « 2024-05-15-preview » |
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON. |
chaîne (obligatoire) |
| location | Emplacement du groupe de ressources auquel appartient la ressource. | string |
| tags | Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| identité | Identité de la ressource. | ManagedServiceIdentity |
| properties | Propriétés permettant de créer et de mettre à jour une base de données Gremlin Azure Cosmos DB. | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (obligatoire) |
ManagedServiceIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité utilisé pour la ressource. Le type « SystemAssigned,UserAssigned » inclut à la fois une identité implicitement créée 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 sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| Nom | Description | Valeur |
|---|---|---|
| options | Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| resource | Format JSON standard d’une base de données Gremlin | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (obligatoire) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| Nom | Description | Valeur |
|---|---|---|
| autoscaleSettings | Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings sont requis, mais pas les deux. | AutoscaleSettings |
| throughput | Unités de requête par seconde. Par exemple, « débit » : 10000. | int |
Paramètres de mise à l’échelle automatique
| Nom | Description | Valeur |
|---|---|---|
| maxThroughput | Représente le débit maximal auquel la ressource peut effectuer un scale-up. | int |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| Nom | Description | Valeur |
|---|---|---|
| createMode | Énumérez pour indiquer le mode de création des ressources. | 'Par défaut' 'Restaurer' |
| id | Nom de la base de données Gremlin Cosmos DB | chaîne (obligatoire) |
| restoreParameters | Paramètres pour indiquer les informations sur la restauration | ResourceRestoreParameters |
ResourceRestoreParameters
| Nom | Description | Valeur |
|---|---|---|
| restoreSource | ID du compte de base de données restaurable à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Heure à laquelle le compte doit être restauré (format ISO-8601). | string |
| restoreWithTtlDisabled | Spécifie si la durée de vie du compte restauré sera désactivée lors de la restauration réussie. | bool |
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’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 d’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 utilisant le 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 d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/gremlinDatabases, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-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"
restoreWithTtlDisabled = bool
}
}
}
})
}
Valeurs de propriétés
databaseAccounts/gremlinDatabases
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2024-05-15-preview » |
| name | Nom de la ressource | string (obligatoire) |
| location | Emplacement du groupe de ressources auquel appartient la ressource. | string |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID pour la ressource de type : databaseAccounts |
| tags | Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». | Dictionnaire de noms et de valeurs d’étiquettes. |
| identité | Identité de la ressource. | ManagedServiceIdentity |
| properties | Propriétés permettant de créer et de mettre à jour une base de données Gremlin Azure Cosmos DB. | GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... (obligatoire) |
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. | « SystemAssigned » « SystemAssigned,UserAssigned » « UserAssigned » |
| identity_ids | Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». | Tableau d’ID d’identité utilisateur. |
ManagedServiceIdentityUserAssignedIdentities
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Cet objet ne contient aucune propriété à définir pendant le déploiement. Toutes les propriétés sont ReadOnly.
GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...
| Nom | Description | Valeur |
|---|---|---|
| options | Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. | CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt... |
| resource | Format JSON standard d’une base de données Gremlin | GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... (obligatoire) |
CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
| Nom | Description | Valeur |
|---|---|---|
| autoscaleSettings | Spécifie les paramètres de mise à l’échelle automatique. Remarque : débit ou autoscaleSettings est requis, mais pas les deux. | AutoscaleSettings |
| throughput | Unités de requête par seconde. Par exemple, « débit » : 10000. | int |
AutoscaleSettings
| Nom | Description | Valeur |
|---|---|---|
| maxThroughput | Représente le débit maximal jusqu’à lequel la ressource peut effectuer un scale-up. | int |
GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...
| Nom | Description | Valeur |
|---|---|---|
| createMode | Énumérez pour indiquer le mode de création de ressource. | « Par défaut » « Restaurer » |
| id | Nom de la base de données Gremlin Cosmos DB | string (obligatoire) |
| restoreParameters | Paramètres pour indiquer les informations relatives à la restauration | ResourceRestoreParameters |
ResourceRestoreParameters
| Nom | Description | Valeur |
|---|---|---|
| restoreSource | ID du compte de base de données restaurable à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Heure à laquelle le compte doit être restauré (format ISO-8601). | string |
| restoreWithTtlDisabled | Spécifie si la durée de vie du compte restauré sera désactivée lors de la restauration réussie. | bool |