Expressões e funções no Azure Data Factory e no Azure Synapse Analytics

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Dica

Experimente o Data Factory no Microsoft Fabric, uma solução de análise tudo-em-um para empresas. O Microsoft Fabric abrange desde movimentação de dados até ciência de dados, análise em tempo real, business intelligence e relatórios. Saiba como iniciar uma avaliação gratuita!

Este artigo fornece detalhes sobre expressões e funções com suporte pelo Azure Data Factory e pelo Azure Synapse Analytics.

Expressões

Os valores JSON na definição podem ser literais ou expressões que são avaliadas no runtime. Por exemplo:

"name": "value"

ou

"name": "@pipeline().parameters.password"

As expressões podem aparecer em qualquer lugar em um valor de cadeia de caracteres JSON e sempre retornam outro valor JSON. Se um valor JSON for uma expressão, o corpo da expressão será extraído removendo a arroba (@). Se for necessária uma cadeia de caracteres literal que começa com @, seu escape deverá ser feito usando @@. Os exemplos a seguir mostram como as expressões são avaliadas.

Valor JSON	Result
"parameters"	Os “parâmetros” dos caracteres são retornados.
"parameters[1]"	Os “parâmetros[1]” dos caracteres são retornados.
"@@"	Uma cadeia de caracteres de 1 caractere que contém \'\@\' será retornada.
" @"	Uma cadeia de caracteres de 2 caracteres que contém ' \@\' será retornada.

As expressões também podem aparecer dentro de cadeias de caracteres usando um recurso chamado interpolação de cadeia de caracteres em que as expressões estão encapsuladas em @{ ... }. Por exemplo: "name" : "First Name: @{pipeline().parameters.firstName} Last Name: @{pipeline().parameters.lastName}"

Usando interpolação de cadeia de caracteres, o resultado é sempre uma cadeia de caracteres. Digamos que defini myNumber como 42 e myString como foo:

Valor JSON	Result
"@pipeline().parameters.myString"	Retorna foo como uma cadeia de caracteres.
"@{pipeline().parameters.myString}"	Retorna foo como uma cadeia de caracteres.
"@pipeline().parameters.myNumber"	Retorna 42 como um número.
"@{pipeline().parameters.myNumber}"	Retorna 42 como uma cadeia de caracteres.
"A resposta é: @{pipeline().parameters.myNumber}"	Retorna a cadeia de caracteres Answer is: 42.
"@concat('Resposta é:', string (pipeline (). Parameters.myNumber))"	Retorna a cadeia de caracteres Answer is: 42
"A resposta é: @@{pipeline().parameters.myNumber}"	Retorna a cadeia de caracteres Answer is: @{pipeline().parameters.myNumber}.

Nas atividades de fluxo de controle, como a atividade ForEach, você pode fornecer a iteração de uma matriz para os itens de propriedade e usar @item() para iterar em apenas uma enumeração na atividade ForEach. Por exemplo, se items for uma matriz: [1, 2, 3], @item() retornará 1 na primeira iteração, 2 na segunda iteração e 3 na terceira iteração. Você também pode usar @range(0,10) como uma expressão para iterar dez vezes, começando com 0 e terminando com 9.

Você pode usar @activity('nome da atividade') para capturar a saída da atividade e tomar decisões. Considere uma atividade da web chamada Web1. Para colocar a saída da primeira atividade no corpo da segunda, a expressão geralmente é semelhante a: @activity('Web1').output ou @activity('Web1').output.data ou algo semelhante, dependendo da aparência da saída da primeira atividade.

Exemplos

Exemplo de expressão complexa

O exemplo abaixo mostra um exemplo complexo que faz referência a um subcampo profundo da saída da atividade. Para fazer referência a um parâmetro de pipeline que é avaliado como um subcampo, use a sintaxe [] em vez do operador ponto (.) (como no caso de subfield1 e subfield2), como parte de uma atividade de saída.

@activity('*activityName*').output.*subfield1*.*subfield2*[pipeline().parameters.*subfield3*].*subfield4*

Criar arquivos dinamicamente e nomeá-los é um padrão comum. Vamos explorar alguns exemplos de nomenclatura de arquivo dinâmico.

1. Acrescentar Data a um nome de arquivo: @concat('Test_', formatDateTime(utcnow(), 'yyyy-dd-MM'))

2. Acrescentar DateTime no fuso horário do cliente: @concat('Test_', convertFromUtc(utcnow(), 'Pacific Standard Time'))

3. Acrescentar Tempo de Gatilho: @concat('Test_', pipeline().TriggerTime)

4. Gerar um nome de arquivo personalizado em um Fluxo de Dados de Mapeamento ao fazer a saída para um único arquivo com data: 'Test_' + toString(currentDate()) + '.csv'

Nos casos acima, são criados quatro nomes de arquivo dinâmicos, começando com Test_.

Editor de conteúdo dinâmico

O editor de conteúdo dinâmico automaticamente dá escape nos caracteres do conteúdo quando você termina de editá-lo. Por exemplo, o conteúdo a seguir, no editor de conteúdo, é uma interpolação de cadeia de caracteres com duas funções de expressão.

{ 
  "type": "@{if(equals(1, 2), 'Blob', 'Table' )}",
  "name": "@{toUpper('myData')}"
}

O editor de conteúdo dinâmico converte o conteúdo acima em expressão "{ \n \"type\": \"@{if(equals(1, 2), 'Blob', 'Table' )}\",\n \"name\": \"@{toUpper('myData')}\"\n}". O resultado dessa expressão é uma cadeia de caracteres de formato JSON, como mostra o exemplo abaixo.

{
  "type": "Table",
  "name": "MYDATA"
}

Um conjunto de dados com um parâmetro

No exemplo a seguir, o BlobDataset usa um parâmetro denominado path. Seu valor é usado para definir um valor para a propriedade folderPath usando as expressões: dataset().path.

{
    "name": "BlobDataset",
    "properties": {
        "type": "AzureBlob",
        "typeProperties": {
            "folderPath": "@dataset().path"
        },
        "linkedServiceName": {
            "referenceName": "AzureStorageLinkedService",
            "type": "LinkedServiceReference"
        },
        "parameters": {
            "path": {
                "type": "String"
            }
        }
    }
}

Um pipeline com um parâmetro

No exemplo a seguir, o pipeline usa os parâmetros inputPath e outputPath. O path para o conjunto de dados de blob com parâmetros é definido usando os valores desses parâmetros. A sintaxe usada aqui é: pipeline().parameters.parametername.

{
    "name": "Adfv2QuickStartPipeline",
    "properties": {
        "activities": [
            {
                "name": "CopyFromBlobToBlob",
                "type": "Copy",
                "inputs": [
                    {
                        "referenceName": "BlobDataset",
                        "parameters": {
                            "path": "@pipeline().parameters.inputPath"
                        },
                        "type": "DatasetReference"
                    }
                ],
                "outputs": [
                    {
                        "referenceName": "BlobDataset",
                        "parameters": {
                            "path": "@pipeline().parameters.outputPath"
                        },
                        "type": "DatasetReference"
                    }
                ],
                "typeProperties": {
                    "source": {
                        "type": "BlobSource"
                    },
                    "sink": {
                        "type": "BlobSink"
                    }
                }
            }
        ],
        "parameters": {
            "inputPath": {
                "type": "String"
            },
            "outputPath": {
                "type": "String"
            }
        }
    }
}

Substituir caracteres especiais

O editor de conteúdo dinâmico usa caractere de escape automaticamente, como aspas duplas e barra invertida, em seu conteúdo quando você termina a edição. Isso poderá gerar problemas se você quiser substituir o feed de linha ou guia usando \n, \t na função replace(). Você pode editar seu conteúdo dinâmico na visualização de código para remover o \ extra na expressão ou seguir as etapas abaixo para substituir caracteres especiais usando a linguagem de expressão:

1. Codificação de URL em relação ao valor da cadeia de caracteres original
2. Substitua a cadeia de caracteres codificada por URL, por exemplo, feed de linha (%0A), retorno de carro (%0D), guia horizontal (%09).
3. Decodificação de URL

Por exemplo, com um caractere de nova linha no valor da variável companyName, a expressão @uriComponentToString(replace(uriComponent(variables('companyName')), '%0A', '')) pode remover o caractere de nova linha.

Contoso-
Corporation

Caractere de aspas simples de escape

