Microsoft.DocumentDB mongoClusters 2024-06-01-preview

Artículo
12/18/2024

Definición de recursos de Bicep

El tipo de recurso mongoClusters se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/mongoClusters, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-06-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    createMode: 'string'
    nodeGroupSpecs: [
      {
        diskSizeGB: int
        enableHa: bool
        kind: 'string'
        nodeCount: int
        sku: 'string'
      }
    ]
    previewFeatures: [
      'string'
    ]
    publicNetworkAccess: 'string'
    replicaParameters: {
      sourceLocation: 'string'
      sourceResourceId: 'string'
    }
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

Microsoft.DocumentDB/mongoClusters

Nombre	Descripción	Valor
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 3 Longitud máxima = 40 Patrón = `^[a-z0-9]+(-[a-z0-9]+)*` (obligatorio)
Propiedades	Propiedades específicas del recurso para este recurso.	MongoClusterProperties
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

MongoClusterProperties

Nombre	Descripción	Valor
administratorLogin	Inicio de sesión del administrador para el clúster de mongo.	cuerda
administratorLoginPassword	Contraseña del inicio de sesión del administrador.	cuerda Restricciones: Valor confidencial. Pase como parámetro seguro.
createMode	Modo para crear un clúster de Mongo.	'Valor predeterminado' 'GeoReplica' 'PointInTimeRestore' 'Réplica'
nodeGroupSpecs	Lista de especificaciones de grupo de nodos en el clúster.	NodeGroupSpec []
previewFeatures	Lista de conexiones de punto de conexión privado.	Matriz de cadenas que contiene cualquiera de: 'GeoReplicas'
publicNetworkAccess	Indica si se permite o no el acceso al punto de conexión público para este clúster de Mongo.	'Deshabilitado' 'Habilitado'
replicaParameters	Parámetros para crear un clúster de mongo de réplica.	MongoClusterReplicaParameters
restoreParameters	Los parámetros para crear un clúster de mongo de restauración a un momento dado.	MongoClusterRestoreParameters
serverVersion	Versión del servidor de Mongo DB. El valor predeterminado es la versión más reciente disponible si no se especifica.	cuerda

MongoClusterReplicaParameters

Nombre	Descripción	Valor
sourceLocation	Ubicación del clúster de origen	string (obligatorio)
sourceResourceId	Identificador del clúster de origen de replicación.	string (obligatorio)

MongoClusterRestoreParameters

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

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
amable	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".	cuerda

TrackedResourceTags

Nombre	Descripción	Valor

Ejemplos de uso

Módulos comprobados de Azure

Los siguientes módulos comprobados de Azure se pueden usar para implementar este tipo de recurso.

Módulo	Descripción
cosmos DB para MongoDB (núcleo virtual)	Módulo de recursos de AVM para Cosmos DB para MongoDB (núcleo virtual)

Definición de recursos de plantilla de ARM

El tipo de recurso mongoClusters se puede implementar con operaciones destinadas a:

grupos de recursos: consulte comandos de implementación de grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/mongoClusters, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "createMode": "string",
    "nodeGroupSpecs": [
      {
        "diskSizeGB": "int",
        "enableHa": "bool",
        "kind": "string",
        "nodeCount": "int",
        "sku": "string"
      }
    ],
    "previewFeatures": [ "string" ],
    "publicNetworkAccess": "string",
    "replicaParameters": {
      "sourceLocation": "string",
      "sourceResourceId": "string"
    },
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

Microsoft.DocumentDB/mongoClusters

Nombre	Descripción	Valor
apiVersion	La versión de api	'2024-06-01-preview'
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 3 Longitud máxima = 40 Patrón = `^[a-z0-9]+(-[a-z0-9]+)*` (obligatorio)
Propiedades	Propiedades específicas del recurso para este recurso.	MongoClusterProperties
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo	El tipo de recurso	'Microsoft.DocumentDB/mongoClusters'

MongoClusterProperties

