Tipos de dados em Bicep

  • Artigo

Este artigo descreve os tipos de dados compatíveis com o Bicep. Para definir os tipos de dados personalizados, consulte Tipos de dados definidos pelo usuário.

Tipos com suporte

Em um Bicep, você pode usar estes tipos de dados:

Matrizes

As matrizes começam com um colchete esquerdo ( [) e terminam com um colchete direito (]). No Bicep, uma matriz pode ser declarada em uma só linha ou em várias linhas. Vírgulas (,) são usadas entre valores em declarações de linha única, mas não em declarações de várias linhas. Você pode misturar e corresponder declarações de linha única e de várias linhas. A declaração de várias linhas requer a CLI do Bicep versão 0.7.X ou superior.

var multiLineArray = [
  'abc'
  'def'
  'ghi'
]

var singleLineArray = ['abc', 'def', 'ghi']

var mixedArray = ['abc', 'def'
    'ghi']

Em uma matriz, cada item é representado pelo tipo any. Você pode ter uma matriz cujos itens são do mesmo tipo de dados ou uma matriz que contém tipos de dados diferentes.

O exemplo a seguir mostra uma matriz de inteiros e uma matriz de tipos diferentes.

var integerArray = [
  1
  2
  3
]

var mixedArray = [
  resourceGroup().name
  1
  true
  'example string'
]

As matrizes em Bicep são baseadas em zero. No exemplo a seguir, a expressão exampleArray[0] é avaliada como 1 e exampleArray[2] é avaliada como 3. O índice do indexador pode ser outra expressão. A expressão exampleArray[index] é avaliada como 2. Indexadores de inteiros são permitidos somente em expressões de tipos de matriz.

var index = 1

var exampleArray = [
  1
  2
  3
]

Você recebe o seguinte erro quando o índice está fora dos limites:

The language expression property array index 'x' is out of bounds

Para evitar essa exceção, você pode usar o operador lógico Or, conforme mostrado no exemplo a seguir:

param emptyArray array = []
param numberArray array = [1, 2, 3]

output foo bool = empty(emptyArray) || emptyArray[0] == 'bar'
output bar bool = length(numberArray) >= 3 || numberArray[3] == 4

Boolianos

Ao especificar valores boolianos, use true ou false. Não coloque o valor entre aspas.

param exampleBool bool = true

Inteiros

Ao especificar valores inteiros, não use aspas.

param exampleInt int = 1

No Bicep, inteiros são inteiros de 64 bits. Quando passado como parâmetros embutidos, o intervalo de valores pode ser limitado pelo SDK ou pela ferramenta de linha de comando usada para implantação. Por exemplo, ao usar o PowerShell para implantar um Bicep, os tipos de números inteiros podem variar de -2147483648 a 2147483647. Para evitar essa limitação, especifique valores inteiros grandes em um arquivo de parâmetro. Os tipos de recurso aplicam seus próprios limites para propriedades de números inteiros.

Os formatos de ponto flutuante, decimal ou binário não são compatíveis no momento.

Objetos

Os objetos começam com uma chave esquerda ({) e terminam com uma chave direita (}). No Bicep, um objeto pode ser declarado em linha única ou em várias linhas. Cada propriedade em um objeto consiste em chave e valor. A chave e o valor são separados por dois-pontos (:). Um objeto permite qualquer propriedade de qualquer tipo. Vírgulas (,) são usadas entre propriedades para declarações de linha única, mas não usadas entre propriedades para declarações de várias linhas. Você pode misturar e corresponder declarações de linha única e de várias linhas. A declaração de várias linhas requer a CLI do Bicep versão 0.7.X ou superior.

param singleLineObject object = {name: 'test name', id: '123-abc', isCurrent: true, tier: 1}

param multiLineObject object = {
  name: 'test name'
  id: '123-abc'
  isCurrent: true
  tier: 1
}

param mixedObject object = {name: 'test name', id: '123-abc', isCurrent: true
    tier: 1}

No Bicep, aspas são permitidas como opção em chaves de propriedade de objeto:

var test = {
  'my - special. key': 'value'
}

No exemplo anterior, as aspas são usadas quando as chaves de propriedade de objeto contêm caracteres especiais. Por exemplo, espaço, '-' ou '.'. O exemplo a seguir mostra como usar a interpolação nas chaves de propriedade de objeto.

var stringVar = 'example value'
var objectVar = {
  '${stringVar}': 'this value'
}

Os acessadores de propriedade são usados para acessar as propriedades de um objeto. Eles são construídos usando o operador ..

var a = {
  b: 'Dev'
  c: 42
  d: {
    e: true
  }
}

output result1 string = a.b // returns 'Dev'
output result2 int = a.c // returns 42
output result3 bool = a.d.e // returns true

Os acessadores de propriedade podem ser usados com qualquer objeto, incluindo parâmetros e variáveis de tipos de objeto e literais de objeto. Usar um acessador de propriedade em uma expressão de tipo não objeto é um erro.

Use também a sintaxe [] para acessar uma propriedade. O exemplo a seguir retorna Development.

var environmentSettings = {
  dev: {
    name: 'Development'
  }
  prod: {
    name: 'Production'
  }
}

output accessorResult string = environmentSettings['dev'].name

