Comparteix a través de

Declaración de recursos en Bicep

  • Article

En este artículo se describe la sintaxis que se usa para agregar un recurso al archivo Bicep. Está limitado a 800 recursos en un archivo de Bicep. Para obtener más información, consulte Límites de plantilla.

Definir recursos

Agregue una declaración de recursos mediante la palabra clave resource. Establezca un nombre simbólico para el recurso. El nombre simbólico no es lo mismo que el nombre del recurso. El nombre simbólico se usa para hacer referencia al recurso en otras partes del archivo de Bicep.

@<decorator>(<argument>)
resource <symbolic-name> '<full-type-name>@<api-version>' = {
  <resource-properties>
}

Por lo tanto, una declaración de una cuenta de almacenamiento puede comenzar por:

resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  ...
}

Los nombres simbólicos distinguen mayúsculas de minúsculas. Pueden contener letras, números y caracteres de subrayado (_). No pueden empezar con un número. Un recurso no puede tener el mismo nombre que un parámetro, una variable o un módulo.

Para ver los tipos de recursos y la versión disponibles, consulte Referencia de recursos de Bicep. Bicep no admite apiProfile, que está disponible en código JSON de plantillas de Azure Resource Manager (plantillas de ARM). También puede definir recursos del proveedor de extensibilidad de Bicep. Para obtener más información, consulte Proveedor de Kubernetes de extensibilidad de Bicep.

Para implementar un recurso de forma condicional, use la sintaxis if. Para obtener más información, consulte Implementación condicional en Bicep.

resource <symbolic-name> '<full-type-name>@<api-version>' = if (condition) {
  <resource-properties>
}

Para implementar más de una instancia de un recurso, use la sintaxis for. Puede usar el decorador batchSize para especificar si las instancias se implementan en serie o en paralelo. Para obtener más información, consulte Bucles iterativos en Bicep.

@batchSize(int) // optional decorator for serial deployment
resource <symbolic-name> '<full-type-name>@<api-version>' = [for <item> in <collection>: {
  <properties-to-repeat>
}]

También puede usar la sintaxis for en las propiedades del recurso para crear una matriz.

resource <symbolic-name> '<full-type-name>@<api-version>' = {
  properties: {
    <array-property>: [for <item> in <collection>: <value-to-repeat>]
  }
}

Uso de decoradores

Los decoradores se escriben en el formato @expression y se colocan encima de las declaraciones de recursos. En la siguiente tabla se muestran los decoradores disponibles para los recursos.

Decorador Argumento Descripción
batchSize None Configure instancias para implementarlas secuencialmente.
descripción string Proporcione descripciones para el recurso.

Los decoradores están en el espacio de nombres sys. Si tiene que diferenciar un decorador de otro elemento con el mismo nombre, anteceda el decorador con sys. Por ejemplo, si el archivo de Bicep incluye un parámetro llamado description, debe agregar el espacio de nombres sys al usar el decorador description.

BatchSize

Solo puede aplicar @batchSize() a un recurso o definición de módulo que use una expresión for.

De manera predeterminada, los recursos se implementan en paralelo. Cuando agrega el decorador batchSize(int), implementa las instancias en serie.

@batchSize(3)
resource storageAccountResources 'Microsoft.Storage/storageAccounts@2023-04-01' = [for storageName in storageAccounts: {
  ...
}]

Para más información, consulte Implementación en lotes.

Descripción

Para agregar una explicación, agregue una descripción a las declaraciones de recursos. Por ejemplo:

@description('Create a number of storage accounts')
resource storageAccountResources 'Microsoft.Storage/storageAccounts@2023-04-01' = [for storageName in storageAccounts: {
  ...
}]

El texto con formato Markdown se puede usar para el texto de descripción.

Nombre del recurso

Cada recurso tiene un nombre. Al establecer el nombre del recurso, preste atención a las reglas y restricciones de los nombres de los recursos.

resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: 'examplestorage'
  ...
}

Normalmente, el nombre se establece en un parámetro para que pueda pasar valores diferentes durante la implementación.

@minLength(3)
@maxLength(24)
param storageAccountName string

resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: storageAccountName
  ...
}

Ubicación del recurso

Muchos recursos requieren una ubicación. Puede determinar si el recurso necesita una ubicación a través de IntelliSense o de la referencia de plantillas. En el ejemplo siguiente se agrega un parámetro de ubicación que se usa para la cuenta de almacenamiento.

resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: 'examplestorage'
  location: 'eastus'
  ...
}

Normalmente, la ubicación se establece en un parámetro para que pueda realizar la implementación en diferentes ubicaciones.

param location string = resourceGroup().location

resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: 'examplestorage'
  location: location
  ...
}

Se admiten diferentes tipos de recursos en diferentes ubicaciones. Si desea obtener las ubicaciones admitidas para un servicio de Azure, consulte Productos disponibles por región. Para obtener las ubicaciones admitidas para un tipo de recurso, use Azure PowerShell o la CLI de Azure.

((Get-AzResourceProvider -ProviderNamespace Microsoft.Batch).ResourceTypes `
  | Where-Object ResourceTypeName -eq batchAccounts).Locations

Etiquetas del recurso

Puede aplicar etiquetas a un recurso durante la implementación. Las etiquetas le ayudan a organizar de forma lógica los recursos implementados. Para ver ejemplos de las diferentes maneras de especificar las etiquetas, consulte Etiquetas de plantillas de ARM.

Identidades administradas para recursos

Algunos recursos admiten identidades administradas para recursos de Azure. Dichos recursos tienen un objeto de identidad en el nivel raíz de la declaración de recursos.

Puede usar identidades administradas asignadas por el sistema o por el usuario.

En el siguiente ejemplo se muestra cómo configurar una identidad asignada por el sistema para un clúster de Azure Kubernetes Service.

resource aks 'Microsoft.ContainerService/managedClusters@2024-02-01' = {
  name: clusterName
  location: location
  tags: tags
  identity: {
    type: 'SystemAssigned'
  }

En el siguiente ejemplo se muestra cómo configurar una identidad asignada por el usuario para una máquina virtual.

param userAssignedIdentity string

resource vm 'Microsoft.Compute/virtualMachines@2024-03-01' = {
  name: vmName
  location: location
  identity: {
    type: 'UserAssigned'
    userAssignedIdentities: {
      '${userAssignedIdentity}': {}
    }
  }

Propiedades específicas de recursos

Las propiedades anteriores son genéricas para la mayoría de los tipos de recursos. Después de establecer esos valores, tiene que establecer las propiedades que son específicas del tipo de recurso que va a implementar.

Use IntelliSense o la referencia de recursos de Bicep para determinar qué propiedades están disponibles y cuáles son obligatorias. En el ejemplo siguiente se establecen las propiedades restantes para una cuenta de almacenamiento.

resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: 'examplestorage'
  location: 'eastus'
  sku: {
    name: 'Standard_LRS'
    tier: 'Standard'
  }
  kind: 'StorageV2'
  properties: {
    accessTier: 'Hot'
  }
}

Pasos siguientes