Nombre	Descripción	Valor
administratorLogin	Inicio de sesión del administrador para el clúster de mongo.	cuerda
administratorLoginPassword	Contraseña del inicio de sesión del administrador.	cuerda Restricciones: Valor confidencial. Pase como parámetro seguro.
createMode	Modo para crear un clúster de Mongo.	'Valor predeterminado' 'GeoReplica' 'PointInTimeRestore' 'Réplica'
nodeGroupSpecs	Lista de especificaciones de grupo de nodos en el clúster.	NodeGroupSpec []
previewFeatures	Lista de conexiones de punto de conexión privado.	Matriz de cadenas que contiene cualquiera de: 'GeoReplicas'
publicNetworkAccess	Indica si se permite o no el acceso al punto de conexión público para este clúster de Mongo.	'Deshabilitado' 'Habilitado'
replicaParameters	Parámetros para crear un clúster de mongo de réplica.	MongoClusterReplicaParameters
restoreParameters	Los parámetros para crear un clúster de mongo de restauración a un momento dado.	MongoClusterRestoreParameters
serverVersion	Versión del servidor de Mongo DB. El valor predeterminado es la versión más reciente disponible si no se especifica.	cuerda

MongoClusterReplicaParameters

Nombre	Descripción	Valor
sourceLocation	Ubicación del clúster de origen	string (obligatorio)
sourceResourceId	Identificador del clúster de origen de replicación.	string (obligatorio)

MongoClusterRestoreParameters

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

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
amable	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".	cuerda

TrackedResourceTags

Nombre	Descripción	Valor

Ejemplos de uso

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso mongoClusters se puede implementar con operaciones destinadas a:

grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.DocumentDB/mongoClusters, agregue el siguiente Terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2024-06-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      createMode = "string"
      nodeGroupSpecs = [
        {
          diskSizeGB = int
          enableHa = bool
          kind = "string"
          nodeCount = int
          sku = "string"
        }
      ]
      previewFeatures = [
        "string"
      ]
      publicNetworkAccess = "string"
      replicaParameters = {
        sourceLocation = "string"
        sourceResourceId = "string"
      }
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
    }
  })
}

Valores de propiedad

Microsoft.DocumentDB/mongoClusters

Nombre	Descripción	Valor
ubicación	Ubicación geográfica donde reside el recurso	string (obligatorio)
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 3 Longitud máxima = 40 Patrón = `^[a-z0-9]+(-[a-z0-9]+)*` (obligatorio)
Propiedades	Propiedades específicas del recurso para este recurso.	MongoClusterProperties
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta.
tipo	El tipo de recurso	"Microsoft.DocumentDB/mongoClusters@2024-06-01-preview"

MongoClusterProperties

Nombre	Descripción	Valor
administratorLogin	Inicio de sesión del administrador para el clúster de mongo.	cuerda
administratorLoginPassword	Contraseña del inicio de sesión del administrador.	cuerda Restricciones: Valor confidencial. Pase como parámetro seguro.
createMode	Modo para crear un clúster de Mongo.	'Valor predeterminado' 'GeoReplica' 'PointInTimeRestore' 'Réplica'
nodeGroupSpecs	Lista de especificaciones de grupo de nodos en el clúster.	NodeGroupSpec []
previewFeatures	Lista de conexiones de punto de conexión privado.	Matriz de cadenas que contiene cualquiera de: 'GeoReplicas'
publicNetworkAccess	Indica si se permite o no el acceso al punto de conexión público para este clúster de Mongo.	'Deshabilitado' 'Habilitado'
replicaParameters	Parámetros para crear un clúster de mongo de réplica.	MongoClusterReplicaParameters
restoreParameters	Los parámetros para crear un clúster de mongo de restauración a un momento dado.	MongoClusterRestoreParameters
serverVersion	Versión del servidor de Mongo DB. El valor predeterminado es la versión más reciente disponible si no se especifica.	cuerda

MongoClusterReplicaParameters

Nombre	Descripción	Valor
sourceLocation	Ubicación del clúster de origen	string (obligatorio)
sourceResourceId	Identificador del clúster de origen de replicación.	string (obligatorio)

MongoClusterRestoreParameters

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

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
amable	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".	cuerda

TrackedResourceTags

Nombre	Descripción	Valor

Compartir a través de

Microsoft.DocumentDB mongoClusters 2024-06-01-preview

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

NodeGroupSpec

TrackedResourceTags

Ejemplos de uso

Módulos comprobados de Azure

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

NodeGroupSpec

TrackedResourceTags

Ejemplos de uso

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

NodeGroupSpec

TrackedResourceTags

Comentarios

Recursos adicionales