Base de datos Microsoft.DocumentDBAccounts/gremlinDatabases/graphs 2023-09-15-preview
- Más reciente
- 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
- 15-03-2023
- 2023-03-15-preview
- 2023-03-01-preview
- 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
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 15-01-2021
- 01-09-2020
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Definición de recursos de Bicep
El tipo de recurso databaseAccounts/gremlinDatabases/graphs se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-09-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: {
analyticalStorageTtl: int
conflictResolutionPolicy: {
conflictResolutionPath: 'string'
conflictResolutionProcedure: 'string'
mode: 'string'
}
createMode: 'string'
defaultTtl: int
id: 'string'
indexingPolicy: {
automatic: bool
compositeIndexes: [
{
order: 'string'
path: 'string'
}
]
excludedPaths: [
{
path: 'string'
}
]
includedPaths: [
{
indexes: [
{
dataType: 'string'
kind: 'string'
precision: int
}
]
path: 'string'
}
]
indexingMode: 'string'
spatialIndexes: [
{
path: 'string'
types: [
'string'
]
}
]
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
version: int
}
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
Valores de propiedad
databaseAccounts/gremlinDatabases/graphs
| Nombre | Descripción | Value |
|---|---|---|
| name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep. |
string (obligatorio) |
| ubicación | Ubicación del grupo de recursos al que pertenece el recurso. | string |
| etiquetas | Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". | Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas. |
| primario | En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para más información, consulte Recurso secundario fuera del recurso primario. |
Nombre simbólico del recurso de tipo: gremlinDatabases |
| identidad | Identidad del recurso. | ManagedServiceIdentity |
| properties | Propiedades para crear y actualizar el grafo de Gremlin de Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (obligatorio) |
ManagedServiceIdentity
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned",UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. | 'Ninguno' 'SystemAssigned' 'SystemAssigned,UserAssigned' "UserAssigned" |
| userAssignedIdentities | Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidades de usuario serán identificadores de recurso de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Este objeto no contiene ninguna propiedad que se va a establecer durante la implementación. Todas las propiedades son ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
| Nombre | Descripción | Value |
|---|---|---|
| opciones | Par clave-valor de las opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
| resource | Formato JSON estándar de un grafo de Gremlin | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (obligatorio) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
| Nombre | Descripción | Valor |
|---|---|---|
| autoscaleSettings | Especifica la configuración de escalabilidad automática. Nota: Se requiere rendimiento o escalado automáticoConfiguración, pero no ambos. | AutoscaleSettings |
| throughput | Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. | int |
AutoscaleSettings
| Nombre | Descripción | Valor |
|---|---|---|
| maxThroughput | Representa el rendimiento máximo, el recurso se puede escalar verticalmente. | int |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
| Nombre | Descripción | Valor |
|---|---|---|
| analyticalStorageTtl | TTL analítico. | int |
| conflictResolutionPolicy | Directiva de resolución de conflictos para el gráfico. | ConflictResolutionPolicy |
| createMode | Enumeración para indicar el modo de creación de recursos. | 'Default' 'PointInTimeRestore' 'Restaurar' |
| defaultTtl | Período de vida predeterminado | int |
| id | Nombre del grafo gremlin de Cosmos DB | string (obligatorio) |
| indexingPolicy | Configuración de la directiva de indexación. De forma predeterminada, la indexación es automática para todas las rutas de acceso de documento dentro del gráfico. | IndexingPolicy |
| partitionKey | Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones | ContainerPartitionKey |
| restoreParameters | Parámetros para indicar la información sobre la restauración | ResourceRestoreParameters |
| uniqueKeyPolicy | Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. | UniqueKeyPolicy |
ConflictResolutionPolicy
| Nombre | Descripción | Valor |
|---|---|---|
| conflictResolutionPath | Ruta de acceso de resolución de conflictos en el caso del modo LastWriterWins. | string |
| conflictResolutionProcedure | Procedimiento para resolver conflictos en el caso del modo personalizado. | string |
| mode | Indica el modo de resolución de conflictos. | 'Personalizado' 'LastWriterWins' |
IndexingPolicy
| Nombre | Descripción | Valor |
|---|---|---|
| automatic | Indica si la directiva de indexación es automática. | bool |
| compositeIndexes | Lista de listas de rutas de acceso compuestas | CompositePath[] |
| excludedPaths | Lista de rutas de acceso que se van a excluir de la indexación | ExcludedPath[] |
| includedPaths | Lista de rutas de acceso que se van a incluir en la indexación | IncludedPath[] |
| indexingMode | Indica el modo de indexación. | "coherente" 'diferida' 'none' |
| spatialIndexes | Lista de detalles espaciales | SpatialSpec[] |
CompositePath
| Nombre | Descripción | Valor |
|---|---|---|
| orden | Criterio de ordenación de las rutas de acceso compuestas. | 'ascendente' 'descendente' |
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
ExcludedPath
| Nombre | Descripción | Value |
|---|---|---|
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
IncludedPath
| Nombre | Descripción | Valor |
|---|---|---|
| índices | Lista de índices para esta ruta de acceso | Índices[] |
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
Índices
| Nombre | Descripción | Valor |
|---|---|---|
| dataType | Tipo de datos al que se aplica el comportamiento de indexación. | 'LineString' "MultiPolygon" 'Number' 'Point' 'Polygon' 'String' |
| kind | Indica el tipo de índice. | 'Hash' 'Range' "Espacial" |
| Precisión | Precisión del índice. -1 es la precisión máxima. | int |
SpatialSpec
| Nombre | Descripción | Value |
|---|---|---|
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
| types | Lista del tipo espacial de la ruta de acceso | Matriz de cadenas que contiene cualquiera de: 'LineString' "MultiPolygon" 'Point' 'Polygon' |
ContainerPartitionKey
| Nombre | Descripción | Valor |
|---|---|---|
| kind | Indica el tipo de algoritmo utilizado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres máximos) para la creación de contenedores. | 'Hash' "MultiHash" 'Range' |
| rutas | Lista de rutas de acceso mediante las que se pueden crear particiones de datos dentro del contenedor | string[] |
| version | Indica la versión de la definición de clave de partición. | int Restricciones: Valor mínimo = 1 Valor máximo = 2 |
ResourceRestoreParameters
| Nombre | Descripción | Valor |
|---|---|---|
| restoreSource | Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Hora a la que se debe restaurar la cuenta (formato ISO-8601). | string |
UniqueKeyPolicy
| Nombre | Descripción | Valor |
|---|---|---|
| uniqueKeys | Lista de claves únicas en que aplica la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nombre | Descripción | Valor |
|---|---|---|
| rutas | La lista de rutas de acceso debe ser única para cada documento del servicio Azure Cosmos DB. | string[] |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
Creación de una cuenta de Azure Cosmos DB para Gremlin API |
Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento dedicado. |
| Creación de una cuenta de Azure Cosmos DB para el escalado automático de Gremlin API |
Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento de escalado automático. |
Definición de recursos de plantilla de ARM
El tipo de recurso databaseAccounts/gremlinDatabases/graphs se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
"apiVersion": "2023-09-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": {
"analyticalStorageTtl": "int",
"conflictResolutionPolicy": {
"conflictResolutionPath": "string",
"conflictResolutionProcedure": "string",
"mode": "string"
},
"createMode": "string",
"defaultTtl": "int",
"id": "string",
"indexingPolicy": {
"automatic": "bool",
"compositeIndexes": [
{
"order": "string",
"path": "string"
}
],
"excludedPaths": [
{
"path": "string"
}
],
"includedPaths": [
{
"indexes": [
{
"dataType": "string",
"kind": "string",
"precision": "int"
}
],
"path": "string"
}
],
"indexingMode": "string",
"spatialIndexes": [
{
"path": "string",
"types": [ "string" ]
}
]
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ],
"version": "int"
},
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
Valores de propiedad
databaseAccounts/gremlinDatabases/graphs
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs' |
| apiVersion | La versión de la API de recursos | '2023-09-15-preview' |
| name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM JSON. |
string (obligatorio) |
| ubicación | Ubicación del grupo de recursos al que pertenece el recurso. | string |
| etiquetas | Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". | Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas. |
| identidad | Identidad del recurso. | ManagedServiceIdentity |
| properties | Propiedades para crear y actualizar el grafo de Gremlin de Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (obligatorio) |
ManagedServiceIdentity
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. | 'Ninguno' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
| Nombre | Descripción | Value |
|---|---|---|
| opciones | Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
| resource | Formato JSON estándar de un grafo de Gremlin | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (obligatorio) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
| Nombre | Descripción | Valor |
|---|---|---|
| autoscaleSettings | Especifica la configuración de escalabilidad automática. Nota: Se requiere rendimiento o escalado automáticoConfiguración, pero no ambos. | AutoscaleSettings |
| throughput | Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. | int |
AutoscaleSettings
| Nombre | Descripción | Valor |
|---|---|---|
| maxThroughput | Representa el rendimiento máximo, el recurso se puede escalar verticalmente. | int |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
| Nombre | Descripción | Valor |
|---|---|---|
| analyticalStorageTtl | TTL analítico. | int |
| conflictResolutionPolicy | Directiva de resolución de conflictos para el gráfico. | ConflictResolutionPolicy |
| createMode | Enumeración para indicar el modo de creación de recursos. | 'Default' 'PointInTimeRestore' 'Restaurar' |
| defaultTtl | Período de vida predeterminado | int |
| id | Nombre del grafo gremlin de Cosmos DB | string (obligatorio) |
| indexingPolicy | Configuración de la directiva de indexación. De forma predeterminada, la indexación es automática para todas las rutas de acceso de documento dentro del gráfico. | IndexingPolicy |
| partitionKey | Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones | ContainerPartitionKey |
| restoreParameters | Parámetros para indicar la información sobre la restauración | ResourceRestoreParameters |
| uniqueKeyPolicy | Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. | UniqueKeyPolicy |
ConflictResolutionPolicy
| Nombre | Descripción | Valor |
|---|---|---|
| conflictResolutionPath | Ruta de acceso de resolución de conflictos en el caso del modo LastWriterWins. | string |
| conflictResolutionProcedure | Procedimiento para resolver conflictos en el caso del modo personalizado. | string |
| mode | Indica el modo de resolución de conflictos. | 'Personalizado' 'LastWriterWins' |
IndexingPolicy
| Nombre | Descripción | Valor |
|---|---|---|
| automatic | Indica si la directiva de indexación es automática. | bool |
| compositeIndexes | Lista de listas de rutas de acceso compuestas | CompositePath[] |
| excludedPaths | Lista de rutas de acceso que se van a excluir de la indexación | ExcludedPath[] |
| includedPaths | Lista de rutas de acceso que se van a incluir en la indexación | IncludedPath[] |
| indexingMode | Indica el modo de indexación. | "coherente" 'diferida' 'none' |
| spatialIndexes | Lista de detalles espaciales | SpatialSpec[] |
CompositePath
| Nombre | Descripción | Valor |
|---|---|---|
| orden | Criterio de ordenación de las rutas de acceso compuestas. | 'ascendente' 'descendente' |
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
ExcludedPath
| Nombre | Descripción | Value |
|---|---|---|
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
IncludedPath
| Nombre | Descripción | Valor |
|---|---|---|
| índices | Lista de índices para esta ruta de acceso | Índices[] |
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
Índices
| Nombre | Descripción | Valor |
|---|---|---|
| dataType | Tipo de datos al que se aplica el comportamiento de indexación. | 'LineString' "MultiPolygon" 'Number' 'Point' 'Polygon' 'String' |
| kind | Indica el tipo de índice. | 'Hash' 'Range' "Espacial" |
| Precisión | Precisión del índice. -1 es la precisión máxima. | int |
SpatialSpec
| Nombre | Descripción | Value |
|---|---|---|
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
| types | Lista del tipo espacial de la ruta de acceso | Matriz de cadenas que contiene cualquiera de: 'LineString' "MultiPolygon" 'Point' 'Polygon' |
ContainerPartitionKey
| Nombre | Descripción | Valor |
|---|---|---|
| kind | Indica el tipo de algoritmo utilizado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres máximos) para la creación de contenedores. | 'Hash' "MultiHash" 'Range' |
| rutas | Lista de rutas de acceso mediante las que se pueden crear particiones de datos dentro del contenedor | string[] |
| version | Indica la versión de la definición de clave de partición. | int Restricciones: Valor mínimo = 1 Valor máximo = 2 |
ResourceRestoreParameters
| Nombre | Descripción | Valor |
|---|---|---|
| restoreSource | Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Hora a la que se debe restaurar la cuenta (formato ISO-8601). | string |
UniqueKeyPolicy
| Nombre | Descripción | Valor |
|---|---|---|
| uniqueKeys | Lista de claves únicas en las que aplica la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nombre | Descripción | Valor |
|---|---|---|
| rutas | La lista de rutas de acceso debe ser única para cada documento del servicio Azure Cosmos DB. | string[] |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
| Plantilla | Descripción |
|---|---|
| Creación de una cuenta de Azure Cosmos DB para Gremlin API |
Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento dedicado. |
| Creación de una cuenta de Azure Cosmos DB para el escalado automático de Gremlin API |
Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento de escalado automático. |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso databaseAccounts/gremlinDatabases/graphs se puede implementar con operaciones destinadas a:
- Grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-09-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 = {
analyticalStorageTtl = int
conflictResolutionPolicy = {
conflictResolutionPath = "string"
conflictResolutionProcedure = "string"
mode = "string"
}
createMode = "string"
defaultTtl = int
id = "string"
indexingPolicy = {
automatic = bool
compositeIndexes = [
{
order = "string"
path = "string"
}
]
excludedPaths = [
{
path = "string"
}
]
includedPaths = [
{
indexes = [
{
dataType = "string"
kind = "string"
precision = int
}
]
path = "string"
}
]
indexingMode = "string"
spatialIndexes = [
{
path = "string"
types = [
"string"
]
}
]
}
partitionKey = {
kind = "string"
paths = [
"string"
]
version = int
}
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
Valores de propiedad
databaseAccounts/gremlinDatabases/graphs
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2023-09-15-preview" |
| name | El nombre del recurso | string (obligatorio) |
| ubicación | Ubicación del grupo de recursos al que pertenece el recurso. | string |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: gremlinDatabases |
| etiquetas | Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". | Diccionario de nombres y valores de etiqueta. |
| identidad | Identidad del recurso. | ManagedServiceIdentity |
| properties | Propiedades para crear y actualizar el grafo de Gremlin de Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... (obligatorio) |
ManagedServiceIdentity
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
| identity_ids | Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | Matriz de identificadores de identidad de usuario. |
ManagedServiceIdentityUserAssignedIdentities
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.
GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...
| Nombre | Descripción | Value |
|---|---|---|
| opciones | Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. | CreateUpdateOptionsOrGremlinGraphGetPropertiesOption... |
| resource | Formato JSON estándar de un grafo de Gremlin | GremlinGraphResourceOrGremlinGraphGetPropertiesResou... (obligatorio) |
CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...
| Nombre | Descripción | Valor |
|---|---|---|
| autoscaleSettings | Especifica la configuración de escalado automático. Nota: Se requiere el rendimiento o el escalado automáticoConfiguración, pero no ambos. | AutoscaleSettings |
| throughput | Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. | int |
AutoscaleSettings
| Nombre | Descripción | Valor |
|---|---|---|
| maxThroughput | Representa el rendimiento máximo, el recurso se puede escalar verticalmente. | int |
GremlinGraphResourceOrGremlinGraphGetPropertiesResou...
| Nombre | Descripción | Valor |
|---|---|---|
| analyticalStorageTtl | TTL analítico. | int |
| conflictResolutionPolicy | Directiva de resolución de conflictos para el gráfico. | ConflictResolutionPolicy |
| createMode | Enumeración para indicar el modo de creación de recursos. | "Valor predeterminado" "PointInTimeRestore" "Restaurar" |
| defaultTtl | Período de vida predeterminado | int |
| id | Nombre del grafo gremlin de Cosmos DB | string (obligatorio) |
| indexingPolicy | Configuración de la directiva de indexación. De forma predeterminada, la indexación es automática para todas las rutas de acceso de documento dentro del gráfico. | IndexingPolicy |
| partitionKey | Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones | ContainerPartitionKey |
| restoreParameters | Parámetros para indicar la información sobre la restauración | ResourceRestoreParameters |
| uniqueKeyPolicy | Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. | UniqueKeyPolicy |
ConflictResolutionPolicy
| Nombre | Descripción | Valor |
|---|---|---|
| conflictResolutionPath | Ruta de acceso de resolución de conflictos en el caso del modo LastWriterWins. | string |
| conflictResolutionProcedure | Procedimiento para resolver conflictos en el caso del modo personalizado. | string |
| mode | Indica el modo de resolución de conflictos. | "Custom" "LastWriterWins" |
IndexingPolicy
| Nombre | Descripción | Valor |
|---|---|---|
| automatic | Indica si la directiva de indexación es automática. | bool |
| compositeIndexes | Lista de listas de rutas de acceso compuestas | CompositePath[] |
| excludedPaths | Lista de rutas de acceso que se van a excluir de la indexación | ExcludedPath[] |
| includedPaths | Lista de rutas de acceso que se van a incluir en la indexación | IncludedPath[] |
| indexingMode | Indica el modo de indexación. | "coherente" "diferida" "none" |
| spatialIndexes | Lista de detalles espaciales | SpatialSpec[] |
CompositePath
| Nombre | Descripción | Valor |
|---|---|---|
| orden | Criterio de ordenación de las rutas de acceso compuestas. | "ascendente" "descendente" |
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
ExcludedPath
| Nombre | Descripción | Value |
|---|---|---|
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
IncludedPath
| Nombre | Descripción | Valor |
|---|---|---|
| índices | Lista de índices para esta ruta de acceso | Índices[] |
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
Índices
| Nombre | Descripción | Valor |
|---|---|---|
| dataType | Tipo de datos al que se aplica el comportamiento de indexación. | "LineString" "MultiPolygon" "Número" "Point" "Polígono" "String" |
| kind | Indica el tipo de índice. | "Hash" "Rango" "Espacial" |
| Precisión | Precisión del índice. -1 es la precisión máxima. | int |
SpatialSpec
| Nombre | Descripción | Value |
|---|---|---|
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) | string |
| types | Lista del tipo espacial de la ruta de acceso | Matriz de cadenas que contiene cualquiera de: "LineString" "MultiPolygon" "Point" "Polígono" |
ContainerPartitionKey
| Nombre | Descripción | Valor |
|---|---|---|
| kind | Indica el tipo de algoritmo utilizado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres máximos) para la creación de contenedores. | "Hash" "MultiHash" "Rango" |
| rutas | Lista de rutas de acceso mediante las que se pueden crear particiones de datos dentro del contenedor | string[] |
| version | Indica la versión de la definición de clave de partición. | int Restricciones: Valor mínimo = 1 Valor máximo = 2 |
ResourceRestoreParameters
| Nombre | Descripción | Valor |
|---|---|---|
| restoreSource | Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | string |
| restoreTimestampInUtc | Hora a la que se debe restaurar la cuenta (formato ISO-8601). | string |
UniqueKeyPolicy
| Nombre | Descripción | Valor |
|---|---|---|
| uniqueKeys | Lista de claves únicas en las que aplica la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nombre | Descripción | Valor |
|---|---|---|
| rutas | La lista de rutas de acceso debe ser única para cada documento del servicio Azure Cosmos DB. | string[] |