No JSON, um objeto é uma coleção não ordenada de zero ou mais pares chave-valor. A ordenação pode ser diferente, dependendo das implementações. Por exemplo, a função items() do Bicep classifica os objetos na ordem alfabética. Em outros locais, a ordenação original pode ser preservada. Devido a esse não determinismo, evite fazer suposições sobre a ordem das chaves de objeto ao escrever códigos que interagem com parâmetros e saídas de implantações.

Você receberá o seguinte erro ao acessar uma propriedade inexistente de um objeto:

The language expression property 'foo' doesn't exist

Para evitar a exceção, você pode usar o operador lógico And, conforme mostrado no exemplo a seguir:

param objectToTest object = {
  one: 1
  two: 2
  three: 3
}

output bar bool = contains(objectToTest, 'four') && objectToTest.four == 4

Cadeias de caracteres

No Bicep, as cadeias de caracteres são marcadas com aspas simples e precisam ser declaradas em apenas uma linha. Todos os caracteres Unicode com pontos de código entre 0 e 10FFFF são permitidos.

param exampleString string = 'test value'

A seguinte tabela lista o conjunto de caracteres reservados que precisam ser escapados por um caractere de barra invertida (\):

Sequência de escape Valor representado Observações
\\ \
\' '
\n LF (alimentação de linha)
\r CR (retorno de carro)
\t caractere de tabulação
\u{x} Ponto de código Unicode x x representa um valor ponto hexadecimal entre 0 e 10FFFF (ambos incluídos). São permitidos zeros à esquerda. Pontos de código acima de FFFF são emitidos como um par alternativo.
\$ $ Escape somente quando seguido por {. 
// evaluates to "what's up?"
var myVar = 'what\'s up?'

Todas as cadeias de caracteres no Bicep dão suporte à interpolação. Para injetar uma expressão, coloque-a entre ${ e }. As expressões que são referenciadas não podem abranger várias linhas.

var storageName = 'storage${uniqueString(resourceGroup().id)}'

Cadeias de caracteres de várias linhas

No Bicep, as cadeias de caracteres de várias linhas são definidas entre três caracteres de aspas simples (''') seguidos opcionalmente por uma nova linha (a sequência de abertura) e três caracteres de aspas simples (''' – a sequência de fechamento). Os caracteres que são inseridos entre a sequência de abertura e fechamento são lidos de modo textual e nenhuma saída é necessária nem possível.

Observação

Como o analisador Bicep lê todos os caracteres como estão, dependendo das terminações de linha do arquivo Bicep, as novas linhas podem ser interpretadas como \r\n ou \n.

Atualmente, não há suporte para a interpolação em cadeias de caracteres de várias linhas. Devido a essa limitação, talvez seja necessário usar a função concat em vez de usar a interpolação.

Não há suporte para cadeias de caracteres de várias linhas que contêm '''.

// evaluates to "hello!"
var myVar = '''hello!'''

// evaluates to "hello!" because the first newline is skipped
var myVar2 = '''
hello!'''

// evaluates to "hello!\n" because the final newline is included
var myVar3 = '''
hello!
'''

// evaluates to "  this\n    is\n      indented\n"
var myVar4 = '''
  this
    is
      indented
'''

// evaluates to "comments // are included\n/* because everything is read as-is */\n"
var myVar5 = '''
comments // are included
/* because everything is read as-is */
'''

// evaluates to "interpolation\nis ${blocked}"
// note ${blocked} is part of the string, and is not evaluated as an expression
var myVar6 = '''interpolation
is ${blocked}'''

Cadeias de caracteres e objetos seguros

A cadeia de caracteres segura usa o mesmo formato que uma cadeia de caracteres e o objeto seguro usa o mesmo formato que um objeto. Com o Bicep, adicione o @secure()decorador a uma cadeia de caracteres ou objeto.

Quando você define um parâmetro como cadeia de caracteres segura ou objeto seguro, o valor do parâmetro não é salvo no histórico de implantação e não é registrado em log. No entanto, se você definir esse valor seguro como uma propriedade que não está esperando um valor seguro, o valor não será protegido. Por exemplo, se você definir uma cadeia de caracteres segura como marca, esse valor será armazenado como texto sem formatação. Use cadeias de caracteres seguras para senhas e segredos.

O exemplo a seguir mostra dois parâmetros seguros:

@secure()
param password string

@secure()
param configValues object

Capacidade de atribuição de tipo de dados

No Bicep, um valor de um tipo (tipo de origem) pode ser atribuído a outro tipo (tipo de destino). A tabela a seguir mostra qual tipo de origem (listado horizontalmente) pode ou não ser atribuído a qual tipo de destino (listado verticalmente). Na tabela, X significa atribuível, espaço vazio significa não atribuível e ? significa apenas se os tipos são compatíveis.

Tipos any error string number int bool null object array recurso nomeado módulo nomeado scope
any X X X X X X X X X X X
error
string X X
number X X X
int X X
bool X X
null X X
object X X
array X X
resource X X
module X X
scope ?
recurso nomeado X ? ?
módulo nomeado X ? ?

Próximas etapas

Para saber mais sobre a estrutura e a sintaxe do Bicep, confira estrutura de arquivos do Bicep.