Microsoft.DocumentDB mongoClusters 2023-03-15-preview

Artículo
06/03/2024

Definición de recursos de Bicep

El tipo de recurso mongoClusters 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/mongoClusters, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2023-03-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    createMode: 'string'
    nodeGroupSpecs: [
      {
        diskSizeGB: int
        enableHa: bool
        kind: 'Shard'
        nodeCount: int
        sku: 'string'
      }
    ]
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
  }
}

Valores de propiedad

mongoClusters

Nombre	Descripción	Value
name	El nombre del recurso	string (obligatorio)
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
properties	Propiedades del clúster de mongo.	MongoClusterProperties

MongoClusterProperties

Nombre	Descripción	Valor
administratorLogin	Inicio de sesión del administrador para el clúster de Mongo.	string
administratorLoginPassword	La contraseña del inicio de sesión del administrador.	string Restricciones: Valor confidencial. Pase como parámetro seguro.
createMode	Modo para crear un clúster de Mongo.	'Default' 'PointInTimeRestore' 'Restaurar'
nodeGroupSpecs	Lista de especificaciones de grupo de nodos en el clúster.	NodeGroupSpec[] Restricciones: Longitud mínima = 1
restoreParameters	Parámetros usados para las operaciones de restauración	MongoClusterRestoreParameters
serverVersion	La versión del servidor de Mongo DB. El valor predeterminado es la versión más reciente disponible si no se especifica.	string

NodeGroupSpec

Nombre	Descripción	Valor
diskSizeGB	Tamaño de almacenamiento en disco para el grupo de nodos en GB. Valores de ejemplo: 128, 256, 512, 1024.	int
enableHa	Si la alta disponibilidad está habilitada en el grupo de nodos.	bool
kind	Tipo de nodo implementado en el grupo de nodos.	'Partición'
nodeCount	Número de nodos del grupo de nodos.	int
sku	SKU de recursos para el grupo de nodos. Esto define el tamaño de la CPU y la memoria que se aprovisiona para cada nodo. Valores de ejemplo: "M30", "M40".	string

MongoClusterRestoreParameters

Nombre	Descripción	Valor
pointInTimeUTC	Hora UTC en el tiempo para restaurar un clúster de Mongo	string
sourceResourceId	Identificador de recurso para buscar el clúster de origen que se va a restaurar	string

Definición de recursos de plantilla de ARM

El tipo de recurso mongoClusters 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/mongoClusters, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "createMode": "string",
    "nodeGroupSpecs": [
      {
        "diskSizeGB": "int",
        "enableHa": "bool",
        "kind": "Shard",
        "nodeCount": "int",
        "sku": "string"
      }
    ],
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string"
  }
}

Valores de propiedad

mongoClusters

Nombre	Descripción	Value
type	Tipo de recurso	'Microsoft.DocumentDB/mongoClusters'
apiVersion	La versión de la API de recursos	'2023-03-15-preview'
name	El nombre del recurso	string (obligatorio)
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
properties	Propiedades del clúster de Mongo.	MongoClusterProperties

MongoClusterProperties

Nombre	Descripción	Valor
administratorLogin	Inicio de sesión del administrador para el clúster de Mongo.	string
administratorLoginPassword	Contraseña del inicio de sesión del administrador.	string Restricciones: Valor confidencial. Pase como parámetro seguro.
createMode	Modo para crear un clúster de Mongo.	'Default' 'PointInTimeRestore' 'Restaurar'
nodeGroupSpecs	Lista de especificaciones de grupo de nodos en el clúster.	NodeGroupSpec[] Restricciones: Longitud mínima = 1
restoreParameters	Parámetros usados para las operaciones de restauración	MongoClusterRestoreParameters
serverVersion	La versión del servidor de Mongo DB. El valor predeterminado es la versión disponible más reciente si no se especifica.	string

NodeGroupSpec

Nombre	Descripción	Valor
diskSizeGB	Tamaño de almacenamiento en disco para el grupo de nodos en GB. Valores de ejemplo: 128, 256, 512, 1024.	int
enableHa	Si la alta disponibilidad está habilitada en el grupo de nodos.	bool
kind	Tipo de nodo implementado en el grupo de nodos.	'Partición'
nodeCount	Número de nodos del grupo de nodos.	int
sku	SKU de recursos para el grupo de nodos. Esto define el tamaño de la CPU y la memoria que se aprovisiona para cada nodo. Valores de ejemplo: "M30", "M40".	string

MongoClusterRestoreParameters

Nombre	Descripción	Valor
pointInTimeUTC	Hora UTC en el tiempo para restaurar un clúster de Mongo	string
sourceResourceId	Identificador de recurso para buscar el clúster de origen que se va a restaurar	string

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso mongoClusters 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/mongoClusters, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2023-03-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      createMode = "string"
      nodeGroupSpecs = [
        {
          diskSizeGB = int
          enableHa = bool
          kind = "Shard"
          nodeCount = int
          sku = "string"
        }
      ]
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
    }
  })
}

Valores de propiedad

mongoClusters

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft.DocumentDB/mongoClusters@2023-03-15-preview"
name	El nombre del recurso	string (obligatorio)
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
parent_id	Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos.	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta.
properties	Propiedades del clúster de mongo.	MongoClusterProperties

MongoClusterProperties

Nombre	Descripción	Valor
administratorLogin	Inicio de sesión del administrador para el clúster de Mongo.	string
administratorLoginPassword	La contraseña del inicio de sesión del administrador.	string Restricciones: Valor confidencial. Pase como parámetro seguro.
createMode	Modo para crear un clúster de Mongo.	"Valor predeterminado" "PointInTimeRestore" "Restaurar"
nodeGroupSpecs	Lista de especificaciones de grupo de nodos en el clúster.	NodeGroupSpec[] Restricciones: Longitud mínima = 1
restoreParameters	Parámetros usados para las operaciones de restauración	MongoClusterRestoreParameters
serverVersion	La versión del servidor de Mongo DB. El valor predeterminado es la versión más reciente disponible si no se especifica.	string

NodeGroupSpec

Nombre	Descripción	Valor
diskSizeGB	Tamaño de almacenamiento en disco para el grupo de nodos en GB. Valores de ejemplo: 128, 256, 512, 1024.	int
enableHa	Si la alta disponibilidad está habilitada en el grupo de nodos.	bool
kind	Tipo de nodo implementado en el grupo de nodos.	"Partición"
nodeCount	Número de nodos del grupo de nodos.	int
sku	SKU de recursos para el grupo de nodos. Esto define el tamaño de la CPU y la memoria que se aprovisiona para cada nodo. Valores de ejemplo: "M30", "M40".	string

MongoClusterRestoreParameters

Nombre	Descripción	Valor
pointInTimeUTC	Hora UTC en el tiempo para restaurar un clúster de Mongo	string
sourceResourceId	Identificador de recurso para buscar el clúster de origen que se va a restaurar	string

Compartir a través de

Microsoft.DocumentDB mongoClusters 2023-03-15-preview

Definición de recursos de Bicep

Formato de los recursos

Valores de propiedad

mongoClusters

MongoClusterProperties

NodeGroupSpec

MongoClusterRestoreParameters

Definición de recursos de plantilla de ARM

Formato de los recursos

Valores de propiedad

mongoClusters

MongoClusterProperties

NodeGroupSpec

MongoClusterRestoreParameters

Definición de recursos de Terraform (proveedor AzAPI)

Formato de los recursos

Valores de propiedad

mongoClusters

MongoClusterProperties

NodeGroupSpec

MongoClusterRestoreParameters

Comentarios

Recursos adicionales