MongoClusters de Microsoft.DocumentDB
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-10-01-preview' = {
location: 'string'
name: 'string'
properties: {
administrator: {
password: 'string'
userName: 'string'
}
backup: {}
compute: {
tier: 'string'
}
createMode: 'string'
dataApi: {
mode: 'string'
}
highAvailability: {
targetMode: 'string'
}
previewFeatures: [
'string'
]
publicNetworkAccess: 'string'
replicaParameters: {
sourceLocation: 'string'
sourceResourceId: 'string'
}
restoreParameters: {
pointInTimeUTC: 'string'
sourceResourceId: 'string'
}
serverVersion: 'string'
sharding: {
shardCount: int
}
storage: {
sizeGb: int
}
}
tags: {
{customized property}: 'string'
}
}
Valores de propiedad
AdministratorProperties
Nombre | Descripción | Valor |
---|---|---|
contraseña | Contraseña de administrador. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
nombre de usuario | Nombre de usuario del administrador. | cuerda |
BackupProperties
Nombre | Descripción | Valor |
---|
ComputeProperties
Nombre | Descripción | Valor |
---|---|---|
nivel | Nivel de proceso que se va a asignar al clúster, donde cada nivel se asigna a un tamaño de núcleo virtual y memoria. Valores de ejemplo: "M30", "M40". | cuerda |
DataApiProperties
Nombre | Descripción | Valor |
---|---|---|
modo | Modo que indica si la API de datos de Mongo está habilitada para un clúster. | 'Deshabilitado' 'Habilitado' |
HighAvailabilityProperties
Nombre | Descripción | Valor |
---|---|---|
targetMode | Modo de alta disponibilidad de destino solicitado para el clúster. | 'Deshabilitado' 'SameZone' 'ZoneRedundantPreferred' |
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 = 3 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 |
---|---|---|
administrador | Propiedades de administrador local para el clúster de mongo. | |
copia de seguridad | Propiedades de copia de seguridad del clúster de mongo. | BackupProperties |
calcular | Propiedades de proceso del clúster de mongo. | ComputeProperties de |
createMode | Modo para crear un clúster de Mongo. | 'Valor predeterminado' 'GeoReplica' 'PointInTimeRestore' 'Réplica' |
dataApi | Las propiedades de Data API del clúster de mongo. | DataApiProperties |
highAvailability | Propiedades de alta disponibilidad del clúster de mongo. | HighAvailabilityProperties |
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 |
particionamiento | Propiedades de particionamiento del clúster de mongo. | ShardingProperties |
almacenamiento | Propiedades de almacenamiento del clúster de mongo. | StorageProperties |
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 |
ShardingProperties
Nombre | Descripción | Valor |
---|---|---|
shardCount | Número de particiones que se van a aprovisionar en el clúster. | Int |
StorageProperties
Nombre | Descripción | Valor |
---|---|---|
sizeGb | Tamaño del disco de datos asignado a cada servidor. | Int |
TrackedResourceTags
Nombre | Descripción | Valor |
---|
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-10-01-preview",
"name": "string",
"location": "string",
"properties": {
"administrator": {
"password": "string",
"userName": "string"
},
"backup": {
},
"compute": {
"tier": "string"
},
"createMode": "string",
"dataApi": {
"mode": "string"
},
"highAvailability": {
"targetMode": "string"
},
"previewFeatures": [ "string" ],
"publicNetworkAccess": "string",
"replicaParameters": {
"sourceLocation": "string",
"sourceResourceId": "string"
},
"restoreParameters": {
"pointInTimeUTC": "string",
"sourceResourceId": "string"
},
"serverVersion": "string",
"sharding": {
"shardCount": "int"
},
"storage": {
"sizeGb": "int"
}
},
"tags": {
"{customized property}": "string"
}
}
Valores de propiedad
AdministratorProperties
Nombre | Descripción | Valor |
---|---|---|
contraseña | Contraseña de administrador. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
nombre de usuario | Nombre de usuario del administrador. | cuerda |
BackupProperties
Nombre | Descripción | Valor |
---|
ComputeProperties
Nombre | Descripción | Valor |
---|---|---|
nivel | Nivel de proceso que se va a asignar al clúster, donde cada nivel se asigna a un tamaño de núcleo virtual y memoria. Valores de ejemplo: "M30", "M40". | cuerda |
DataApiProperties
Nombre | Descripción | Valor |
---|---|---|
modo | Modo que indica si la API de datos de Mongo está habilitada para un clúster. | 'Deshabilitado' 'Habilitado' |
HighAvailabilityProperties
Nombre | Descripción | Valor |
---|---|---|
targetMode | Modo de alta disponibilidad de destino solicitado para el clúster. | 'Deshabilitado' 'SameZone' 'ZoneRedundantPreferred' |
Microsoft.DocumentDB/mongoClusters
Nombre | Descripción | Valor |
---|---|---|
apiVersion | La versión de api | '2024-10-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 = 3 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 |
---|---|---|
administrador | Propiedades de administrador local para el clúster de mongo. | |
copia de seguridad | Propiedades de copia de seguridad del clúster de mongo. | BackupProperties |
calcular | Propiedades de proceso del clúster de mongo. | ComputeProperties de |
createMode | Modo para crear un clúster de Mongo. | 'Valor predeterminado' 'GeoReplica' 'PointInTimeRestore' 'Réplica' |
dataApi | Las propiedades de Data API del clúster de mongo. | DataApiProperties |
highAvailability | Propiedades de alta disponibilidad del clúster de mongo. | HighAvailabilityProperties |
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 |
particionamiento | Propiedades de particionamiento del clúster de mongo. | ShardingProperties |
almacenamiento | Propiedades de almacenamiento del clúster de mongo. | StorageProperties |
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 |
ShardingProperties
Nombre | Descripción | Valor |
---|---|---|
shardCount | Número de particiones que se van a aprovisionar en el clúster. | Int |
StorageProperties
Nombre | Descripción | Valor |
---|---|---|
sizeGb | Tamaño del disco de datos asignado a cada servidor. | Int |
TrackedResourceTags
Nombre | Descripción | Valor |
---|
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-10-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
administrator = {
password = "string"
userName = "string"
}
backup = {
}
compute = {
tier = "string"
}
createMode = "string"
dataApi = {
mode = "string"
}
highAvailability = {
targetMode = "string"
}
previewFeatures = [
"string"
]
publicNetworkAccess = "string"
replicaParameters = {
sourceLocation = "string"
sourceResourceId = "string"
}
restoreParameters = {
pointInTimeUTC = "string"
sourceResourceId = "string"
}
serverVersion = "string"
sharding = {
shardCount = int
}
storage = {
sizeGb = int
}
}
})
}
Valores de propiedad
AdministratorProperties
Nombre | Descripción | Valor |
---|---|---|
contraseña | Contraseña de administrador. | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
nombre de usuario | Nombre de usuario del administrador. | cuerda |
BackupProperties
Nombre | Descripción | Valor |
---|
ComputeProperties
Nombre | Descripción | Valor |
---|---|---|
nivel | Nivel de proceso que se va a asignar al clúster, donde cada nivel se asigna a un tamaño de núcleo virtual y memoria. Valores de ejemplo: "M30", "M40". | cuerda |
DataApiProperties
Nombre | Descripción | Valor |
---|---|---|
modo | Modo que indica si la API de datos de Mongo está habilitada para un clúster. | 'Deshabilitado' 'Habilitado' |
HighAvailabilityProperties
Nombre | Descripción | Valor |
---|---|---|
targetMode | Modo de alta disponibilidad de destino solicitado para el clúster. | 'Deshabilitado' 'SameZone' 'ZoneRedundantPreferred' |
Microsoft.DocumentDB/mongoClusters
MongoClusterProperties
Nombre | Descripción | Valor |
---|---|---|
administrador | Propiedades de administrador local para el clúster de mongo. | |
copia de seguridad | Propiedades de copia de seguridad del clúster de mongo. | BackupProperties |
calcular | Propiedades de proceso del clúster de mongo. | ComputeProperties de |
createMode | Modo para crear un clúster de Mongo. | 'Valor predeterminado' 'GeoReplica' 'PointInTimeRestore' 'Réplica' |
dataApi | Las propiedades de Data API del clúster de mongo. | DataApiProperties |
highAvailability | Propiedades de alta disponibilidad del clúster de mongo. | HighAvailabilityProperties |
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 |
particionamiento | Propiedades de particionamiento del clúster de mongo. | ShardingProperties |
almacenamiento | Propiedades de almacenamiento del clúster de mongo. | StorageProperties |
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 |
ShardingProperties
Nombre | Descripción | Valor |
---|---|---|
shardCount | Número de particiones que se van a aprovisionar en el clúster. | Int |
StorageProperties
Nombre | Descripción | Valor |
---|---|---|
sizeGb | Tamaño del disco de datos asignado a cada servidor. | Int |
TrackedResourceTags
Nombre | Descripción | Valor |
---|