As funções de expressão em pipelines usam a aspa simples (') para cercar parâmetros de valor de cadeia de caracteres. Use dois caracteres de aspas simples consecutivos em uma expressão de cadeia de caracteres de pipeline para incluir uma única aspa. Veja um exemplo: a expressão @concat('Here is a double quote character: ". ', 'And here is a single quote character all within the same string: ''.') retornará o seguinte resultado:

Here is a double quote character: ". And here is a single quote character all within the same string: '.

No entanto, em expressões de fluxo de dados, essa sintaxe não tem suporte. Em vez disso, as expressões de fluxo de dados podem ser cercadas por aspas simples ou duplas. Coloque o texto que exige aspas simples entre aspas duplas e o texto que exige aspas duplas em aspas simples, dentro de funções de cadeia de caracteres. Se você precisar de uma cadeia de caracteres contendo aspas simples e duplas, poderá usar concat() para mesclar duas subcadeias de caracteres que contêm aspas simples ou aspas duplas. O equivalente ao fluxo de dados do exemplo de expressão de pipeline anterior seria concat('Here is a double quote character: ". ', "And here is a single quote character all within the same string: '."). Em um fluxo de dados, essa expressão retornará o mesmo resultado do exemplo anterior para expressões de pipeline.

Tutorial

Este tutorial orienta sobre como passar parâmetros entre um pipeline e uma atividade, bem como entre as atividades. O tutorial demonstra especificamente as etapas para um Azure Data Factory embora as etapas para um espaço de trabalho do Synapse sejam quase equivalentes, mas com uma interface de usuário ligeiramente diferente.

Funções

Você pode chamar funções dentro de expressões. As seções a seguir fornecem informações sobre as funções que podem ser usados em uma expressão.

Funções de data

Função de data ou hora	Tarefa
addDays	Adicionar um número de dias a um carimbo de data/hora.
addHours	Adicionar um número de horas a um carimbo de data/hora.
addMinutes	Adicionar um número de minutos a um carimbo de data/hora.
addSeconds	Adicionar um número de segundos a um carimbo de data/hora.
addToTime	Adicionar um número de unidades de tempo a um carimbo de data/hora. Confira também getFutureTime.
convertFromUtc	Converter um carimbo de data/hora de UTC (Tempo Universal Coordenado) no fuso horário de destino.
convertTimeZone	Converter um carimbo de data/hora do fuso horário de origem no fuso horário de destino.
convertToUtc	Converter um carimbo de data/hora do fuso horário de origem em UTC (Tempo Universal Coordenado).
dayOfMonth	Retornar o componente de dia do mês de um carimbo de data/hora.
dayOfWeek	Retornar o componente de dia da semana de um carimbo de data/hora.
dayOfYear	Retornar o componente de dia do ano de um carimbo de data/hora.
formatDateTime	Retorna o carimbo de data/hora como uma cadeia de caracteres no formato opcional.
getFutureTime	Retornar o carimbo de data/hora atual mais as unidades de tempo especificadas. Confira também addToTime.
getPastTime	Retornar o carimbo de data/hora atual menos as unidades de tempo especificadas. Confira também subtractFromTime.
startOfDay	Retornar o início do dia de um carimbo de data/hora.
startOfHour	Retornar o início da hora de um carimbo de data/hora.
startOfMonth	Retornar o início do mês de um carimbo de data/hora.
subtractFromTime	Subtrair um número de unidades de tempo de um carimbo de data/hora. Confira também getPastTime.
ticks	Retornar o valor de propriedade ticks de um carimbo de data/hora especificado.
utcNow	Retornar o carimbo de data/hora atual como uma cadeia de caracteres.

Funções de cadeia de caracteres

Para trabalhar com cadeias de caracteres, você pode usar essas funções de cadeia de caracteres e algumas funções de coleta. Funções de cadeia de caracteres só funcionam com cadeias de caracteres.

Função de cadeia de caracteres	Tarefa
concat	Combinar duas ou mais cadeias de caracteres e retornar a cadeia de caracteres combinada.
endsWith	Verificar se uma cadeia de caracteres termina com a subcadeia de caracteres especificada.
guid	Gerar um GUID (identificador global exclusivo) como uma cadeia de caracteres.
indexOf	Retornar a posição inicial de uma subcadeia de caracteres.
lastIndexOf	Retorna a posição inicial da última ocorrência de uma subcadeia de caracteres.
substitui	Substituir uma subcadeia de caracteres pela cadeia de caracteres especificada e retornar a cadeia de caracteres atualizada.
split	Divida uma cadeia de caracteres em cada ocorrência de um delimitador especificado, retornando as substrings resultantes como elementos de uma matriz.
startsWith	Verificar se uma cadeia de caracteres começa com uma subcadeia de caracteres específica.
substring	Retornar caracteres de uma cadeia de caracteres, começando na posição especificada.
toLower	Retornar uma cadeia de caracteres em letras minúsculas.
toUpper	Retornar uma cadeia de caracteres em letras maiúsculas.
cortar	Remover espaços em branco à esquerda e à direita de uma cadeia de caracteres e retornar a cadeia de caracteres atualizada.

Funções de coleção

Para trabalhar com coleções, matrizes em geral, cadeias de caracteres e, às vezes, dicionários, você pode usar estas funções de coleção.

Função de coleção	Tarefa
contains	Verificar se uma coleção tem um item específico.
empty	Verifique se uma coleção está vazia.
first	Retornar o primeiro item de uma coleção.
intersection	Retornar uma coleção que tem somente os itens comuns entre as coleções especificadas.
join	Retornar uma cadeia de caracteres que tem todos os itens de uma matriz, separados pelo caractere especificado.
last	Retornar o último item de uma coleção.
length	Retornar o número de itens em uma cadeia de caracteres ou matriz.
skip	Remover itens do início de uma coleção e retornar todos os outros itens.
take	Retornar itens do início de uma coleção.
union	Retornar uma coleção que tem todos os itens das coleções especificadas.

Funções lógicas

Essas funções são úteis em condições e podem ser usadas para avaliar qualquer tipo de lógica.

Função de comparação lógica	Tarefa
and	Verificar se todas as expressões são verdadeiras.
equals	Verificar se os dois valores são equivalentes.
greater	Verificar se o primeiro valor é maior que o segundo valor.
greaterOrEquals	Verificar se o primeiro valor é superior ou igual ao segundo.
if	Verificar se uma expressão é verdadeira ou falsa. Com base no resultado, retornar um valor especificado.
less	Verificar se o primeiro valor é menor que o segundo valor.
lessOrEquals	Verificar se o primeiro valor é inferior ou igual ao segundo valor.
not	Verificar se uma expressão é falsa.
or	Verificar se pelo menos uma expressão é verdadeira.

Funções de conversão

Essas funções são usadas para converter entre cada um dos tipos nativos no idioma:

• string
• inteiro
• FLOAT
• booleano
• matrizes
• dicionários

Função de conversão	Tarefa
array	Retornar uma matriz de uma única entrada especificada. Para várias entradas, confira createArray.
base64	Retornar a versão codificada em Base64 de uma cadeia de caracteres.
base64ToBinary	Retornar a versão binária de uma cadeia de caracteres codificada em Base64.
base64ToString	Retornar a versão de cadeia de caracteres de uma cadeia de caracteres codificada em Base64.
binary	Retornar a versão binária de um valor de entrada.
bool	Retornar a versão booliana de um valor de entrada.
coalesce	Retornar o primeiro valor não nulo de um ou mais parâmetros.
createArray	Retornar uma matriz de várias entradas.
dataUri	Retornar o URI de dados de um valor de entrada.
dataUriToBinary	Retornar a versão binária de um URI de dados.
dataUriToString	Retornar a versão de cadeia de caracteres de um URI de dados.
decodeBase64	Retornar a versão de cadeia de caracteres de uma cadeia de caracteres codificada em Base64.
decodeDataUri	Retornar a versão binária de um URI de dados.
decodeUriComponent	Retornar uma cadeia de caracteres que substitui caracteres de escape por versões decodificadas.
encodeUriComponent	Retornar uma cadeia de caracteres que substitui caracteres não seguros para URL por caracteres de escape.
float	Retornar um número de ponto flutuante correspondente a um valor de entrada.
int	Retornar a versão em inteiros de uma cadeia de caracteres.
json	Retornar o objeto ou valor de tipo JSON (JavaScript Object Notation) correspondente a uma cadeia de caracteres ou XML.
cadeia de caracteres	Retornar a versão de cadeia de caracteres de um valor de entrada.
uriComponent	Retornar a versão codificada para URI correspondente a um valor de entrada substituindo caracteres não seguros para URL por caracteres de escape.
uriComponentToBinary	Retornar a versão binária de uma cadeia de caracteres codificada como URI.
uriComponentToString	Retornar a versão de cadeia de caracteres correspondente a uma cadeia de caracteres codificada como URI.
xml	Retornar a versão XML de uma cadeia de caracteres.
xpath	Verificar o XML em busca de nós ou valores correspondentes a uma expressão XPath (Linguagem XPath) e retornar esses nós ou valores.

Funções matemáticas

Essas funções podem ser usadas para qualquer um dos tipos de números: inteiros e floats.

Função matemática	Tarefa
adicionar	Retornar o resultado da adição de dois números.
div	Retorna o resultado da divisão de um número por outro.
max	Retornar o valor mais alto de um conjunto de números em uma matriz.
min	Retornar o valor mais baixo de um conjunto de números ou de uma matriz.
mod	Retorna o resto da divisão de um número por outro.
mul	Retornar o produto da multiplicação de dois números.
rand	Retornar um número inteiro aleatório de um intervalo especificado.
range	Retornar uma matriz de inteiros que começa em um inteiro especificado.
sub	Retorna o resultado da subtração de um número por outro.

Referência de função

Esta seção lista todas as funções disponíveis em ordem alfabética.

add

Retornar o resultado da adição de dois números.

add(<summand_1>, <summand_2>)

Parâmetro	Obrigatório	Type	Descrição
<summand_1>, <summand_2>	Sim	Integer, Float ou misto	Os números a serem adicionados

Valor retornado	Type	Descrição
<result-sum>	Integer ou Float	O resultado da adição dos números especificados

Exemplo

Esse exemplo adiciona os números especificados:

add(1, 1.5)

E retorna este resultado: 2.5

addDays

Adicionar um número de dias a um carimbo de data/hora.

addDays('<timestamp>', <days>, '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<days>	Sim	Integer	O número positivo ou negativo de dias a ser adicionado
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora mais o número de dias especificado

Exemplo 1

Esse exemplo adiciona 10 dias ao carimbo de data/hora especificado:

addDays('2018-03-15T13:00:00Z', 10)

E retorna este resultado: "2018-03-25T00:00:0000000Z"

Exemplo 2

Esse exemplo subtrai cinco dias do carimbo de data/hora especificado:

addDays('2018-03-15T00:00:00Z', -5)

E retorna este resultado: "2018-03-10T00:00:0000000Z"

addHours

Adicionar um número de horas a um carimbo de data/hora.

addHours('<timestamp>', <hours>, '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<hours>	Sim	Integer	O número positivo ou negativo de horas a ser adicionado
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora mais o número de horas especificado

Exemplo 1

Esse exemplo adiciona 10 horas ao carimbo de data/hora especificado:

addHours('2018-03-15T00:00:00Z', 10)

E retorna este resultado: "2018-03-15T10:00:0000000Z"

Exemplo 2

Esse exemplo subtrai cinco horas do carimbo de data/hora especificado:

addHours('2018-03-15T15:00:00Z', -5)

E retorna este resultado: "2018-03-15T10:00:0000000Z"

addMinutes

Adicionar um número de minutos a um carimbo de data/hora.

addMinutes('<timestamp>', <minutes>, '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<minutes>	Sim	Integer	O número positivo ou negativo de minutos a ser adicionado
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora mais o número de minutos especificado

Exemplo 1

Esse exemplo adiciona 10 minutos ao carimbo de data/hora especificado:

addMinutes('2018-03-15T00:10:00Z', 10)

E retorna este resultado: "2018-03-15T00:20:00.0000000Z"

Exemplo 2

Esse exemplo subtrai cinco minutos do carimbo de data/hora especificado:

addMinutes('2018-03-15T00:20:00Z', -5)

E retorna este resultado: "2018-03-15T00:15:00.0000000Z"

addSeconds

Adicionar um número de segundos a um carimbo de data/hora.

addSeconds('<timestamp>', <seconds>, '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<seconds>	Sim	Integer	O número positivo ou negativo de segundos a ser adicionado
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora mais o número de segundos especificado

Exemplo 1

Esse exemplo adiciona 10 segundos ao carimbo de data/hora especificado:

addSeconds('2018-03-15T00:00:00Z', 10)

E retorna este resultado: "2018-03-15T00:00:10.0000000Z"

Exemplo 2

Esse exemplo subtrai cinco segundos ao carimbo de data/hora especificado:

addSeconds('2018-03-15T00:00:30Z', -5)

E retorna este resultado: "2018-03-15T00:00:25.0000000Z"

addToTime

Adicionar um número de unidades de tempo a um carimbo de data/hora. Consulte também getFutureTime().

addToTime('<timestamp>', <interval>, '<timeUnit>', '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<interval>	Sim	Integer	O número de unidades de tempo especificadas a ser adicionado
<timeUnit>	Sim	String	Unidade de tempo a ser usado com intervalo: "Segundo", "Minuto", "Hora", "Dia", "Semana", "Mês", "Ano"
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora mais o número de unidades de tempo especificado

Exemplo 1

Este exemplo adiciona um dia ao carimbo de data/hora especificado:

addToTime('2018-01-01T00:00:00Z', 1, 'Day')

E retorna este resultado: "2018-01-02T00:00:00.0000000Z"

Exemplo 2

Este exemplo adiciona um dia ao carimbo de data/hora especificado:

addToTime('2018-01-01T00:00:00Z', 1, 'Day', 'D')

E retorna o resultado usando o formato "D" opcional: "Tuesday, January 2, 2018"

e

Verifique se ambas as expressões são verdadeiras. Retornará verdadeiro (true) quando ambas as expressões forem verdadeiras ou falso (false) quando pelo menos uma expressão for falsa.

and(<expression1>, <expression2>)

Parâmetro	Obrigatório	Type	Descrição
<expressão1>, <expressão2>	Sim	Boolean	As expressões a serem verificadas

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará verdadeiro (true) quando ambas as expressões forem verdadeiras. Retornará false quando pelo menos uma expressão for false.

Exemplo 1

Esses exemplos verificam se os valores boolianos são todos verdadeiros:

and(true, true)
and(false, true)
and(false, false)

E retorna estes resultados:

• Primeiro exemplo: Ambas as expressões são true, então retorna true.
• Segundo exemplo: Uma expressão é false, portanto retorna false.
• Terceiro exemplo: Ambas as expressões são false, portanto retorna false.

Exemplo 2

Esses exemplos verificam se as expressões especificadas são todas verdadeiras:

and(equals(1, 1), equals(2, 2))
and(equals(1, 1), equals(1, 2))
and(equals(1, 2), equals(1, 3))

E retorna estes resultados:

• Primeiro exemplo: Ambas as expressões são true, então retorna true.
• Segundo exemplo: Uma expressão é false, portanto retorna false.
• Terceiro exemplo: Ambas as expressões são false, portanto retorna false.

matriz

Retornar uma matriz de uma única entrada especificada. Para várias entradas, consulte createArray().

array('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres para criar uma matriz

Valor retornado	Type	Descrição
[<valor>]	Array	Uma matriz que contém a única entrada especificada

Exemplo

Esse exemplo cria uma matriz da cadeia de caracteres "hello":

array('hello')

E retorna este resultado: ["hello"]

base64

Retornar a versão codificada em Base64 de uma cadeia de caracteres.

base64('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres de entrada

Valor retornado	Type	Descrição
<base64-string>	String	A versão codificada em Base64 da cadeia de caracteres de entrada

Exemplo

Esse exemplo converte a cadeia de caracteres "hello" em uma cadeia de caracteres codificada em Base64:

base64('hello')

E retorna este resultado: "aGVsbG8="

base64ToBinary

Retornar a versão binária de uma cadeia de caracteres codificada em Base64.

base64ToBinary('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres codificada em Base64 a ser convertida

Valor retornado	Type	Descrição
<binary-for-base64-string>	String	A versão binária da cadeia de caracteres codificada em Base64

Exemplo

Esse exemplo converte a cadeia de caracteres codificada em Base64 "aGVsbG8=" em uma cadeia de caracteres binária:

base64ToBinary('aGVsbG8=')

E retorna este resultado:

"0110000101000111010101100111001101100010010001110011100000111101"

base64ToString

Retorne a versão da cadeia de caracteres para uma cadeia de caracteres codificada em Base64, decodificando com eficiência a cadeia de caracteres Base64. Use essa função em vez de decodeBase64(). Embora as funções funcionem da mesma forma, base64ToString() é preferencial.

base64ToString('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres codificada em Base64 a ser decodificada

Valor retornado	Type	Descrição
<decoded-base64-string>	String	A versão da cadeia de caracteres de uma cadeia de caracteres codificada em Base64

Exemplo

Esse exemplo converte a cadeia de caracteres codificada em Base64 "aGVsbG8=" em apenas uma cadeia de caracteres:

base64ToString('aGVsbG8=')

E retorna este resultado: "hello"

binary

Retornar a versão binária de uma cadeia de caracteres.

binary('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres a ser convertida

Valor retornado	Type	Descrição
<binary-for-input-value>	String	A versão binária para a cadeia de caracteres especificada

Exemplo

Esse exemplo converte a cadeia de caracteres "hello" em uma cadeia de caracteres binária:

binary('hello')

E retorna este resultado:

"0110100001100101011011000110110001101111"

bool

Retornar a versão booliana de um valor.

bool(<value>)

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	Qualquer	O valor a ser convertido

Valor retornado	Type	Descrição
true ou false	Boolean	A versão booliana do valor especificado

Exemplo

Esses exemplos convertem os valores especificados em valores boolianos:

bool(1)
bool(0)

E retorna estes resultados:

• Primeiro exemplo: true
• Segundo exemplo: false

coalesce

Retornar o primeiro valor não nulo de um ou mais parâmetros. Cadeias de caracteres vazias, matrizes vazias e objetos vazios não são nulos.

coalesce(<object_1>, <object_2>, ...)

Parâmetro	Obrigatório	Type	Descrição
<objeto_1>, <objeto_2>, ...	Sim	Qualquer um, pode misturar tipos	Um ou mais itens para verificar se são nulos

Valor retornado	Type	Descrição
<first-non-null-item>	Qualquer	O primeiro item ou valor não nulo. Se todos os parâmetros forem nulos, essa função retornará null.

Exemplo

Esses exemplos retornarão o primeiro valor não nulo dos valores especificados ou null quando todos os valores forem nulos:

coalesce(null, true, false)
coalesce(null, 'hello', 'world')
coalesce(null, null, null)

E retorna estes resultados:

• Primeiro exemplo: true
• Segundo exemplo: "hello"
• Terceiro exemplo: null

concat

Combinar duas ou mais cadeias de caracteres e retornar a cadeia de caracteres combinada.

concat('<text1>', '<text2>', ...)

Parâmetro	Obrigatório	Type	Descrição
<texto1>, <texto2>, ...	Sim	String	Pelo menos duas cadeias de caracteres a serem combinadas

Valor retornado	Type	Descrição
<text1text2...>	String	A cadeia de caracteres criada das cadeias de caracteres de entrada combinadas

Exemplo

Esse exemplo combina as cadeias de caracteres "Olá" e "Mundo":

concat('Hello', 'World')

E retorna este resultado: "HelloWorld"

contains

Verificar se uma coleção tem um item específico. Retornará true quando o item for localizado ou false quando não for localizado. Essa função diferencia maiúsculas de minúsculas.

contains('<collection>', '<value>')
contains([<collection>], '<value>')

Especificamente, essa função funciona nestes tipos de coleção:

• Uma cadeia de caracteres para localizar uma subcadeia de caracteres
• Uma matriz para localizar um valor
• Um dicionário para localizar uma chave

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	String, Array ou Dictionary	A coleção a ser verificada
<value>	Sim	String, Array ou Dictionary, respectivamente	O item a ser localizado

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando o item for localizado. Retorna false quando não localizada.

Exemplo 1

Esse exemplo verifica se há a subcadeia de caracteres "mundo" na cadeia de caracteres "olá, mundo" e retorna true:

contains('hello world', 'world')

Exemplo 2

Esse exemplo verifica se há a subcadeia de caracteres "universo" na cadeia de caracteres "olá, mundo" e retorna false:

contains('hello world', 'universe')

convertFromUtc

Converter um carimbo de data/hora de UTC (Tempo Universal Coordenado) no fuso horário de destino.

convertFromUtc('<timestamp>', '<destinationTimeZone>', '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<destinationTimeZone>	Sim	String	O nome do fuso horário de destino. Para obter nomes de fuso horário, confira Valores de fuso horário da Microsoft. Talvez seja necessário remover alguma pontuação do nome do fuso horário.
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<converted-timestamp>	String	O carimbo de data/hora convertido na região do fuso horário

Exemplo 1

Esse exemplo converte um carimbo de data/hora no fuso horário especificado:

convertFromUtc('2018-01-01T08:00:00.0000000Z', 'Pacific Standard Time')

E retorna este resultado: "2018-01-01T00:00:00Z"

Exemplo 2

Esse exemplo converte um carimbo de data/hora no fuso horário e no formato especificado:

convertFromUtc('2018-01-01T08:00:00.0000000Z', 'Pacific Standard Time', 'D')

E retorna este resultado: "Monday, January 1, 2018"

convertTimeZone

Converter um carimbo de data/hora do fuso horário de origem no fuso horário de destino.

convertTimeZone('<timestamp>', '<sourceTimeZone>', '<destinationTimeZone>', '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<sourceTimeZone>	Sim	String	O nome do fuso horário de origem. Para obter nomes de fuso horário, confira Valores de fuso horário da Microsoft. Talvez seja necessário remover alguma pontuação do nome do fuso horário.
<destinationTimeZone>	Sim	String	O nome do fuso horário de destino. Para obter nomes de fuso horário, confira Valores de fuso horário da Microsoft. Talvez seja necessário remover alguma pontuação do nome do fuso horário.
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<converted-timestamp>	String	O carimbo de data/hora convertido na região do fuso horário

Exemplo 1

Esse exemplo converte o fuso horário de origem no fuso horário de destino:

convertTimeZone('2018-01-01T08:00:00.0000000Z', 'UTC', 'Pacific Standard Time')

E retorna este resultado: "2018-01-01T00:00:00.0000000"

Exemplo 2

Esse exemplo converte um fuso horário no fuso horário e no formato especificado:

convertTimeZone('2018-01-01T08:00:00.0000000Z', 'UTC', 'Pacific Standard Time', 'D')

E retorna este resultado: "Monday, January 1, 2018"

convertToUtc

Converter um carimbo de data/hora do fuso horário de origem em UTC (Tempo Universal Coordenado).

convertToUtc('<timestamp>', '<sourceTimeZone>', '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<sourceTimeZone>	Sim	String	O nome do fuso horário de origem. Para obter nomes de fuso horário, confira Valores de fuso horário da Microsoft. Talvez seja necessário remover alguma pontuação do nome do fuso horário.
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<converted-timestamp>	String	O carimbo de data/hora convertido no UTC

Exemplo 1

Esse exemplo converte um carimbo de data/hora em UTC:

convertToUtc('01/01/2018 00:00:00', 'Pacific Standard Time')

E retorna este resultado: "2018-01-01T08:00:00.0000000Z"

Exemplo 2

Esse exemplo converte um carimbo de data/hora em UTC:

convertToUtc('01/01/2018 00:00:00', 'Pacific Standard Time', 'D')

E retorna este resultado: "Monday, January 1, 2018"

createArray

Retornar uma matriz de várias entradas. Para matrizes de entrada únicas, consulte array().

createArray('<object1>', '<object2>', ...)

Parâmetro	Obrigatório	Type	Descrição
<objeto1>, <objeto2>, ...	Sim	Qualquer um, mas não misto	Pelo menos dois itens para criar a matriz

Valor retornado	Type	Descrição
[<objeto1>, <objeto2>, ...]	Array	A matriz criada com base em todos os itens de entrada

Exemplo

Esse exemplo cria uma matriz com base nestas entradas:

createArray('h', 'e', 'l', 'l', 'o')

E retorna este resultado: ["h", "e", "l", "l", "o"]

dataUri

Retornar um URI (Uniform Resource Identifier) de dados para uma cadeia de caracteres.

dataUri('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres a ser convertida

Valor retornado	Type	Descrição
<data-uri>	String	O URI dos dados da cadeia de caracteres de entrada

Exemplo

Esse exemplo cria um URI de dados para a cadeia de caracteres "hello":

dataUri('hello')

E retorna este resultado: "data:text/plain;charset=utf-8;base64,aGVsbG8="

dataUriToBinary

Retorne a versão binária de um URI (Uniform Resource Identifier) de dados. Use esta função em vez de decodeDataUri(). Embora as funções funcionem da mesma forma, dataUriBinary() é preferencial.

dataUriToBinary('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	O URI de dados a ser convertido

Valor retornado	Type	Descrição
<binary-for-data-uri>	String	A versão binária do URI de dados

Exemplo

Esse exemplo cria uma versão binária para esse URI de dados:

dataUriToBinary('data:text/plain;charset=utf-8;base64,aGVsbG8=')

E retorna este resultado:

"01100100011000010111010001100001001110100111010001100101011110000111010000101111011100000 1101100011000010110100101101110001110110110001101101000011000010111001001110011011001010111 0100001111010111010101110100011001100010110100111000001110110110001001100001011100110110010 10011011000110100001011000110000101000111010101100111001101100010010001110011100000111101"

dataUriToString

Retornar a versão de cadeia de caracteres de um URI (Uniform Resource Identifier) de dados.

dataUriToString('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	O URI de dados a ser convertido

Valor retornado	Type	Descrição
<string-for-data-uri>	String	A versão de cadeia de caracteres do URI de dados

Exemplo

Esse exemplo cria uma cadeia de caracteres para esse URI de dados:

dataUriToString('data:text/plain;charset=utf-8;base64,aGVsbG8=')

E retorna este resultado: "hello"

dayOfMonth

Retorna o dia do mês de um carimbo de data/hora.

dayOfMonth('<timestamp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora

Valor retornado	Type	Descrição
<day-of-month>	Integer	O dia do mês do carimbo de data/hora especificado

Exemplo

Esse exemplo retorna o número do dia do mês desse carimbo de data/hora:

dayOfMonth('2018-03-15T13:27:36Z')

E retorna este resultado: 15

dayOfWeek

Retornar o dia da semana de um carimbo de data/hora.

dayOfWeek('<timestamp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora

Valor retornado	Type	Descrição
<day-of-week>	Integer	O dia da semana do carimbo de data/hora especificado em que domingo é 0, segunda-feira é 1 e assim por diante

Exemplo

Esse exemplo retorna o número do dia da semana desse carimbo de data/hora:

dayOfWeek('2018-03-15T13:27:36Z')

E retorna este resultado: 3

dayOfYear

Retorna o dia do ano de um carimbo de data/hora.

dayOfYear('<timestamp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora

Valor retornado	Type	Descrição
<day-of-year>	Integer	O dia do ano do carimbo de data/hora especificado

Exemplo

Esse exemplo retorna o número do dia do ano desse carimbo de data/hora:

dayOfYear('2018-03-15T13:27:36Z')

E retorna este resultado: 74

decodeBase64

Retorne a versão da cadeia de caracteres para uma cadeia de caracteres codificada em Base64, decodificando com eficiência a cadeia de caracteres Base64. Considere usar base64ToString(), em vez de decodeBase64(). Embora as funções funcionem da mesma forma, base64ToString() é preferencial.

decodeBase64('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres codificada em Base64 a ser decodificada

Valor retornado	Type	Descrição
<decoded-base64-string>	String	A versão da cadeia de caracteres de uma cadeia de caracteres codificada em Base64

Exemplo

Esse exemplo cria uma cadeia de caracteres para uma cadeia de caracteres codificada em Base64:

decodeBase64('aGVsbG8=')

E retorna este resultado: "hello"

decodeDataUri

Retorne a versão binária de um URI (Uniform Resource Identifier) de dados. Considere usar dataUriToBinary(), em vez de decodeDataUri(). Embora as funções funcionem da mesma forma, dataUriToBinary() é preferencial.

decodeDataUri('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres do URI de dados a ser decodificada

Valor retornado	Type	Descrição
<binary-for-data-uri>	String	A versão binária de uma cadeia de caracteres do URI de dados

Exemplo

Esse exemplo retorna a versão binária para este URI de dados:

decodeDataUri('data:text/plain;charset=utf-8;base64,aGVsbG8=')

E retorna este resultado:

"01100100011000010111010001100001001110100111010001100101011110000111010000101111011100000 1101100011000010110100101101110001110110110001101101000011000010111001001110011011001010111 0100001111010111010101110100011001100010110100111000001110110110001001100001011100110110010 10011011000110100001011000110000101000111010101100111001101100010010001110011100000111101"

decodeUriComponent

Retornar uma cadeia de caracteres que substitui caracteres de escape por versões decodificadas.

decodeUriComponent('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres com os caracteres de escape a ser decodificada

Valor retornado	Type	Descrição
<decoded-uri>	String	A cadeia de caracteres atualizada com os caracteres de escape decodificados

Exemplo

Esse exemplo substitui os caracteres de escape nesta cadeia de caracteres por versões decodificadas:

decodeUriComponent('http%3A%2F%2Fcontoso.com')

E retorna este resultado: "https://contoso.com"

div

Retorna o resultado da divisão de um número por outro.

div(<dividend>, <divisor>)

O tipo de retorno preciso da função depende dos tipos dos parâmetros. Confira os exemplos para mais detalhes.

Parâmetro	Obrigatório	Type	Descrição
<dividend>	Sim	Integer ou Float	O número a ser dividido pelo divisor
<divisor>	Sim	Integer ou Float	O número que divide o dividendo. Um valor de divisor igual a zero resulta em um erro durante a execução.

Valor retornado	Type	Descrição
<quotient-result>	Integer ou Float	O resultado da divisão do primeiro número pelo segundo

Exemplo 1

Esses exemplos dividem o número 9 por 2:

div(9, 2.0)
div(9.0, 2)
div(9.0, 2.0)

E todos retornam este resultado: 4.5

Exemplo 2

Este exemplo também divide o número 9 por 2, mas como ambos os parâmetros são inteiros, o resto é descartado (divisão de inteiros):

div(9, 2)

A expressão devolve o resultado 4. Para obter o valor do resto, utilize a função mod().

encodeUriComponent

Retornar uma versão codificada para URI (Uniform Resource Identifier) para uma cadeia de caracteres substituindo caracteres desprotegidos de URL por caracteres de escape. Considere usar uriComponent(), em vez de encodeUriComponent(). Embora as funções funcionem da mesma forma, uriComponent() é preferencial.

encodeUriComponent('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres a ser convertida em um formato codificado para URI

Valor retornado	Type	Descrição
<encoded-uri>	String	A cadeia de caracteres codificada para URI com caracteres de escape

Exemplo

Esse exemplo cria uma versão codificada para URI para esta cadeia de caracteres:

encodeUriComponent('https://contoso.com')

E retorna este resultado: "http%3A%2F%2Fcontoso.com"

empty

Verifique se uma coleção está vazia. Retornará true quando a coleção estiver vazia ou false quando não estiver vazia.

empty('<collection>')
empty([<collection>])

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	String, Array ou Object	A coleção a ser verificada

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando a coleção estiver vazia. Retornará false quando não estiver vazia.

Exemplo

Esses exemplos verificam se as coleções especificadas estão vazias:

empty('')
empty('abc')

E retorna estes resultados:

• Primeiro exemplo: Passa uma cadeia de caracteres vazia para que a função retorne true.
• Segundo exemplo: Passa uma cadeia de caracteres "abc, para que a função retorne false.

endsWith

Verificar se uma cadeia de caracteres termina com uma subcadeia de caracteres específica. Retornará true quando a subcadeia de caracteres for localizada ou retornará false quando não for localizada. Essa função não diferencia maiúsculas de minúsculas.

endsWith('<text>', '<searchText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	String	A cadeia de caracteres a ser verificada
<searchText>	Sim	String	A subcadeia de caracteres final a ser localizada

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando a subcadeia de caracteres final for localizada. Retorna false quando não localizada.

Exemplo 1

Esse exemplo verifica se a cadeia de caracteres "olá, mundo" termina com a cadeia de caracteres "mundo":

endsWith('hello world', 'world')

E retorna este resultado: true

Exemplo 2

Esse exemplo verifica se a cadeia de caracteres "olá, mundo" termina com a cadeia de caracteres "universo":

endsWith('hello world', 'universe')

E retorna este resultado: false

equals

Verificar se os valores, expressões ou objetos são equivalentes. Retornará true quando ambos forem equivalentes ou retornará false quando não forem equivalentes.

equals('<object1>', '<object2>')

Parâmetro	Obrigatório	Type	Descrição
<objeto1>, <objeto2>	Sim	Vários	Os valores, expressões ou objetos a serem comparados

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando ambos forem equivalentes. Retornará false quando não forem equivalentes.

Exemplo

Esses exemplos verificam se as entradas especificadas são equivalentes.

equals(true, 1)
equals('abc', 'abcd')

E retorna estes resultados:

• Primeiro exemplo: Ambos os valores são equivalentes, então a função retorna true.
• Segundo exemplo: Ambos os valores não são equivalentes, então a função retorna false.

first

Retornar o primeiro item de uma cadeia de caracteres ou de uma matriz.

first('<collection>')
first([<collection>])

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	String ou Array	A coleção na qual localizar o primeiro item

Valor retornado	Type	Descrição
<first-collection-item>	Qualquer	O primeiro item na coleção

Exemplo

Esses exemplos localizam o primeiro item nestas coleções:

first('hello')
first(createArray(0, 1, 2))

E retornam estes resultados:

• Primeiro exemplo: "h"
• Segundo exemplo: 0

FLOAT

Converter uma versão de cadeia de caracteres para um número de ponto flutuante em um número de ponto flutuante real.

float('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres que tem um número de ponto flutuante válido a ser convertido

Valor retornado	Type	Descrição
<float-value>	Float	O número de ponto flutuante para a cadeia de caracteres especificada

Exemplo

Esse exemplo cria uma versão de cadeia de caracteres para este número de ponto flutuante:

float('10.333')

E retorna este resultado: 10.333

formatDateTime

Retornar um carimbo de data/hora no formato especificado.

formatDateTime('<timestamp>', '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<reformatted-timestamp>	String	O carimbo de data/hora atualizado no formato especificado

Exemplo

Esse exemplo converte um carimbo de data/hora no formato especificado:

formatDateTime('03/15/2018 12:00:00', 'yyyy-MM-ddTHH:mm:ss')

E retorna este resultado: "2018-03-15T12:00:00"

getFutureTime

Retornar o carimbo de data/hora atual mais as unidades de tempo especificadas.

getFutureTime(<interval>, <timeUnit>, <format>?)

Parâmetro	Obrigatório	Type	Descrição
<interval>	Sim	Integer	O número de unidades de tempo especificadas a ser adicionado
<timeUnit>	Sim	String	Unidade de tempo a ser usado com intervalo: "Segundo", "Minuto", "Hora", "Dia", "Semana", "Mês", "Ano"
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora atual mais o número de unidades de tempo especificado

Exemplo 1

Suponha que o carimbo de data/hora é "2018-03-01T00:00:00.0000000Z". Esse exemplo adiciona cinco dias a esse carimbo de data/hora:

getFutureTime(5, 'Day')

E retorna este resultado: "2018-03-06T00:00:00.0000000Z"

Exemplo 2

Suponha que o carimbo de data/hora é "2018-03-01T00:00:00.0000000Z". Esse exemplo adiciona cinco dias e converte o resultado no formato "D":

getFutureTime(5, 'Day', 'D')

E retorna este resultado: "Tuesday, March 6, 2018"

getPastTime

Retornar o carimbo de data/hora atual menos as unidades de tempo especificadas.

getPastTime(<interval>, <timeUnit>, <format>?)

Parâmetro	Obrigatório	Type	Descrição
<interval>	Sim	Integer	O número de unidades de tempo especificadas a serem subtraídas
<timeUnit>	Sim	String	Unidade de tempo a ser usado com intervalo: "Segundo", "Minuto", "Hora", "Dia", "Semana", "Mês", "Ano"
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora atual menos o número de unidades de tempo especificado

Exemplo 1

Suponha que o carimbo de data/hora é "2018-02-01T00:00:00.0000000Z". Esse exemplo subtrai cinco dias desse carimbo de data/hora:

getPastTime(5, 'Day')

E retorna este resultado: "2018-01-27T00:00:00.0000000Z"

Exemplo 2

Suponha que o carimbo de data/hora é "2018-02-01T00:00:00.0000000Z". Esse exemplo subtrai cinco dias e converte o resultado no formato "D":

getPastTime(5, 'Day', 'D')

E retorna este resultado: "Saturday, January 27, 2018"

greater

Verificar se o primeiro valor é maior que o segundo valor. Retornará true quando o primeiro valor for maior ou false quando for menor.

greater(<value>, <compareTo>)
greater('<value>', '<compareTo>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	Integer, Float ou String	O primeiro valor para verificar se é maior do que o segundo
<compareTo>	Sim	Integer, Float ou String, respectivamente	O valor de comparação

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando o primeiro valor for maior que o segundo. Retornará false quando o primeiro valor for igual ou menor que o segundo.

Exemplo

Esses exemplos verificam se o primeiro valor é maior que o segundo:

greater(10, 5)
greater('apple', 'banana')

E retornam estes resultados:

• Primeiro exemplo: true
• Segundo exemplo: false

greaterOrEquals

Verificar se o primeiro valor é superior ou igual ao segundo. Retornará true quando o primeiro valor for superior ou igual ou retornará false quando o primeiro valor for inferior.

greaterOrEquals(<value>, <compareTo>)
greaterOrEquals('<value>', '<compareTo>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	Integer, Float ou String	O primeiro valor para verificar se é superior ou igual ao segundo
<compareTo>	Sim	Integer, Float ou String, respectivamente	O valor de comparação

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando o primeiro valor for superior ou igual ao segundo. Retornará false quando o primeiro valor for menor que o segundo.

Exemplo

Esses exemplos verificam se o primeiro valor é superior ou igual ao segundo:

greaterOrEquals(5, 5)
greaterOrEquals('apple', 'banana')

E retornam estes resultados:

• Primeiro exemplo: true
• Segundo exemplo: false

guid

Gere um GUID (identificador global exclusivo) como uma cadeia de caracteres, por exemplo, "c2ecc88d-88c8-4096-912c-d6f2e2b138ce":

guid()

Além disso, é possível especificar um formato diferente para o GUID que não seja o formato padrão, "D", que é de 32 dígitos separados por hifens.

guid('<format>')

Parâmetro	Obrigatório	Type	Descrição
<format>	Não	String	Um único especificador de formato para o GUID retornado. Por padrão, o formato é "D", mas é possível usar "N", "D", "B", "P" ou "X".

Valor retornado	Type	Descrição
<GUID-value>	String	Um GUID gerado aleatoriamente

Exemplo

Esse exemplo gera o mesmo GUID, mas como 32 dígitos, separado por hifens e entre parênteses:

guid('P')

E retorna este resultado: "(c2ecc88d-88c8-4096-912c-d6f2e2b138ce)"

if

Verificar se uma expressão é verdadeira ou falsa. Com base no resultado, retornar um valor especificado.

if(<expression>, <valueIfTrue>, <valueIfFalse>)

Parâmetro	Obrigatório	Type	Descrição
<expression>	Sim	Boolean	A expressão a ser verificada
<valueIfTrue>	Sim	Qualquer	O valor a ser retornado quando a expressão for verdadeira
<valueIfFalse>	Sim	Qualquer	O valor a ser retornado quando a expressão for falsa

Valor retornado	Type	Descrição
<specified-return-value>	Qualquer	O valor especificado retornado dependendo se a expressão é verdadeira ou falsa

Exemplo

Esse exemplo retorna "yes", porque a expressão especificada retorna true. Caso contrário, o exemplo retorna "no":

if(equals(1, 1), 'yes', 'no')

indexOf

Retornar o valor de índice ou a posição inicial para uma subcadeia de caracteres. Essa função não diferencia maiúsculas de minúsculas, e os índices começam com o número 0.

indexOf('<text>', '<searchText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	String	A cadeia de caracteres que tem a subcadeia de caracteres a ser localizada
<searchText>	Sim	String	A subcadeia de caracteres a ser localizada

Valor retornado	Type	Descrição
<index-value>	Integer	O valor de índice ou a posição inicial da subcadeia de caracteres especificada. Se a cadeia de caracteres não for localizada, retornará o número -1.

Exemplo

Esse exemplo localiza o valor de índice inicial para a subcadeia de caracteres "mundo" na cadeia de caracteres "olá, mundo":

indexOf('hello world', 'world')

E retorna este resultado: 6

INT

Retornar a versão em inteiros de uma cadeia de caracteres.

int('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres a ser convertida

Valor retornado	Type	Descrição
<integer-result>	Integer	A versão em inteiros da cadeia de caracteres especificada

Exemplo

Esse exemplo cria uma versão em inteiros da cadeia de caracteres "10":

int('10')

E retorna este resultado: 10

json

Retornar o objeto ou valor de tipo JSON (JavaScript Object Notation) correspondente a uma cadeia de caracteres ou XML.

json('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String ou XML	A cadeia de caracteres ou XML a ser convertido

Valor retornado	Type	Descrição
<JSON-result>	Objeto ou tipo JSON nativo	O objeto ou valor de tipo JSON nativo para a cadeia de caracteres ou XML especificado. Se a cadeia de caracteres for nula, a função retornará um objeto vazio.

Exemplo 1

Esse exemplo converte essa cadeia de caracteres no valor JSON:

json('[1, 2, 3]')

E retorna este resultado: [1, 2, 3]

Exemplo 2

Esse exemplo converte essa cadeia de caracteres em JSON:

json('{"fullName": "Sophia Owen"}')

E retorna este resultado:

{
  "fullName": "Sophia Owen"
}

Exemplo 3

Esse exemplo converte esse XML em JSON:

json(xml('<?xml version="1.0"?> <root> <person id='1'> <name>Sophia Owen</name> <occupation>Engineer</occupation> </person> </root>'))

E retorna este resultado:

{
   "?xml": { "@version": "1.0" },
   "root": {
      "person": [ {
         "@id": "1",
         "name": "Sophia Owen",
         "occupation": "Engineer"
      } ]
   }
}

interseção

Retornar uma coleção que tem somente os itens comuns entre as coleções especificadas. Para aparecer no resultado, um item deve ser exibido em todas as coleções passadas para essa função. Se um ou mais itens tiverem o mesmo nome, o último item com o nome será exibido neste resultado.

intersection([<collection1>], [<collection2>], ...)
intersection('<collection1>', '<collection2>', ...)

Parâmetro	Obrigatório	Type	Descrição
<colleção1>, <colleção2>, ...	Sim	Matriz ou objeto, mas não ambos	As coleções da qual você deseja somente os itens comuns

Valor retornado	Type	Descrição
<common-items>	Array ou Object, respectivamente	Uma coleção que tem somente os itens comuns entre as coleções especificadas

Exemplo

Esse exemplo localiza os itens comuns entre estas matrizes:

intersection(createArray(1, 2, 3), createArray(101, 2, 1, 10), createArray(6, 8, 1, 2))

E retorna uma matriz com apenas estes itens: [1, 2]

join

Retornar uma cadeia de caracteres que tem todos os itens de uma matriz e tem cada caractere separado por um delimitador.

join([<collection>], '<delimiter>')

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	Array	A matriz que tem os itens a serem ingressados
<delimiter>	Sim	String	O separador exibido entre cada caractere na cadeia de caracteres resultante

Valor retornado	Type	Descrição
<caractere1><delimitador><caractere2><delimitador>...	String	A cadeia de caracteres resultante criada com base em todos os itens na matriz especificada

Exemplo

Esse exemplo cria uma cadeia de caracteres com base em todos os itens nessa matriz com o caractere especificado como o delimitador:

join(createArray('a', 'b', 'c'), '.')

E retorna este resultado: "a.b.c"

last

Retornar o último item de uma coleção.

last('<collection>')
last([<collection>])

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	String ou Array	A coleção na qual localizar o último item

Valor retornado	Type	Descrição
<last-collection-item>	String ou Array, respectivamente	O último item na coleção

Exemplo

Esses exemplos localizam o último item nestas coleções:

last('abcd')
last(createArray(0, 1, 2, 3))

E retorna estes resultados:

• Primeiro exemplo: "d"
• Segundo exemplo: 3

lastIndexOf

Retorna a posição inicial ou valor de índice para a última ocorrência de uma subcadeia de caracteres. Essa função não diferencia maiúsculas de minúsculas, e os índices começam com o número 0.

lastIndexOf('<text>', '<searchText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	String	A cadeia de caracteres que tem a subcadeia de caracteres a ser localizada
<searchText>	Sim	String	A subcadeia de caracteres a ser localizada

Valor retornado	Type	Descrição
<ending-index-value>	Integer	A posição inicial ou valor de índice da última ocorrência da subcadeia de caracteres especificada. Se a cadeia de caracteres não for localizada, retornará o número -1.

Exemplo

Este exemplo encontra o valor de índice inicial para a última ocorrência da subcadeia de caracteres "mundo" na cadeia de caracteres "olá, mundo":

lastIndexOf('hello world', 'world')

E retorna este resultado: 6

comprimento

Retornar o número de itens em uma coleção.

length('<collection>')
length([<collection>])

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	String ou Array	A coleção com os itens a serem contados

Valor retornado	Type	Descrição
<length-or-count>	Integer	O número de itens na coleção

Exemplo

Esses exemplos contam o número de itens nestas coleções:

length('abcd')
length(createArray(0, 1, 2, 3))

E retornam este resultado: 4

less

Verificar se o primeiro valor é menor que o segundo valor. Retornará true quando o primeiro valor for menor ou retornará false quando o primeiro valor for maior.

less(<value>, <compareTo>)
less('<value>', '<compareTo>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	Integer, Float ou String	O primeiro valor para verificar se é menor do que o segundo
<compareTo>	Sim	Integer, Float ou String, respectivamente	O item de comparação

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando o primeiro valor for menor que o segundo. Retornará false quando o primeiro valor for igual ou maior que o segundo.

Exemplo

Esses exemplos verificam se o primeiro valor é menor que o segundo.

less(5, 10)
less('banana', 'apple')

E retornam estes resultados:

• Primeiro exemplo: true
• Segundo exemplo: false

lessOrEquals

Verificar se o primeiro valor é inferior ou igual ao segundo valor. Retornará true quando o primeiro valor for inferior ou igual ou retornará false quando o primeiro valor for superior.

lessOrEquals(<value>, <compareTo>)
lessOrEquals('<value>', '<compareTo>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	Integer, Float ou String	O primeiro valor para verificar se é inferior ou igual ao segundo
<compareTo>	Sim	Integer, Float ou String, respectivamente	O item de comparação

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando o primeiro valor for inferior ou igual ao segundo valor. Retornará false quando o primeiro valor for maior que o segundo.

Exemplo

Esses exemplos verificam se o primeiro valor é inferior ou igual ao segundo.

lessOrEquals(10, 10)
lessOrEquals('apply', 'apple')

E retornam estes resultados:

• Primeiro exemplo: true
• Segundo exemplo: false

max

Retornar o maior valor de uma lista ou matriz com números inclusivos em ambas as extremidades.

max(<number1>, <number2>, ...)
max([<number1>, <number2>, ...])

Parâmetro	Obrigatório	Type	Descrição
<número1>, <número2>, ...	Sim	Integer, Float ou ambos	O conjunto de números do qual você deseja o valor mais alto
[<número1>, <número2>, ...]	Sim	Array – Integer, Float ou ambos	A matriz de números da qual você deseja o valor mais alto

Valor retornado	Type	Descrição
<max-value>	Integer ou Float	O valor mais alto na matriz ou conjunto de números especificado

Exemplo

Esses exemplos obtêm o valor mais alto do conjunto de números e da matriz:

max(1, 2, 3)
max(createArray(1, 2, 3))

E retornam este resultado: 3

Min

Retornar o valor mais baixo de um conjunto de números ou de uma matriz.

min(<number1>, <number2>, ...)
min([<number1>, <number2>, ...])

Parâmetro	Obrigatório	Type	Descrição
<número1>, <número2>, ...	Sim	Integer, Float ou ambos	O conjunto de números do qual você deseja o valor mais baixo
[<número1>, <número2>, ...]	Sim	Array – Integer, Float ou ambos	A matriz de números da qual você deseja o valor mais baixo

Valor retornado	Type	Descrição
<min-value>	Integer ou Float	O valor mais baixo no conjunto de números ou matriz especificado

Exemplo

Esses exemplos obtêm o valor mais baixo no conjunto de números e na matriz:

min(1, 2, 3)
min(createArray(1, 2, 3))

E retornam este resultado: 1

mod

Retorna o resto da divisão de um número por outro. Para divisão de inteiros, veja div().

mod(<dividend>, <divisor>)

Parâmetro	Obrigatório	Type	Descrição
<dividend>	Sim	Integer ou Float	O número a ser dividido pelo divisor
<divisor>	Sim	Integer ou Float	O número que divide o dividendo. Um valor de divisor igual a zero resulta em um erro durante a execução.

Valor retornado	Type	Descrição
<modulo-result>	Integer ou Float	O resto da divisão do primeiro número pelo segundo

Exemplo

Este exemplo calcula o resto da divisão do primeiro número pelo segundo:

mod(3, 2)

E retorna este resultado: 1

mul

Retornar o produto da multiplicação de dois números.

mul(<multiplicand1>, <multiplicand2>)

Parâmetro	Obrigatório	Type	Descrição
<multiplicand1>	Sim	Integer ou Float	O número a ser multiplicado por multiplicand2
<multiplicand2>	Sim	Integer ou Float	O número que multiplica multiplicand1

Valor retornado	Type	Descrição
<product-result>	Integer ou Float	O produto da multiplicação do primeiro número pelo segundo

Exemplo

Esses exemplos multiplicam o primeiro número pelo segundo:

mul(1, 2)
mul(1.5, 2)

E retornam estes resultados:

• Primeiro exemplo: 2
• Segundo exemplo 3

não

Verificar se uma expressão é falsa. Retornará true quando a expressão for falsa ou retornará false quando for verdadeira.

not(<expression>)

Parâmetro	Obrigatório	Type	Descrição
<expression>	Sim	Boolean	A expressão a ser verificada

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando a expressão for falsa. Retornará false quando a expressão for verdadeira.

Exemplo 1

Esses exemplos verificam se as expressões especificadas são false:

not(false)
not(true)

E retornam estes resultados:

• Primeiro exemplo: A expressão é false, então a função retorna true.
• Segundo exemplo: A expressão é true, então a função retorna false.

Exemplo 2

Esses exemplos verificam se as expressões especificadas são false:

not(equals(1, 2))
not(equals(1, 1))

E retornam estes resultados:

• Primeiro exemplo: A expressão é false, então a função retorna true.
• Segundo exemplo: A expressão é true, então a função retorna false.

ou

Verificar se pelo menos uma expressão é verdadeira. Retornará verdadeiro (true) quando pelo menos uma expressão for verdadeira ou falso (false) quando ambas forem falsas.

or(<expression1>, <expression2>)

Parâmetro	Obrigatório	Type	Descrição
<expressão1>, <expressão2>	Sim	Boolean	As expressões a serem verificadas

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando pelo menos uma expressão for verdadeira. Retornará falso (false) quando ambas as expressões forem falsas.

Exemplo 1

Esses exemplos verificam se pelo menos uma expressão é true:

or(true, false)
or(false, false)

E retornam estes resultados:

• Primeiro exemplo: No mínimo, uma expressão é true, então a função retorna true.
• Segundo exemplo: Ambas as expressões são false, então a função retorna false.

Exemplo 2

Esses exemplos verificam se pelo menos uma expressão é true:

or(equals(1, 1), equals(1, 2))
or(equals(1, 2), equals(1, 3))

E retornam estes resultados:

• Primeiro exemplo: No mínimo, uma expressão é true, então a função retorna true.
• Segundo exemplo: Ambas as expressões são false, então a função retorna false.

rand

Retornar um inteiro aleatório de um intervalo especificado, inclusivo apenas na extremidade inicial.

rand(<minValue>, <maxValue>)

Parâmetro	Obrigatório	Type	Descrição
<minValue>	Sim	Integer	O menor inteiro no intervalo
<maxValue>	Sim	Integer	O inteiro que segue o inteiro mais alto no intervalo que a função pode retornar

Valor retornado	Type	Descrição
<random-result>	Integer	O número inteiro aleatório retornou do intervalo especificado. Observe que cada invocação de rand() produzirá um resultado exclusivo, o que significa que o valor observado no monitoramento de saída pode não ser o mesmo no tempo de execução real.

Exemplo

Esse exemplo obtém um inteiro aleatório do intervalo especificado, excluindo o valor máximo:

rand(1, 5)

E retorna um destes números como o resultado: 1, 2, 3 ou 4

range

Retornar uma matriz de inteiros que começa em um inteiro especificado.

range(<startIndex>, <count>)

Parâmetro	Obrigatório	Type	Descrição
<startIndex>	Sim	Integer	Um número inteiro que inicia a matriz como o primeiro item
<count>	Sim	Integer	O número de inteiros na matriz

Valor retornado	Type	Descrição
[<intervalo-de-resultados>]	Array	A matriz com inteiros que começa no índice especificado

Exemplo

Esse exemplo cria uma matriz de inteiros que começa no índice especificado e tem o número de inteiros especificado:

range(1, 4)

E retorna este resultado: [1, 2, 3, 4]

substituir

Substituir uma subcadeia de caracteres pela cadeia de caracteres especificada e retornar a cadeia de caracteres resultante. Essa função diferencia maiúsculas de minúsculas.

replace('<text>', '<oldText>', '<newText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	String	A cadeia de caracteres que tem a subcadeia de caracteres a ser substituída
<oldText>	Sim	String	A subcadeia de caracteres a ser substituída
<newText>	Sim	String	A cadeia de caracteres de substituição

Valor retornado	Type	Descrição
<updated-text>	String	A cadeia de caracteres atualizada após substituir a subcadeia de caracteres Se a subcadeia de caracteres não for localizada, retorne a cadeia de caracteres original.

Exemplo

Esse exemplo localiza a subcadeia de caracteres "antiga" em "a antiga cadeia de caracteres" e substitui "antiga" por "nova":

replace('the old string', 'old', 'new')

E retorna este resultado: "the new string"

skip

Remover itens do início de uma coleção e retornar todos os outros itens.

skip([<collection>], <count>)

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	Array	A coleção cujos itens você deseja remover
<count>	Sim	Integer	Um inteiro positivo para o número de itens a ser removido no início

Valor retornado	Type	Descrição
[<coleção-atualizada>]	Array	A coleção atualizada depois de remover os itens especificados

Exemplo

Esse exemplo remove um item, o número 0, do início da matriz especificada:

skip(createArray(0, 1, 2, 3), 1)

E retorna essa matriz com os itens restantes: [1,2,3]

split

Divida uma cadeia de caracteres em cada ocorrência de um delimitador especificado, retornando as substrings resultantes como elementos de uma matriz. Um delimitador normalmente é apenas um caractere, mas há suporte para delimitadores com vários caracteres.

split('<text>', '<delimiter>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	String	A cadeia de caracteres a ser separada em subcadeias de caracteres
<delimiter>	Sim	String	A cadeia de caracteres a ser usada como o delimitador

Valor retornado	Type	Descrição
[<subcadeia-de-caracteres1>,<subcadeia-de-caracteres2>,...]	Array	Uma matriz contendo substrings da cadeia de caracteres original

Exemplo

Este exemplo retorna uma matriz que contém substrings "a_b_c" com base no delimitador "_":

split('a_b_c', '_')

A matriz retornada é: ["a","b","c"]

startOfDay

Retornar o início do dia de um carimbo de data/hora.

startOfDay('<timestamp>', '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora especificado, mas começando na marca de zero hora para o dia

Exemplo

Esse exemplo localiza o início do dia para esse carimbo de data/hora:

startOfDay('2018-03-15T13:30:30Z')

E retorna este resultado: "2018-03-15T00:00:00.0000000Z"

startOfHour

Retornar o início da hora de um carimbo de data/hora.

startOfHour('<timestamp>', '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora especificado, mas começando na marca de zero minuto para a hora

Exemplo

Esse exemplo localiza o início da hora para esse carimbo de data/hora:

startOfHour('2018-03-15T13:30:30Z')

E retorna este resultado: "2018-03-15T13:00:00.0000000Z"

startOfMonth

Retornar o início do mês de um carimbo de data/hora.

startOfMonth('<timestamp>', '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora especificado, mas começando no primeiro dia do mês na marca de zero hora

Exemplo

Esse exemplo retorna o início do mês para este carimbo de data/hora:

startOfMonth('2018-03-15T13:30:30Z')

E retorna este resultado: "2018-03-01T00:00:00.0000000Z"

startsWith

Verificar se uma cadeia de caracteres começa com uma subcadeia de caracteres específica. Retornará true quando a subcadeia de caracteres for localizada ou retornará false quando não for localizada. Essa função não diferencia maiúsculas de minúsculas.

startsWith('<text>', '<searchText>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	String	A cadeia de caracteres a ser verificada
<searchText>	Sim	String	A cadeia de caracteres inicial a ser localizada

Valor retornado	Type	Descrição
true ou false	Boolean	Retornará true quando a subcadeia de caracteres inicial for localizada. Retorna false quando não localizada.

Exemplo 1

Esse exemplo verifica se a cadeia de caracteres "olá, mundo" começa com a subcadeia de caracteres "olá":

startsWith('hello world', 'hello')

E retorna este resultado: true

Exemplo 2

Esse exemplo verifica se a cadeia de caracteres "olá, mundo" começa com a subcadeia de caracteres "saudações":

startsWith('hello world', 'greetings')

E retorna este resultado: false

string

Retornar a versão de cadeia de caracteres para um valor.

string(<value>)

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	Qualquer	O valor a ser convertido

Valor retornado	Type	Descrição
<string-value>	String	A versão de cadeia de caracteres do valor especificado

Exemplo 1

Esse exemplo cria uma versão de cadeia para este número:

string(10)

E retorna este resultado: "10"

Exemplo 2

Esse exemplo cria uma cadeia de caracteres para o objeto JSON especificado e usa o caractere de barra invertida (\)como o caractere de escape para aspas duplas (").

string( { "name": "Sophie Owen" } )

E retorna este resultado: "{ \\"name\\": \\"Sophie Owen\\" }"

sub

Retorna o resultado da subtração de um número por outro.

sub(<minuend>, <subtrahend>)

Parâmetro	Obrigatório	Type	Descrição
<minuend>	Sim	Integer ou Float	O número do qual subtrair o subtraendo
<subtrahend>	Sim	Integer ou Float	O número a ser subtraído do minuendo

Valor retornado	Type	Description
<result>	Integer ou Float	O resultado da subtração do segundo número do primeiro

Exemplo

Esse exemplo subtrai o segundo número do primeiro:

sub(10.3, .3)

E retorna este resultado: 10

substring

Retornar caracteres de uma cadeia de caracteres, começando na posição especificada, ou índice. Os valores de índice começam com o número 0.

substring('<text>', <startIndex>, <length>)

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	String	A cadeia de caracteres cujos caracteres você deseja
<startIndex>	Sim	Integer	Um número positivo igual ou superior a 0 que você deseja usar como a posição inicial ou o valor do índice
<length>	Sim	Integer	Um número positivo de caracteres que você deseja na subcadeia de caracteres

Valor retornado	Type	Descrição
<substring-result>	String	Uma subcadeia de caracteres com o número de caracteres especificado, começando na posição de índice especificada na cadeia de caracteres de origem

Exemplo

Esse exemplo cria uma subcadeia de caracteres de cinco caracteres com base na cadeia de caracteres especificada, começando no valor de índice 6:

substring('hello world', 6, 5)

E retorna este resultado: "world"

subtractFromTime

Subtrair um número de unidades de tempo de um carimbo de data/hora. Confira também getPastTime.

subtractFromTime('<timestamp>', <interval>, '<timeUnit>', '<format>'?)

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	Uma cadeia de caracteres que contém o carimbo de data/hora
<interval>	Sim	Integer	O número de unidades de tempo especificadas a serem subtraídas
<timeUnit>	Sim	String	Unidade de tempo a ser usado com intervalo: "Segundo", "Minuto", "Hora", "Dia", "Semana", "Mês", "Ano"
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<updated-timestamp>	String	O carimbo de data/hora menos o número de unidades de tempo especificado

Exemplo 1

Esse exemplo subtrai um dia desse carimbo de data/hora:

subtractFromTime('2018-01-02T00:00:00Z', 1, 'Day')

E retorna este resultado: "2018-01-01T00:00:00:0000000Z"

Exemplo 2

Esse exemplo subtrai um dia desse carimbo de data/hora:

subtractFromTime('2018-01-02T00:00:00Z', 1, 'Day', 'D')

E retorna este resultado usando o formato "D" opcional: "Monday, January, 1, 2018"

take

Retornar itens do início de uma coleção.

take('<collection>', <count>)
take([<collection>], <count>)

Parâmetro	Obrigatório	Type	Descrição
<collection>	Sim	String ou Array	A coleção cujos itens você deseja
<count>	Sim	Integer	Um inteiro positivo para o número de itens que você deseja no início

Valor retornado	Type	Descrição
<subconjunto> ou [<subconjunto>]	String ou Array, respectivamente	Uma cadeia de caracteres ou matriz que tem o número de itens especificado extraído do início da coleção original

Exemplo

Esses exemplos obtêm o número de itens especificado no início destas coleções:

take('abcde', 3)
take(createArray(0, 1, 2, 3, 4), 3)

E retornam estes resultados:

• Primeiro exemplo: "abc"
• Segundo exemplo: [0, 1, 2]

ticks

Retornar o valor de propriedade ticks de um carimbo de data/hora especificado. Um tique é um intervalo de 100 nanossegundos.

ticks('<timestamp>')

Parâmetro	Obrigatório	Type	Descrição
<timestamp>	Sim	String	A cadeia de caracteres de um carimbo de data/hora

Valor retornado	Type	Descrição
<ticks-number>	Integer	O número de tiques decorridos desde às 12:00:00 (meia-noite) do dia 1º de janeiro de 0001 do calendário gregoriano até o carimbo de data/hora de entrada

toLower

Retornar uma cadeia de caracteres em letras minúsculas. Se um caractere na cadeia de caracteres não tiver uma versão em minúsculas, esse caractere permanecerá inalterado na cadeia de caracteres retornada.

toLower('<text>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	String	A cadeia de caracteres a ser retornada no formato em minúsculas

Valor retornado	Type	Descrição
<lowercase-text>	String	A cadeia de caracteres original no formato em minúsculas

Exemplo

Esse exemplo converte essa cadeia de caracteres em minúsculas:

toLower('Hello World')

E retorna este resultado: "hello world"

toUpper

Retornar uma cadeia de caracteres em letras maiúsculas. Se um caractere na cadeia de caracteres não tiver uma versão em maiúsculas, esse caractere permanecerá inalterado na cadeia de caracteres retornada.

toUpper('<text>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	String	A cadeia de caracteres a ser retornada no formato em maiúsculas

Valor retornado	Type	Descrição
<uppercase-text>	String	A cadeia de caracteres original no formato em maiúsculas

Exemplo

Esse exemplo converte essa cadeia de caracteres em maiúsculas:

toUpper('Hello World')

E retorna este resultado: "HELLO WORLD"

cortar

Remover espaços em branco à esquerda e à direita de uma cadeia de caracteres e retornar a cadeia de caracteres atualizada.

trim('<text>')

Parâmetro	Obrigatório	Type	Descrição
<text>	Sim	String	A cadeia de caracteres que tem o espaço em branco à esquerda e à direita a ser removida

Valor retornado	Type	Descrição
<updatedText>	String	Uma versão atualizada da cadeia de caracteres original sem espaço em branco à esquerda ou à direita

Exemplo

Este exemplo remove o espaço em branco à esquerda e à direita da cadeia de caracteres "Olá, Mundo":

trim(' Hello World  ')

E retorna este resultado: "Hello World"

union

Retornar uma coleção que tem todos os itens das coleções especificadas. Para aparecer no resultado, um item pode ser exibido em qualquer coleção passada para essa função. Se um ou mais itens tiverem o mesmo nome, o último item com o nome será exibido neste resultado.

union('<collection1>', '<collection2>', ...)
union([<collection1>], [<collection2>], ...)

Parâmetro	Obrigatório	Type	Descrição
<colleção1>, <colleção2>, ...	Sim	Matriz ou objeto, mas não ambos	As coleções das quais você deseja todos os itens

Valor retornado	Type	Descrição
<updatedCollection>	Array ou Object, respectivamente	Uma coleção com todos os itens das coleções especificadas – sem duplicatas

Exemplo

Esse exemplo obtém todos os itens destas coleções:

union(createArray(1, 2, 3), createArray(1, 2, 10, 101))

E retorna este resultado: [1, 2, 3, 10, 101]

uriComponent

Retornar uma versão codificada para URI (Uniform Resource Identifier) para uma cadeia de caracteres substituindo caracteres desprotegidos de URL por caracteres de escape. Use esta função em vez de encodeUriComponent(). Embora as funções funcionem da mesma forma, uriComponent() é preferencial.

uriComponent('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres a ser convertida em um formato codificado para URI

Valor retornado	Type	Descrição
<encoded-uri>	String	A cadeia de caracteres codificada para URI com caracteres de escape

Exemplo

Esse exemplo cria uma versão codificada para URI para esta cadeia de caracteres:

uriComponent('https://contoso.com')

E retorna este resultado: "http%3A%2F%2Fcontoso.com"

uriComponentToBinary

Retornar a versão binária de um componente URI (Uniform Resource Identifier).

uriComponentToBinary('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres codificada para URI a ser convertida

Valor retornado	Type	Descrição
<binary-for-encoded-uri>	String	A versão binária da cadeia de caracteres codificada para URI. O conteúdo binário é codificado em Base64 e representado por $content.

Exemplo

Esse exemplo cria a versão binária para esta cadeia de caracteres codificada para URI:

uriComponentToBinary('http%3A%2F%2Fcontoso.com')

E retorna este resultado:

"001000100110100001110100011101000111000000100101001100 11010000010010010100110010010001100010010100110010010001 10011000110110111101101110011101000110111101110011011011 110010111001100011011011110110110100100010"

uriComponentToString

Retornar a versão de cadeia de caracteres para uma cadeia de caracteres codificada para URI (Uniform Resource Identifier), decodificando com eficácia a cadeia de caracteres codificada para URI.

uriComponentToString('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres codificada para URI a ser decodificada

Valor retornado	Type	Descrição
<decoded-uri>	String	A versão decodificada para a cadeia de caracteres codificada para URI

Exemplo

Esse exemplo cria a versão de cadeia de caracteres decodificada para esta cadeia de caracteres codificada para URI:

uriComponentToString('http%3A%2F%2Fcontoso.com')

E retorna este resultado: "https://contoso.com"

utcNow

Retornar o carimbo de data/hora atual.

utcNow('<format>')

Opcionalmente, é possível especificar um formato diferente com o parâmetro <formato>.

Parâmetro	Obrigatório	Type	Descrição
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão do carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), compatível com a ISO 8601 e que preserva informações de fuso horário.

Valor retornado	Type	Descrição
<current-timestamp>	String	A data e hora atual

Exemplo 1

Suponha que hoje é 15 de abril de 2018, às 13h. Esse exemplo obtém o carimbo de data/hora atual:

utcNow()

E retorna este resultado: "2018-04-15T13:00:00.0000000Z"

Exemplo 2

Suponha que hoje é 15 de abril de 2018, às 13h. Esse exemplo obtém o carimbo de data/hora atual usando o formato "D" opcional:

utcNow('D')

E retorna este resultado: "Sunday, April 15, 2018"

Xml

Retornar a versão XML de uma cadeia de caracteres que contém um objeto JSON.

xml('<value>')

Parâmetro	Obrigatório	Type	Descrição
<value>	Sim	String	A cadeia de caracteres com o objeto JSON a ser convertido O objeto JSON deve ter apenas uma propriedade raiz, que não pode ser uma matriz. Use o caractere de barra invertida (\) como um caractere de escape para aspas duplas (").

Valor retornado	Type	Descrição
<xml-version>	Objeto	O XML codificado para a cadeia de caracteres ou objeto JSON especificado

Exemplo 1

Esse exemplo cria a versão XML desta cadeia de caracteres, que contém um objeto JSON:

xml(json('{ \"name\": \"Sophia Owen\" }'))

E retorna este XML de resultado:

<name>Sophia Owen</name>

Exemplo 2

Suponha que você tem este objeto JSON:

{
  "person": {
    "name": "Sophia Owen",
    "city": "Seattle"
  }
}

Esse exemplo cria o XML para uma cadeia de caracteres que contém este objeto JSON:

xml(json('{\"person\": {\"name\": \"Sophia Owen\", \"city\": \"Seattle\"}}'))

E retorna este XML de resultado:

<person>
  <name>Sophia Owen</name>
  <city>Seattle</city>
<person>

xpath

Verificar o XML em busca de nós ou valores correspondentes a uma expressão XPath (Linguagem XPath) e retornar esses nós ou valores. Uma expressão XPath, ou apenas "XPath", ajuda você a navegar por uma estrutura de documento XML para poder selecionar nós ou calcular valores no conteúdo XML.

xpath('<xml>', '<xpath>')

Parâmetro	Obrigatório	Type	Descrição
<xml>	Sim	Qualquer	A cadeia de caracteres XML na qual pesquisar nós ou valores correspondentes a um valor de expressão XPath
<xpath>	Sim	Qualquer	A expressão XPath usada para localizar valores ou nós XML correspondentes

Valor retornado	Type	Descrição
<xml-node>	XML	Um nó XML quando um único nó corresponde à expressão XPath especificada
<value>	Qualquer	O valor de um nó XML quando apenas um único valor corresponde à expressão XPath especificada
[<nó-xml1>, <nó-xml2>, ...] -ou- [<valor1>, <valor2>, ...]	Array	Uma matriz com valores ou nós XML correspondentes à expressão XPath especificada

Exemplo 1

A seguir, no Exemplo 1, Esse exemplo localiza nós correspondentes ao nó <count></count> e adiciona esses valores de nó com a função sum():

xpath(xml(parameters('items')), 'sum(/produce/item/count)')

E retorna este resultado: 30

Exemplo 2

Para esse exemplo, as duas expressões localizam nós correspondentes ao nó <location></location>, nos argumentos especificados, que incluem o XML com um namespace. As expressões usam o caractere de barra invertida (\) como um caractere de escape para aspas duplas (").

• Expressão 1

  xpath(xml(body('Http')), '/*[name()=\"file\"]/*[name()=\"location\"]')

• Expressão 2

  xpath(xml(body('Http')), '/*[local-name()=\"file\" and namespace-uri()=\"http://contoso.com\"]/*[local-name()=\"location\"]')

Veja os argumentos:

• Esse XML, que inclui o namespace do documento XML, xmlns="http://contoso.com":

  <?xml version="1.0"?> <file xmlns="http://contoso.com"> <location>Paris</location> </file>
  

• A expressão XPath aqui:

  • /*[name()=\"file\"]/*[name()=\"location\"]

  • /*[local-name()=\"file\" and namespace-uri()=\"http://contoso.com\"]/*[local-name()=\"location\"]

Veja o nó de resultado correspondente ao nó <location></location>:

<location xmlns="https://contoso.com">Paris</location>

Exemplo 3

A seguir, no Exemplo 3, esse exemplo localiza o valor no nó <location></location>:

xpath(xml(body('Http')), 'string(/*[name()=\"file\"]/*[name()=\"location\"])')

E retorna este resultado: "Paris"

Observação

É possível adicionar comentários a expressões de fluxo de dados, mas não em expressões de pipeline.

Conteúdo relacionado

Para obter uma lista de variáveis de sistema que você pode usar em expressões, consulte Variáveis do sistema.