Base de datos Microsoft.DocumentDBAccounts/apis/databases/graphs 2016-03-31
Definición de recursos de Bicep
El tipo de recurso databaseAccounts/apis/databases/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/apis/databases/graphs, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-31' = {
name: 'string'
parent: resourceSymbolicName
properties: {
options: {
{customized property}: 'string'
}
resource: {
conflictResolutionPolicy: {
conflictResolutionPath: 'string'
conflictResolutionProcedure: 'string'
mode: 'string'
}
defaultTtl: int
id: 'string'
indexingPolicy: {
automatic: bool
excludedPaths: [
{
path: 'string'
}
]
includedPaths: [
{
indexes: [
{
dataType: 'string'
kind: 'string'
precision: int
}
]
path: 'string'
}
]
indexingMode: 'string'
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
Valores de propiedad
databaseAccounts/apis/databases/graphs
| Nombre | Descripción | Value |
|---|---|---|
| name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep. |
string (obligatorio) |
| 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: bases de datos |
| properties | Propiedades para crear y actualizar el grafo de Gremlin de Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (obligatorio) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...
| 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. | CreateUpdateOptions (obligatorio) |
| resource | Formato JSON estándar de un grafo de Gremlin | GremlinGraphResource (obligatorio) |
CreateUpdateOptions
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | string |
GremlinGraphResource
| Nombre | Descripción | Valor |
|---|---|---|
| conflictResolutionPolicy | Directiva de resolución de conflictos para el gráfico. | ConflictResolutionPolicy |
| 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 |
| 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 |
| 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' 'Diferido' 'Ninguno' |
ExcludedPath
| Nombre | Descripción | Value |
|---|---|---|
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con raíz y terminan 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. Normalmente, las rutas de acceso de índice comienzan con raíz y terminan 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' 'Range' 'Spatial' |
| Precisión | Precisión del índice. -1 es la precisión máxima. | int |
ContainerPartitionKey
| Nombre | Descripción | Valor |
|---|---|---|
| kind | Indica el tipo de algoritmo utilizado para la creación de particiones. | 'Hash' 'Range' |
| rutas | Lista de rutas de acceso con las que se pueden crear particiones de datos dentro del contenedor | 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[] |
Definición de recursos de plantilla de ARM
El tipo de recurso databaseAccounts/apis/databases/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/apis/databases/graphs, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs",
"apiVersion": "2016-03-31",
"name": "string",
"properties": {
"options": {
"{customized property}": "string"
},
"resource": {
"conflictResolutionPolicy": {
"conflictResolutionPath": "string",
"conflictResolutionProcedure": "string",
"mode": "string"
},
"defaultTtl": "int",
"id": "string",
"indexingPolicy": {
"automatic": "bool",
"excludedPaths": [
{
"path": "string"
}
],
"includedPaths": [
{
"indexes": [
{
"dataType": "string",
"kind": "string",
"precision": "int"
}
],
"path": "string"
}
],
"indexingMode": "string"
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ]
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
Valores de propiedad
databaseAccounts/apis/databases/graphs
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | 'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs' |
| apiVersion | La versión de la API de recursos | '2016-03-31' |
| name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM JSON. |
string (obligatorio) |
| properties | Propiedades para crear y actualizar el grafo de Gremlin de Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (obligatorio) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...
| 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. | CreateUpdateOptions (obligatorio) |
| resource | Formato JSON estándar de un grafo de Gremlin | GremlinGraphResource (obligatorio) |
CreateUpdateOptions
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | string |
GremlinGraphResource
| Nombre | Descripción | Valor |
|---|---|---|
| conflictResolutionPolicy | Directiva de resolución de conflictos para el gráfico. | ConflictResolutionPolicy |
| defaultTtl | Período de vida predeterminado | int |
| id | Nombre del grafo de 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 |
| 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 |
| excludedPaths | Lista de rutas de acceso para 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' 'Diferido' 'Ninguno' |
ExcludedPath
| Nombre | Descripción | Value |
|---|---|---|
| path | Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con raíz y terminan 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. Normalmente, las rutas de acceso de índice comienzan con raíz y terminan 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' 'Range' "Espacial" |
| Precisión | Precisión del índice. -1 es la precisión máxima. | int |
ContainerPartitionKey
| Nombre | Descripción | Valor |
|---|---|---|
| kind | Indica el tipo de algoritmo usado para la creación de particiones. | 'Hash' 'Range' |
| rutas | Lista de rutas de acceso mediante las que se pueden crear particiones de datos dentro del contenedor | 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[] |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso databaseAccounts/apis/databases/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/apis/databases/graphs, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-31"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
options = {
{customized property} = "string"
}
resource = {
conflictResolutionPolicy = {
conflictResolutionPath = "string"
conflictResolutionProcedure = "string"
mode = "string"
}
defaultTtl = int
id = "string"
indexingPolicy = {
automatic = bool
excludedPaths = [
{
path = "string"
}
]
includedPaths = [
{
indexes = [
{
dataType = "string"
kind = "string"
precision = int
}
]
path = "string"
}
]
indexingMode = "string"
}
partitionKey = {
kind = "string"
paths = [
"string"
]
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
Valores de propiedad
databaseAccounts/apis/databases/graphs
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-31" |
| name | El nombre del recurso | string (obligatorio) |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: bases de datos |
| properties | Propiedades para crear y actualizar el grafo de Gremlin de Azure Cosmos DB. | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... (obligatorio) |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...
| 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. | CreateUpdateOptions (obligatorio) |
| resource | Formato JSON estándar de un grafo de Gremlin | GremlinGraphResource (obligatorio) |
CreateUpdateOptions
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | string |
GremlinGraphResource
| Nombre | Descripción | Valor |
|---|---|---|
| conflictResolutionPolicy | Directiva de resolución de conflictos para el gráfico. | ConflictResolutionPolicy |
| 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 |
| 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 |
| 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" "Diferido" "None" |
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 |
ContainerPartitionKey
| Nombre | Descripción | Valor |
|---|---|---|
| kind | Indica el tipo de algoritmo usado para la creación de particiones. | "Hash" "Rango" |
| rutas | Lista de rutas de acceso mediante las que se pueden crear particiones de datos dentro del contenedor | 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[] |