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

Artigo
04/08/2024

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Gorjeta

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

Este artigo fornece detalhes sobre expressões e funções suportadas 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 em tempo de execução. Por exemplo:

"name": "value"

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

As expressões podem aparecer em qualquer lugar em um valor de cadeia de caracteres JSON e sempre resultam em outro valor JSON. Se um valor JSON for uma expressão, o corpo da expressão será extraído removendo o at-sign (@). Se for necessária uma cadeia de caracteres literal que comece com @, ela deverá ser escapada usando @@. Os exemplos a seguir mostram como as expressões são avaliadas.

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

As expressões também podem aparecer dentro de cadeias de caracteres, usando um recurso chamado interpolação de cadeia de caracteres, onde as expressões sã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 myNumber defini 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"	Devolve `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('A 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 uma matriz a ser iterada para os itens de propriedade e usar @item() para iterar sobre uma única enumeração na atividade ForEach. Por exemplo, se items for uma matriz: [1, 2, 3], @item() retorna 1 na primeira iteração, 2 na segunda iteração e 3 na terceira iteração. Você também pode usar @range(0,10) a expressão like para iterar dez vezes começando com 0 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 se parece com: @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 para um subcampo, use a sintaxe [] em vez do operador dot(.) (como no caso do subcampo1 e subcampo2), como parte de uma saída de atividade.

@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 arquivos dinâmicos.

Anexar Data a um nome de arquivo: @concat('Test_', formatDateTime(utcnow(), 'yyyy-dd-MM'))
Anexar DateTime no fuso horário do cliente : @concat('Test_', convertFromUtc(utcnow(), 'Pacific Standard Time'))
Acrescentar tempo de gatilho : @concat('Test_', pipeline().TriggerTime)
Saída de um nome de arquivo personalizado em um fluxo de dados de mapeamento ao enviar para um único arquivo com data : 'Test_' + toString(currentDate()) + '.csv'

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

Editor de conteúdo dinâmico

O editor de conteúdo dinâmico escapa automaticamente dos caracteres do seu conteúdo quando você termina de editar. 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 mostrada abaixo.

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

Um conjunto de dados com um parâmetro

No exemplo a seguir, o BlobDataset usa um parâmetro chamado path. Seu valor é usado para definir um valor para a propriedade folderPath usando a expressão: 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 caminho para o conjunto de dados de blob parametrizado é definido usando valores desses parâmetros. A sintaxe utilizada 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"
            }
        }
    }
}

Substituindo caracteres especiais

O editor de conteúdo dinâmico escapa automaticamente de caracteres como aspas duplas, barra invertida em seu conteúdo quando você termina de editar. Isso causa problemas se você quiser substituir o feed de linha ou a 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 você pode seguir as etapas abaixo para substituir caracteres especiais usando a linguagem de expressão:

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

Por exemplo, a variável companyName com um caractere newline em seu valor, expression @uriComponentToString(replace(uriComponent(variables('companyName')), '%0A', '')) pode remover o caractere newline.

Contoso-
Corporation

Escapando do caractere de aspas simples

As funções de expressão usam aspas simples para parâmetros de valor de cadeia de caracteres. Use duas aspas simples para escapar de um ' caractere em funções de cadeia de caracteres. Por exemplo, a expressão @concat('Baba', '''s ', 'book store') retornará abaixo do resultado.

Baba's book store

Tutorial

Este tutorial orienta você 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 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 usadas em uma expressão.

Funções de data

Função de data ou hora	Task
addDias	Adicione um número de dias a um carimbo de data/hora.
addHours	Adicione um número de horas a um carimbo de data/hora.
adicionarMinutos	Adicione alguns minutos a um carimbo de data/hora.
addSeconds	Adicione alguns segundos a um carimbo de data/hora.
addToTime	Adicione várias unidades de tempo a um carimbo de data/hora. Consulte também getFutureTime.
convertFromUtc	Converta um carimbo de data/hora de Universal Time Coordinated (UTC) para o fuso horário de destino.
convertTimeZone	Converta um carimbo de data/hora do fuso horário de origem para o fuso horário de destino.
convertToUtc	Converta um carimbo de data/hora do fuso horário de origem em Universal Time Coordinated (UTC).
diadeMês	Retornar o componente dia do mês de um carimbo de data/hora.
diadesemana	Retornar o componente dia da semana de um carimbo de data/hora.
diadeano	Retornar o componente dia do ano de um carimbo de data/hora.
formatDateTime	Retorne o carimbo de data/hora como uma cadeia de caracteres no formato opcional.
getFutureTime	Retorne o carimbo de data/hora atual mais as unidades de tempo especificadas. Consulte também addToTime.
getPastTime	Retorne o carimbo de data/hora atual menos as unidades de tempo especificadas. Consulte também subtractFromTime.
inícioOfDay	Retorne o início do dia para um carimbo de data/hora.
iníciodehora	Retorne o início da hora para um carimbo de data/hora.
iníciodemês	Retorne o início do mês para um carimbo de data/hora.
subtrairFromTime	Subtraia várias unidades de tempo de um carimbo de data/hora. Consulte também getPastTime.
carrapatos	Retornar o valor da propriedade para um carimbo `ticks` de data/hora especificado.
utcAgora	Retorne o carimbo de data/hora atual como uma cadeia de caracteres.

Funções de cadeia

Para trabalhar com cadeias de caracteres, você pode usar essas funções de cadeia de caracteres e também algumas funções de coleção. As funções de cadeia de caracteres funcionam apenas em cadeias de caracteres.

Função da cadeia de carateres	Task
concat	Combine duas ou mais cadeias de caracteres e retorne a cadeia combinada.
termina com	Verifique se uma cadeia de caracteres termina com a subcadeia especificada.
GUID	Gere um identificador global exclusivo (GUID) como uma cadeia de caracteres.
indexOf	Retornar a posição inicial de uma substring.
lastIndexOf	Retorne a posição inicial para a última ocorrência de uma substring.
replace	Substitua uma substring pela string especificada e retorne a string atualizada.
split	Divida uma cadeia de caracteres em cada ocorrência de um delimitador especificado, retornando as substrings resultantes como elementos de uma matriz.
começaCom	Verifique se uma cadeia de caracteres começa com uma subcadeia de caracteres específica.
substring	Retorna caracteres de uma cadeia de caracteres, começando a partir da posição especificada.
paraMais baixo	Retornar uma cadeia de caracteres em formato minúsculo.
toUpper	Retornar uma cadeia de caracteres em formato maiúsculo.
guarnição	Remova o espaço em branco à esquerda e à direita de uma cadeia de caracteres e retorne a cadeia de caracteres atualizada.

Funções de recolha

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

Função de recolha	Task
contém:	Verifique se uma coleção tem um item específico.
empty	Verifique se uma coleção está vazia.
primeiro	Retornar o primeiro item de uma coleção.
intersecção	Retornar uma coleção que tenha apenas os itens comuns nas coleções especificadas.
aderir	Retorna uma cadeia de caracteres que tem todos os itens de uma matriz, separados pelo caractere especificado.
último	Retornar o último item de uma coleção.
length	Retornar o número de itens em uma cadeia de caracteres ou matriz.
pular	Remova itens da frente de uma coleção e devolva todos os outros itens.
tomar	Devolver itens da frente de uma coleção.
União	Retornar uma coleção que tenha todos os itens das coleções especificadas.

Funções lógicas

Estas funções são úteis dentro das condições, elas podem ser usadas para avaliar qualquer tipo de lógica.

Função de comparação lógica	Task
and	Verifique se todas as expressões são verdadeiras.
igual a	Verifique se ambos os valores são equivalentes.
greater	Verifique se o primeiro valor é maior que o segundo.
greaterOrEquals	Verifique se o primeiro valor é maior ou igual ao segundo valor.
se	Verifique se uma expressão é verdadeira ou falsa. Com base no resultado, retorne um valor especificado.
less	Verifique se o primeiro valor é menor que o segundo.
lessOrEquals	Verifique se o primeiro valor é menor ou igual ao segundo valor.
não	Verifique se uma expressão é falsa.
or	Verifique 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 na linguagem:

string
integer
flutuante
boolean
matrizes
dicionários

Função de conversão	Task
matriz	Retornar uma matriz de uma única entrada especificada. Para várias entradas, consulte createArray.
base64	Retorne a versão codificada em base64 para uma cadeia de caracteres.
base64ToBinary	Retorne a versão binária para uma cadeia de caracteres codificada em base64.
base64ToString	Retorne a versão da cadeia de caracteres para uma cadeia de caracteres codificada em base64.
binário	Retornar a versão binária para um valor de entrada.
Bool	Retorne a versão booleana para um valor de entrada.
coalesce	Retorna 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 para um valor de entrada.
dataUriToBinary	Retornar a versão binária para um URI de dados.
dataUriToString	Retornar a versão da cadeia de caracteres para um URI de dados.
decodeBase64	Retorne a versão da cadeia de caracteres para uma cadeia de caracteres codificada em base64.
decodeDataUri	Retornar a versão binária para um URI de dados.
decodeUriComponent	Retorna uma cadeia de caracteres que substitui caracteres de escape por versões decodificadas.
encodeUriComponent	Retorna uma cadeia de caracteres que substitui caracteres não seguros de URL por caracteres de escape.
flutuar	Retorna um número de ponto flutuante para um valor de entrada.
Int	Retorne a versão inteira para uma cadeia de caracteres.
Json	Retorne o valor ou objeto do tipo JSON (JavaScript Object Notation) para uma cadeia de caracteres ou XML.
string	Retorne a versão da cadeia de caracteres para um valor de entrada.
uriComponent	Retorne a versão codificada por URI para um valor de entrada substituindo caracteres não seguros de URL por caracteres de escape.
uriComponentToBinary	Retorne a versão binária para uma cadeia de caracteres codificada por URI.
uriComponentToString	Retorne a versão da cadeia de caracteres para uma cadeia de caracteres codificada por URI.
xml	Retornar a versão XML para uma cadeia de caracteres.
XPath	Verifique se há nós ou valores que correspondam a uma expressão XPath (XML Path Language) e retorne os nós ou valores correspondentes.

Funções matemáticas

Estas funções podem ser usadas para qualquer tipo de números: inteiros e flutuantes.

Função matemática	Task
adicionar	Retornar o resultado da adição de dois números.
div	Retornar o resultado da divisão de um número por outro número.
máx.	Retornar o valor mais alto de um conjunto de números ou de uma matriz.
min	Retornar o menor valor de um conjunto de números ou de uma matriz.
Mod	Retorne o restante da divisão de um número por outro.
Mul	Devolva o produto multiplicando dois números.
RAND	Retornar um inteiro aleatório de um intervalo especificado.
range	Retornar uma matriz inteira que começa a partir de um inteiro especificado.
sub	Retornar o resultado da subtração de um número de outro.

Referência da função

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

adicionar

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

add(<summand_1>, <summand_2>)

Parâmetro	Necessário	Type	Description
<summand_1>, <summand_2>	Sim	Inteiro, Flutuante ou misto	Os números a adicionar

Valor devolvido	Tipo	Description
<soma-resultado>	Inteiro ou flutuador	O resultado da adição dos números especificados

Exemplo

Este exemplo adiciona os números especificados:

add(1, 1.5)

E devolve este resultado: 2.5

addDias

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

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora
<Dias>	Sim	Número inteiro	O número positivo ou negativo de dias a adicionar
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora mais o número especificado de dias

Exemplo 1

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

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

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

Exemplo 2

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

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

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

addHours

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

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora
<hours>	Sim	Número inteiro	O número positivo ou negativo de horas a adicionar
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora mais o número especificado de horas

Exemplo 1

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

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

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

Exemplo 2

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

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

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

adicionarMinutos

Adicione alguns minutos a um carimbo de data/hora.

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora
<minutes>	Sim	Número inteiro	O número positivo ou negativo de minutos a adicionar
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora mais o número especificado de minutos

Exemplo 1

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

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

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

Exemplo 2

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

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

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

addSeconds

Adicione alguns segundos a um carimbo de data/hora.

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora
<segundos>	Sim	Número inteiro	O número positivo ou negativo de segundos a adicionar
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora mais o número especificado de segundos

Exemplo 1

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

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

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

Exemplo 2

Este exemplo subtrai cinco segundos para o carimbo de data/hora especificado:

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

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

addToTime

Adicione várias unidades de tempo a um carimbo de data/hora. Consulte também getFutureTime().

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora
<interval>	Sim	Número inteiro	O número de unidades de tempo especificadas a serem adicionadas
<timeUnit>	Sim	String	A unidade de tempo a utilizar 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 para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora mais o número especificado de unidades de tempo

Exemplo 1

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

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

E devolve 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. Retorne true quando ambas as expressões forem verdadeiras ou retorne false quando pelo menos uma expressão for false.

and(<expression1>, <expression2>)

Parâmetro	Necessário	Type	Description
<expressão1>, <expressão2>	Sim	Boolean	As expressões a verificar

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorne true quando ambas as expressões forem verdadeiras. Retorne false quando pelo menos uma expressão for false.

Exemplo 1

Estes exemplos verificam se os valores booleanos especificados são verdadeiros:

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

E devolve estes resultados:

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

Exemplo 2

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

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

E devolve estes resultados:

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

matriz

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

array('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres para criar uma matriz

Valor devolvido	Tipo	Description
[<valor>]	Matriz	Uma matriz que contém a única entrada especificada

Exemplo

Este exemplo cria uma matriz a partir da cadeia de caracteres "hello":

array('hello')

E devolve este resultado: ["hello"]

base64

Retorne a versão codificada em base64 para uma cadeia de caracteres.

base64('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres de entrada

Valor devolvido	Tipo	Description
<base64-string>	String	A versão codificada em base64 para a cadeia de caracteres de entrada

Exemplo

Este exemplo converte a string "hello" em uma string codificada em base64:

base64('hello')

E devolve este resultado: "aGVsbG8="

base64ToBinary

Retorne a versão binária para uma cadeia de caracteres codificada em base64.

base64ToBinary('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres codificada em base64 para converter

Valor devolvido	Tipo	Description
<binário para base64-string>	String	A versão binária para a cadeia de caracteres codificada em base64

Exemplo

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

base64ToBinary('aGVsbG8=')

E devolve este resultado:

"0110000101000111010101100111001101100010010001110011100000111101"

base64ToString

Retorne a versão da cadeia de caracteres para uma cadeia de caracteres codificada em base64, decodificando efetivamente a cadeia de caracteres base64. Use esta função em vez de decodeBase64(). Embora ambas as funções funcionem da mesma maneira, base64ToString() é preferível.

base64ToString('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres codificada em base64 para decodificar

Valor devolvido	Tipo	Description
<decodificado-base64-string>	String	A versão da cadeia de caracteres para uma cadeia de caracteres codificada em base64

Exemplo

Este exemplo converte a string codificada em "aGVsbG8=" base64 em apenas uma string:

base64ToString('aGVsbG8=')

E devolve este resultado: "hello"

binário

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

binary('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres a ser convertida

Valor devolvido	Tipo	Description
<binário para valor de entrada>	String	A versão binária para a cadeia de caracteres especificada

Exemplo

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

binary('hello')

E devolve este resultado:

"0110100001100101011011000110110001101111"

booleano

Retorne a versão booleana para obter um valor.

bool(<value>)

Parâmetro	Necessário	Type	Description
<valor>	Sim	Qualquer	O valor a converter

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	A versão booleana para o valor especificado

Exemplo

Estes exemplos convertem os valores especificados em valores booleanos:

bool(1)
bool(0)

E devolve estes resultados:

Primeiro exemplo: true
Segundo exemplo: false

coalesce

Retorna 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	Necessário	Type	Description
<object_1>, <object_2>, ...	Sim	Qualquer um pode misturar tipos	Um ou mais itens para verificar se há nulo

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

Exemplo

Estes exemplos retornam o primeiro valor não nulo dos valores especificados ou null quando todos os valores são nulos:

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

E devolve estes resultados:

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

concat

Combine duas ou mais cadeias de caracteres e retorne a cadeia combinada.

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

Parâmetro	Necessário	Type	Description
<texto1>, <texto2>, ...	Sim	String	Pelo menos duas cadeias de caracteres para combinar

Valor devolvido	Tipo	Description
<texto1texto2...>	String	A cadeia de caracteres criada a partir das cadeias de caracteres de entrada combinadas

Exemplo

Este exemplo combina as cadeias de caracteres "Hello" e "World":

concat('Hello', 'World')

E devolve este resultado: "HelloWorld"

contém

Verifique se uma coleção tem um item específico. Retorne true quando o item for encontrado ou retorne false quando não for encontrado. Esta 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 substring
Uma matriz para encontrar um valor
Um dicionário para encontrar uma chave

Parâmetro	Necessário	Type	Description
<Coleção>	Sim	String, matriz ou dicionário	A coleção a verificar
<valor>	Sim	String, Array ou Dictionary, respectivamente	O item a ser encontrado

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorne true quando o item for encontrado. Retornar false quando não encontrado.

Exemplo 1

Este exemplo verifica a string "hello world" para a substring "world" e retorna true:

contains('hello world', 'world')

Exemplo 2

Este exemplo verifica a string "hello world" para a substring "universe" e retorna false:

contains('hello world', 'universe')

convertFromUtc

Converta um carimbo de data/hora de Universal Time Coordinated (UTC) para o fuso horário de destino.

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora
<destinationTimeZone>	Sim	String	O nome do fuso horário de destino. Para nomes de fuso horário, consulte Valores de fuso horário da Microsoft, mas talvez seja necessário remover qualquer pontuação do nome de fuso horário.
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<Carimbo de data/hora convertido>	String	O carimbo de data/hora convertido para o fuso horário de destino

Exemplo 1

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

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

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

Exemplo 2

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

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

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

convertTimeZone

Converta um carimbo de data/hora do fuso horário de origem para o fuso horário de destino.

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora
<sourceTimeZone>	Sim	String	O nome do fuso horário de origem. Para nomes de fuso horário, consulte Valores de fuso horário da Microsoft, mas talvez seja necessário remover qualquer pontuação do nome de fuso horário.
<destinationTimeZone>	Sim	String	O nome do fuso horário de destino. Para nomes de fuso horário, consulte Valores de fuso horário da Microsoft, mas talvez seja necessário remover qualquer pontuação do nome de fuso horário.
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<Carimbo de data/hora convertido>	String	O carimbo de data/hora convertido para o fuso horário de destino

Exemplo 1

Este 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 devolve este resultado: "2018-01-01T00:00:00.0000000"

Exemplo 2

Este exemplo converte um fuso horário para o fuso horário e formato especificados:

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

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

convertToUtc

Converta um carimbo de data/hora do fuso horário de origem em Universal Time Coordinated (UTC).

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora
<sourceTimeZone>	Sim	String	O nome do fuso horário de origem. Para nomes de fuso horário, consulte Valores de fuso horário da Microsoft, mas talvez seja necessário remover qualquer pontuação do nome de fuso horário.
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<Carimbo de data/hora convertido>	String	O carimbo de data/hora convertido em UTC

Exemplo 1

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

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

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

Exemplo 2

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

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

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

createArray

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

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

Parâmetro	Necessário	Type	Description
<object1>, <object2>, ...	Sim	Qualquer, mas não misturado	Pelo menos dois itens para criar a matriz

Valor devolvido	Tipo	Description
[<object1>, <object2>, ...]	Matriz	A matriz criada a partir de todos os itens de entrada

Exemplo

Este exemplo cria uma matriz a partir destas entradas:

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

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

dataUri

Retorna um URI (identificador uniforme de recurso) de dados para uma cadeia de caracteres.

dataUri('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres a ser convertida

Valor devolvido	Tipo	Description
<URI-DADOS>	String	O URI de dados para a cadeia de caracteres de entrada

Exemplo

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

dataUri('hello')

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

dataUriToBinary

Retornar a versão binária para um URI (identificador de recurso uniforme de dados). Use esta função em vez de decodeDataUri(). Embora ambas as funções funcionem da mesma maneira, dataUriBinary() é preferível.

dataUriToBinary('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	O URI de dados a ser convertido

Valor devolvido	Tipo	Description
<binário-para-data-uri>	String	A versão binária para o URI de dados

Exemplo

Este exemplo cria uma versão binária para este URI de dados:

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

E devolve este resultado:

"01100100011000010111010001100001001110100111010001100101011110000111010000101111011100000 1101100011000010110100101101110001110110110001101101000011000010111001001110011011001010111 0100001111010111010101110100011001100010110100111000001110110110001001100001011100110110010 10011011000110100001011000110000101000111010101100111001101100010010001110011100000111101"

dataUriToString

Retornar a versão da cadeia de caracteres para um URI (identificador de recurso uniforme de dados).

dataUriToString('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	O URI de dados a ser convertido

Valor devolvido	Tipo	Description
<string-for-data-uri>	String	A versão da cadeia de caracteres para o URI de dados

Exemplo

Este exemplo cria uma cadeia de caracteres para este URI de dados:

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

E devolve este resultado: "hello"

diadeMês

Retorne o dia do mês a partir de um carimbo de data/hora.

dayOfMonth('<timestamp>')

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora

Valor devolvido	Tipo	Description
<dia-do-mês>	Número inteiro	O dia do mês a partir do carimbo de data/hora especificado

Exemplo

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

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

E devolve este resultado: 15

diadesemana

Retorne o dia da semana a partir de um carimbo de data/hora.

dayOfWeek('<timestamp>')

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora

Valor devolvido	Tipo	Description
<dia-da-semana>	Número inteiro	O dia da semana a partir do carimbo de data/hora especificado, onde domingo é 0, segunda-feira é 1 e assim por diante

Exemplo

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

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

E devolve este resultado: 3

diadeano

Retorne o dia do ano a partir de um carimbo de data/hora.

dayOfYear('<timestamp>')

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora

Valor devolvido	Tipo	Description
<dia-do-ano>	Número inteiro	O dia do ano a partir do carimbo de data/hora especificado

Exemplo

Este exemplo retorna o número do dia do ano deste carimbo de data/hora:

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

E devolve este resultado: 74

decodeBase64

Retorne a versão da cadeia de caracteres para uma cadeia de caracteres codificada em base64, decodificando efetivamente a cadeia de caracteres base64. Considere usar base64ToString() em vez de decodeBase64(). Embora ambas as funções funcionem da mesma maneira, base64ToString() é preferível.

decodeBase64('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres codificada em base64 para decodificar

Valor devolvido	Tipo	Description
<decodificado-base64-string>	String	A versão da cadeia de caracteres para uma cadeia de caracteres codificada em base64

Exemplo

Este exemplo cria uma cadeia de caracteres para uma cadeia de caracteres codificada em base64:

decodeBase64('aGVsbG8=')

E devolve este resultado: "hello"

decodeDataUri

Retornar a versão binária para um URI (identificador de recurso uniforme de dados). Considere o uso de dataUriToBinary(), em vez de decodeDataUri(). Embora ambas as funções funcionem da mesma maneira, dataUriToBinary() é preferível.

decodeDataUri('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres de URI de dados a ser decodificada

Valor devolvido	Tipo	Description
<binário-para-data-uri>	String	A versão binária para uma cadeia de caracteres URI de dados

Exemplo

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

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

E devolve este resultado:

decodeUriComponent

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

decodeUriComponent('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres com os caracteres de escape para decodificar

Valor devolvido	Tipo	Description
<Decodificado-URI>	String	A cadeia de caracteres atualizada com os caracteres de escape decodificados

Exemplo

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

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

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

div

Devolve 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 de seus parâmetros — veja exemplos para obter detalhes.

Parâmetro	Necessário	Type	Description
<dividendos>	Sim	Inteiro ou flutuador	O número a dividir pelo divisor
<divisor>	Sim	Inteiro ou flutuador	O número que divide o dividendo. Um valor de divisor de zero causa um erro em tempo de execução.

Valor devolvido	Tipo	Description
<quociente-resultado>	Inteiro ou flutuador	O resultado da divisão do primeiro número pelo segundo número

Exemplo 1

Estes exemplos dividem o número 9 por 2:

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

E todos retornam esse 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 restante é descartado (divisão inteira):

div(9, 2)

A expressão retorna o resultado 4. Para obter o valor do restante, use a função mod( ).

encodeUriComponent

Retorna uma versão codificada de URI (identificador de recurso uniforme) para uma cadeia de caracteres substituindo caracteres não seguros de URL por caracteres de escape. Considere usar uriComponent(), em vez de encodeUriComponent(). Embora ambas as funções funcionem da mesma maneira, uriComponent() é preferível.

encodeUriComponent('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres a ser convertida para o formato codificado por URI

Valor devolvido	Tipo	Description
<encoded-uri>	String	A cadeia de caracteres codificada por URI com caracteres de escape

Exemplo

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

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

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

empty

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

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

Parâmetro	Necessário	Type	Description
<Coleção>	Sim	String, matriz ou objeto	A coleção a verificar

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorne true quando a coleção estiver vazia. Retornar false quando não estiver vazio.

Exemplo

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

empty('')
empty('abc')

E devolve estes resultados:

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

termina com

Verifique se uma cadeia de caracteres termina com uma subcadeia específica. Retorne true quando a substring for encontrada ou retorne false quando não for encontrado. Esta função não diferencia maiúsculas de minúsculas.

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

Parâmetro	Necessário	Type	Descrição
<texto>	Sim	String	A cadeia de caracteres a ser verificada
<pesquisaTexto>	Sim	String	A substring final para localizar

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorne true quando a substring final for encontrada. Retornar false quando não encontrado.

Exemplo 1

Este exemplo verifica se a cadeia de caracteres "hello world" termina com a string "world":

endsWith('hello world', 'world')

E devolve este resultado: true

Exemplo 2

Este exemplo verifica se a string "hello world" termina com a string "universe":

endsWith('hello world', 'universe')

E devolve este resultado: false

equals

Verifique se ambos os valores, expressões ou objetos são equivalentes. Retorne true quando ambos forem equivalentes, ou retorne false quando não forem equivalentes.

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

Parâmetro	Necessário	Type	Description
<objeto1>, <objeto2>	Sim	Vários	Os valores, expressões ou objetos a serem comparados

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorne true quando ambos forem equivalentes. Retornar false quando não equivalente.

Exemplo

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

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

E devolve estes resultados:

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

Primeiro

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

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

Parâmetro	Necessário	Type	Description
<Coleção>	Sim	String ou matriz	A coleção onde encontrar o primeiro item

Valor devolvido	Tipo	Description
<primeiro item de coleção>	Qualquer	O primeiro item da coleção

Exemplo

Estes exemplos encontram o primeiro item destas coleções:

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

E devolva estes resultados:

Primeiro exemplo: "h"
Segundo exemplo: 0

flutuante

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	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres que tem um número de ponto flutuante válido para converter

Valor devolvido	Tipo	Description
<valor flutuante>	Float	O número de vírgula flutuante para a cadeia de caracteres especificada

Exemplo

Este exemplo cria uma versão de cadeia de caracteres para esse número de vírgula flutuante:

float('10.333')

E devolve este resultado: 10.333

formatDateTime

Retornar um carimbo de data/hora no formato especificado.

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A 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 para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora reformatado>	String	O carimbo de data/hora atualizado no formato especificado

Exemplo

Este exemplo converte um carimbo de data/hora para o formato especificado:

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

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

getFutureTime

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

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

Parâmetro	Necessário	Type	Description
<interval>	Sim	Número inteiro	O número de unidades de tempo especificadas a serem adicionadas
<timeUnit>	Sim	String	A unidade de tempo a utilizar 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 para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora atual mais o número especificado de unidades de tempo

Exemplo 1

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

getFutureTime(5, 'Day')

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

Exemplo 2

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

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

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

getPastTime

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

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

Parâmetro	Necessário	Type	Description
<interval>	Sim	Número inteiro	O número de unidades de tempo especificadas para subtrair
<timeUnit>	Sim	String	A unidade de tempo a utilizar 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 para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora atual menos o número especificado de unidades de tempo

Exemplo 1

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

getPastTime(5, 'Day')

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

Exemplo 2

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

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

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

greater

Verifique se o primeiro valor é maior que o segundo. Retorne true quando o primeiro valor for mais ou retorne false quando for menor.

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

Parâmetro	Necessário	Type	Description
<valor>	Sim	Inteiro, Float ou String	O primeiro valor para verificar se é maior que o segundo valor
<compareTo>	Sim	Inteiro, Float ou String, respectivamente	O valor de comparação

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorne true quando o primeiro valor for maior que o segundo. Retorne false quando o primeiro valor for igual ou menor que o segundo valor.

Exemplo

Estes exemplos verificam se o primeiro valor é maior do que o segundo:

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

E devolva estes resultados:

Primeiro exemplo: true
Segundo exemplo: false

greaterOrEquals

Verifique se o primeiro valor é maior ou igual ao segundo valor. Retorne true quando o primeiro valor for maior ou igual, ou retorne false quando o primeiro valor for menor.

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

Parâmetro	Necessário	Type	Description
<valor>	Sim	Inteiro, Float ou String	O primeiro valor para verificar se maior ou igual ao segundo valor
<compareTo>	Sim	Inteiro, Float ou String, respectivamente	O valor de comparação

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorna true quando o primeiro valor é maior ou igual ao segundo valor. Retorna false quando o primeiro valor é menor que o segundo valor.

Exemplo

Estes exemplos verificam se o primeiro valor é maior ou igual ao segundo valor:

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

E devolva estes resultados:

Primeiro exemplo: true
Segundo exemplo: false

guid

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

guid()

Além disso, você pode especificar um formato diferente para o GUID diferente do formato padrão, "D", que é de 32 dígitos separados por hífenes.

guid('<format>')

Parâmetro	Necessário	Type	Description
<format>	Não	String	Um único especificador de formato para o GUID retornado. Por padrão, o formato é "D", mas você pode usar "N", "D", "B", "P" ou "X".

Valor devolvido	Tipo	Description
<Valor GUID>	String	Um GUID gerado aleatoriamente

Exemplo

Este exemplo gera o mesmo GUID, mas como 32 dígitos, separados por hífenes e entre parênteses:

guid('P')

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

if

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

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

Parâmetro	Necessário	Type	Description
<expressão>	Sim	Boolean	A expressão a verificar
<valorSeVerdadeiro>	Sim	Qualquer	O valor a ser retornado quando a expressão for true
<valorSeFalso>	Sim	Qualquer	O valor a ser retornado quando a expressão for false

Valor devolvido	Tipo	Description
<valor de retorno especificado>	Qualquer	O valor especificado que retorna com base em se a expressão é true ou false

Exemplo

Este 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 a posição inicial ou o valor do índice para uma substring. Esta 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	Necessário	Type	Descrição
<texto>	Sim	String	A cadeia de caracteres que tem a substring para localizar
<pesquisaTexto>	Sim	String	A substring a ser localizada

Valor devolvido	Tipo	Description
<valor-índice>	Número inteiro	A posição inicial ou o valor do índice para a subcadeia de caracteres especificada. Se a cadeia de caracteres não for encontrada, retorne o número -1.

Exemplo

Este exemplo localiza o valor de índice inicial para a substring "world" na string "hello world":

indexOf('hello world', 'world')

E devolve este resultado: 6

número inteiro

Retorne a versão inteira para uma cadeia de caracteres.

int('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres a ser convertida

Valor devolvido	Tipo	Description
<resultado inteiro>	Número inteiro	A versão inteira para a cadeia de caracteres especificada

Exemplo

Este exemplo cria uma versão inteira para a cadeia de caracteres "10":

int('10')

E devolve este resultado: 10

json

Retorne o valor ou objeto do tipo JSON (JavaScript Object Notation) para uma cadeia de caracteres ou XML.

json('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String ou XML	A cadeia de caracteres ou XML a ser convertido

Valor devolvido	Tipo	Description
<Resultado JSON>	Tipo ou objeto nativo JSON	O valor ou objeto do tipo nativo JSON para a cadeia de caracteres ou XML especificado. Se a cadeia de caracteres for null, a função retornará um objeto vazio.

Exemplo 1

Este exemplo converte essa cadeia de caracteres para o valor JSON:

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

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

Exemplo 2

Este exemplo converte essa cadeia de caracteres em JSON:

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

E devolve este resultado:

{
  "fullName": "Sophia Owen"
}

Exemplo 3

Este exemplo converte este XML em JSON:

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

E devolve este resultado:

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

intersecção

Retornar uma coleção que tenha apenas os itens comuns nas coleções especificadas. Para aparecer no resultado, um item deve aparecer em todas as coleções passadas para essa função. Se um ou mais itens tiverem o mesmo nome, o último item com esse nome aparecerá no resultado.

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

Parâmetro	Necessário	Type	Description
<coleção1>, <coleção2>, ...	Sim	Array ou Object, mas não ambos	As coleções de onde você deseja apenas os itens comuns

Valor devolvido	Tipo	Description
<itens comuns>	Array ou Object, respectivamente	Uma coleção que tem apenas os itens comuns nas coleções especificadas

Exemplo

Este exemplo localiza os itens comuns nessas 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

Retorna 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	Necessário	Type	Description
<Coleção>	Sim	Matriz	A matriz que tem os itens para unir
<delimitador>	Sim	String	O separador que aparece entre cada caractere na cadeia de caracteres resultante

Valor devolvido	Tipo	Description
<delimitador char1><delimitador><> char2...><	String	A cadeia de caracteres resultante criada a partir de todos os itens na matriz especificada

Exemplo

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

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

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

Último

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

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

Parâmetro	Necessário	Type	Description
<Coleção>	Sim	String ou matriz	A coleção onde encontrar o último item

Valor devolvido	Tipo	Description
<último item-coleção>	String ou Array, respectivamente	O último item da coleção

Exemplo

Estes exemplos encontram o último item destas coleções:

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

E devolve estes resultados:

Primeiro exemplo: "d"
Segundo exemplo: 3

lastIndexOf

Retornar a posição inicial ou o valor do índice para a última ocorrência de uma substring. Esta 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	Necessário	Type	Descrição
<texto>	Sim	String	A cadeia de caracteres que tem a substring para localizar
<pesquisaTexto>	Sim	String	A substring a ser localizada

Valor devolvido	Tipo	Description
<valor-índice-final>	Número inteiro	A posição inicial ou o valor do índice para a última ocorrência da substring especificada. Se a cadeia de caracteres não for encontrada, retorne o número -1.

Exemplo

Este exemplo localiza o valor de índice inicial para a última ocorrência da substring "world" na string "hello world":

lastIndexOf('hello world', 'world')

E devolve este resultado: 6

length

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

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

Parâmetro	Necessário	Type	Description
<Coleção>	Sim	String ou matriz	A coleção com os itens a contar

Valor devolvido	Tipo	Description
<comprimento-ou-contagem>	Número inteiro	O número de itens na coleção

Exemplo

Estes exemplos contam o número de itens nessas coleções:

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

E devolva este resultado: 4

less

Verifique se o primeiro valor é menor que o segundo. Retorne true quando o primeiro valor for menor ou retorne false quando o primeiro valor for mais.

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

Parâmetro	Necessário	Type	Description
<valor>	Sim	Inteiro, Float ou String	O primeiro valor para verificar se é menor que o segundo valor
<compareTo>	Sim	Inteiro, Float ou String, respectivamente	O item de comparação

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorne true quando o primeiro valor for menor que o segundo. Retornar false quando o primeiro valor for igual ou maior que o segundo valor.

Exemplo

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

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

E devolva estes resultados:

Primeiro exemplo: true
Segundo exemplo: false

lessOrEquals

Verifique se o primeiro valor é menor ou igual ao segundo valor. Retorne true quando o primeiro valor for menor ou igual, ou retorne false quando o primeiro valor for mais.

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

Parâmetro	Necessário	Type	Description
<valor>	Sim	Inteiro, Float ou String	O primeiro valor para verificar se menor ou igual ao segundo valor
<compareTo>	Sim	Inteiro, Float ou String, respectivamente	O item de comparação

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retornar true quando o primeiro valor for menor ou igual ao segundo valor. Retorne false quando o primeiro valor for maior que o segundo.

Exemplo

Estes exemplos verificam se o primeiro valor é menor ou igual ao segundo valor.

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

E devolva estes resultados:

Primeiro exemplo: true
Segundo exemplo: false

max

Retornar o valor mais alto de uma lista ou matriz com números que são inclusivos em ambas as extremidades.

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

Parâmetro	Necessário	Type	Description
<número1>, <número2>, ...	Sim	Inteiro, Float ou ambos	O conjunto de números do qual você deseja o valor mais alto
[<número1>, <número2>, ...]	Sim	Array - Inteiro, Float ou ambos	A matriz de números a partir da qual você deseja o valor mais alto

Valor devolvido	Tipo	Description
<valor-máx>	Inteiro ou flutuador	O valor mais alto na matriz ou conjunto de números especificado

Exemplo

Estes 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 devolva este resultado: 3

min

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

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

Parâmetro	Necessário	Type	Description
<número1>, <número2>, ...	Sim	Inteiro, Float ou ambos	O conjunto de números do qual você deseja o menor valor
[<número1>, <número2>, ...]	Sim	Array - Inteiro, Float ou ambos	A matriz de números a partir da qual você deseja o menor valor

Valor devolvido	Tipo	Description
<valor-mínimo>	Inteiro ou flutuador	O valor mais baixo no conjunto especificado de números ou matriz especificada

Exemplo

Estes exemplos obtêm o menor valor no conjunto de números e na matriz:

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

E devolva este resultado: 1

mod

Retorne o restante da divisão de um número por outro. Para divisão inteira, consulte div().

mod(<dividend>, <divisor>)

Parâmetro	Necessário	Type	Description
<dividendos>	Sim	Inteiro ou flutuador	O número a dividir pelo divisor
<divisor>	Sim	Inteiro ou flutuador	O número que divide o dividendo. Um valor de divisor de zero causa um erro em tempo de execução.

Valor devolvido	Tipo	Description
<modulo-resultado>	Inteiro ou flutuador	O restante da divisão do primeiro número pelo segundo número

Exemplo

Este exemplo calcula o restante quando o primeiro número é dividido pelo segundo número:

mod(3, 2)

E devolve este resultado: 1

Mul

Devolva o produto multiplicando dois números.

mul(<multiplicand1>, <multiplicand2>)

Parâmetro	Necessário	Type	Description
<multiplicando1>	Sim	Inteiro ou flutuador	O número a multiplicar por multiplicand2
<multiplicando2>	Sim	Inteiro ou flutuador	O número que multiplica multiplicand1

Valor devolvido	Tipo	Description
<produto-resultado>	Inteiro ou flutuador	O produto da multiplicação do primeiro número pelo segundo número

Exemplo

Estes exemplos multiplicam o primeiro número pelo segundo número:

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

E devolva estes resultados:

Primeiro exemplo: 2
Segundo exemplo 3

not

Verifique se uma expressão é falsa. Retorne true quando a expressão for false, ou retorne false quando true.

not(<expression>)

Parâmetro	Necessário	Type	Description
<expressão>	Sim	Boolean	A expressão a verificar

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorne true quando a expressão for false. Retorne false quando a expressão for true.

Exemplo 1

Estes exemplos verificam se as expressões especificadas são falsas:

not(false)
not(true)

E devolva estes resultados:

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

Exemplo 2

Estes exemplos verificam se as expressões especificadas são falsas:

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

E devolva estes resultados:

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

ou

Verifique se pelo menos uma expressão é verdadeira. Retorne true quando pelo menos uma expressão for true ou retorne false quando ambas forem false.

or(<expression1>, <expression2>)

Parâmetro	Necessário	Type	Description
<expressão1>, <expressão2>	Sim	Boolean	As expressões a verificar

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorne true quando pelo menos uma expressão for verdadeira. Retorne false quando ambas as expressões forem falsas.

Exemplo 1

Estes exemplos verificam se pelo menos uma expressão é verdadeira:

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

E devolva estes resultados:

Primeiro exemplo: Pelo menos uma expressão é verdadeira, portanto, a função retorna true.
Segundo exemplo: Ambas as expressões são falsas, portanto, a função retorna false.

Exemplo 2

Estes exemplos verificam se pelo menos uma expressão é verdadeira:

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

E devolva estes resultados:

Primeiro exemplo: Pelo menos uma expressão é verdadeira, portanto, a função retorna true.
Segundo exemplo: Ambas as expressões são falsas, portanto, a função retorna false.

RAND

Retorna um inteiro aleatório de um intervalo especificado, que é inclusivo apenas na extremidade inicial.

rand(<minValue>, <maxValue>)

Parâmetro	Necessário	Type	Description
<minValor>	Sim	Número inteiro	O número inteiro mais baixo do intervalo
<maxValor>	Sim	Número inteiro	O inteiro que segue o número inteiro mais alto no intervalo que a função pode retornar

Valor devolvido	Tipo	Description
<resultado aleatório>	Número inteiro	O inteiro aleatório retornou do intervalo especificado. Observe que cada invocação de produzirá um resultado exclusivo, o que significa que o valor observado no monitoramento de saída pode não ser o mesmo em tempo de `rand()` execução real.

Exemplo

Este 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 resultado: 1, 2, 3, ou 4

range

Retornar uma matriz inteira que começa a partir de um inteiro especificado.

range(<startIndex>, <count>)

Parâmetro	Necessário	Type	Description
<startIndex>	Sim	Número inteiro	Um valor inteiro que inicia a matriz como o primeiro item
<count>	Sim	Número inteiro	O número de inteiros na matriz

Valor devolvido	Tipo	Description
[<intervalo-resultado>]	Matriz	A matriz com inteiros a partir do índice especificado

Exemplo

Este exemplo cria uma matriz inteira que começa a partir do índice especificado e tem o número especificado de inteiros:

range(1, 4)

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

replace

Substitua uma substring pela string especificada e retorne a string de resultado. Esta função diferencia maiúsculas de minúsculas.

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

Parâmetro	Necessário	Type	Descrição
<texto>	Sim	String	A cadeia de caracteres que tem a substring para substituir
<texto antigo>	Sim	String	A substring a ser substituída
<newTexto>	Sim	String	A cadeia de caracteres de substituição

Valor devolvido	Tipo	Description
<texto atualizado>	String	A cadeia de caracteres atualizada após a substituição da substring Se a substring não for encontrada, retorne a string original.

Exemplo

Este exemplo localiza a substring "old" em "the old string" e substitui "old" por "new":

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

E devolve este resultado: "the new string"

skip

Remova itens da frente de uma coleção e devolva todos os outros itens.

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

Parâmetro	Necessário	Type	Description
<Coleção>	Sim	Matriz	A coleção cujos itens você deseja remover
<count>	Sim	Número inteiro	Um número inteiro positivo para o número de itens a remover na frente

Valor devolvido	Tipo	Description
[<coleção> atualizada]	Matriz	A coleção atualizada depois de remover os itens especificados

Exemplo

Este exemplo remove um item, o número 0, da frente 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 um único caractere, mas há suporte para delimitadores de vários caracteres.

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

Parâmetro	Necessário	Type	Descrição
<texto>	Sim	String	A cadeia de caracteres a ser separada em substrings
<delimitador>	Sim	String	A cadeia de caracteres a ser usada como delimitador

Valor devolvido	Tipo	Description
[<substring1,substring2><>,...]	Matriz	Uma matriz que contém substrings da cadeia de caracteres original

Exemplo

Este exemplo retorna uma matriz contendo substrings da cadeia de caracteres "a_b_c" com base no delimitador "_":

split('a_b_c', '_')

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

inícioOfDay

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

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A 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 para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora especificado, mas começando na marca de zero hora para o dia

Exemplo

Este exemplo localiza o início do dia para este carimbo de data/hora:

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

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

iníciodehora

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

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A 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 para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora especificado, mas começando na marca de zero minuto para a hora

Exemplo

Este exemplo localiza o início da hora para este carimbo de data/hora:

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

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

iníciodemês

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

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A 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 para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora especificado, mas começando no primeiro dia do mês na marca de zero hora

Exemplo

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

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

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

começaCom

Verifique se uma cadeia de caracteres começa com uma subcadeia de caracteres específica. Retorne true quando a substring for encontrada ou retorne false quando não for encontrado. Esta função não diferencia maiúsculas de minúsculas.

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

Parâmetro	Necessário	Type	Descrição
<texto>	Sim	String	A cadeia de caracteres a ser verificada
<pesquisaTexto>	Sim	String	A cadeia de caracteres inicial para localizar

Valor devolvido	Tipo	Description
verdadeiro ou falso	Boolean	Retorne true quando a substring inicial for encontrada. Retornar false quando não encontrado.

Exemplo 1

Este exemplo verifica se a string "hello world" começa com a substring "hello":

startsWith('hello world', 'hello')

E devolve este resultado: true

Exemplo 2

Este exemplo verifica se a cadeia de caracteres "hello world" começa com a substring "greetings":

startsWith('hello world', 'greetings')

E devolve este resultado: false

string

Retorne a versão da cadeia de caracteres para um valor.

string(<value>)

Parâmetro	Necessário	Type	Description
<valor>	Sim	Qualquer	O valor a converter

Valor devolvido	Tipo	Description
<valor da cadeia de caracteres>	String	A versão da cadeia de caracteres para o valor especificado

Exemplo 1

Este exemplo cria a versão da cadeia de caracteres para esse número:

string(10)

E devolve este resultado: "10"

Exemplo 2

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

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

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

sub

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

sub(<minuend>, <subtrahend>)

Parâmetro	Necessário	Type	Description
<minuend>	Sim	Inteiro ou flutuador	O número do qual subtrair o subtrahend
<Subtrahend>	Sim	Inteiro ou flutuador	O número a subtrair do minuend

Valor devolvido	Tipo	Description
<Resultado>	Inteiro ou flutuador	O resultado da subtração do segundo número do primeiro número

Exemplo

Este exemplo subtrai o segundo número do primeiro número:

sub(10.3, .3)

E devolve este resultado: 10

substring

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

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

Parâmetro	Necessário	Type	Descrição
<texto>	Sim	String	A cadeia de caracteres cujos caracteres você deseja
<startIndex>	Sim	Número inteiro	Um número positivo igual ou superior a 0 que pretende utilizar como posição inicial ou valor de índice
<length>	Sim	Número inteiro	Um número positivo de caracteres que você deseja na substring

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

Exemplo

Este exemplo cria uma substring de cinco caracteres a partir da cadeia de caracteres especificada, começando a partir do valor de índice 6:

substring('hello world', 6, 5)

E devolve este resultado: "world"

subtrairFromTime

Subtraia várias unidades de tempo de um carimbo de data/hora. Consulte também getPastTime.

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

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres que contém o carimbo de data/hora
<interval>	Sim	Número inteiro	O número de unidades de tempo especificadas para subtrair
<timeUnit>	Sim	String	A unidade de tempo a utilizar 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 para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atualizado>	String	O carimbo de data/hora menos o número especificado de unidades de tempo

Exemplo 1

Este exemplo subtrai um dia deste carimbo de data/hora:

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

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

Exemplo 2

Este exemplo subtrai um dia deste carimbo de data/hora:

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

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

take

Devolver itens da frente de uma coleção.

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

Parâmetro	Necessário	Type	Description
<Coleção>	Sim	String ou matriz	A coleção cujos itens você deseja
<count>	Sim	Número inteiro	Um número inteiro positivo para o número de itens que você deseja da frente

Valor devolvido	Tipo	Description
<subconjunto> ou [<subconjunto>]	String ou Array, respectivamente	Uma cadeia de caracteres ou matriz que tem o número especificado de itens retirados da frente da coleção original

Exemplo

Estes exemplos obtêm o número especificado de itens da frente dessas coleções:

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

E devolva estes resultados:

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

carrapatos

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

ticks('<timestamp>')

Parâmetro	Necessário	Type	Description
<Carimbo de data/hora>	Sim	String	A cadeia de caracteres para um carimbo de data/hora

Valor devolvido	Tipo	Description
<número de ticks>	Número inteiro	O número de ticks que decorreram desde as 12:00:00 meia-noite, 1 de janeiro de 0001 no calendário gregoriano desde o carimbo de data/hora de entrada

paraMais baixo

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

toLower('<text>')

Parâmetro	Necessário	Type	Descrição
<texto>	Sim	String	A cadeia de caracteres a ser retornada em formato minúsculo

Valor devolvido	Tipo	Description
<texto minúsculo>	String	A cadeia de caracteres original em formato minúsculo

Exemplo

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

toLower('Hello World')

E devolve este resultado: "hello world"

toUpper

Retornar uma cadeia de caracteres em formato maiúsculo. 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	Necessário	Type	Descrição
<texto>	Sim	String	A cadeia de caracteres a ser retornada em formato maiúsculo

Valor devolvido	Tipo	Description
<texto em maiúsculas>	String	A cadeia de caracteres original em formato maiúsculo

Exemplo

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

toUpper('Hello World')

E devolve este resultado: "HELLO WORLD"

guarnição

Remova o espaço em branco à esquerda e à direita de uma cadeia de caracteres e retorne a cadeia de caracteres atualizada.

trim('<text>')

Parâmetro	Necessário	Type	Descrição
<texto>	Sim	String	A cadeia de caracteres que tem o espaço em branco à esquerda e à direita para remover

Valor devolvido	Tipo	Description
<updatedText>	String	Uma versão atualizada para a 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 " Hello World ":

trim(' Hello World  ')

E devolve este resultado: "Hello World"

união

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

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

Parâmetro	Necessário	Type	Description
<coleção1>, <coleção2>, ...	Sim	Array ou Object, mas não ambos	As coleções de onde você deseja todos os itens

Valor devolvido	Tipo	Description
<updatedCollection>	Array ou Object, respectivamente	Uma coleção com todos os itens das coleções especificadas - sem duplicatas

Exemplo

Este exemplo obtém todos os itens dessas coleções:

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

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

uriComponent

Retorna uma versão codificada de URI (identificador de recurso uniforme) para uma cadeia de caracteres substituindo caracteres não seguros de URL por caracteres de escape. Use esta função em vez de encodeUriComponent(). Embora ambas as funções funcionem da mesma maneira, uriComponent() é preferível.

uriComponent('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres a ser convertida para o formato codificado por URI

Valor devolvido	Tipo	Description
<encoded-uri>	String	A cadeia de caracteres codificada por URI com caracteres de escape

Exemplo

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

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

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

uriComponentToBinary

Retornar a versão binária para um componente URI (identificador de recurso uniforme).

uriComponentToBinary('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres codificada por URI para converter

Valor devolvido	Tipo	Description
<binário-para-encoded-uri>	String	A versão binária para a cadeia de caracteres codificada por URI. O conteúdo binário é codificado em base64 e representado por `$content`.

Exemplo

Este exemplo cria a versão binária para essa cadeia de caracteres codificada por URI:

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

E devolve este resultado:

"001000100110100001110100011101000111000000100101001100 11010000010010010100110010010001100010010100110010010001 10011000110110111101101110011101000110111101110011011011 110010111001100011011011110110110100100010"

uriComponentToString

Retorne a versão da cadeia de caracteres para uma cadeia de caracteres codificada por URI (identificador de recurso uniforme), decodificando efetivamente a cadeia de caracteres codificada por URI.

uriComponentToString('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres codificada por URI para decodificar

Valor devolvido	Tipo	Description
<Decodificado-URI>	String	A versão decodificada para a cadeia de caracteres codificada por URI

Exemplo

Este exemplo cria a versão da cadeia de caracteres decodificada para essa cadeia de caracteres codificada por URI:

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

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

utcAgora

Retornar o carimbo de data/hora atual.

utcNow('<format>')

Opcionalmente, você pode especificar um formato diferente com o <parâmetro format>.

Parâmetro	Necessário	Type	Description
<format>	Não	String	Um especificador de formato único ou um padrão de formato personalizado. O formato padrão para o carimbo de data/hora é "o" (aaaa-MM-ddTHH:mm:ss.fffffffK), que está em conformidade com a ISO 8601 e preserva as informações de fuso horário.

Valor devolvido	Tipo	Description
<carimbo de data/hora atual>	String	A data e hora atuais

Exemplo 1

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

utcNow()

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

Exemplo 2

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

utcNow('D')

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

xml

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

xml('<value>')

Parâmetro	Necessário	Type	Description
<valor>	Sim	String	A cadeia de caracteres com o objeto JSON para converter 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 as aspas duplas (").

Valor devolvido	Tipo	Description
<xml-versão>	Object	O XML codificado para a cadeia de caracteres especificada ou objeto JSON

Exemplo 1

Este exemplo cria a versão XML para essa cadeia de caracteres, que contém um objeto JSON:

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

E retorna este resultado XML:

<name>Sophia Owen</name>

Exemplo 2

Suponha que você tenha este objeto JSON:

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

Este exemplo cria XML para uma cadeia de caracteres que contém esse objeto JSON:

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

E retorna este resultado XML:

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

XPath

Verifique se há nós ou valores que correspondam a uma expressão XPath (XML Path Language) e retorne os nós ou valores correspondentes. Uma expressão XPath, ou apenas "XPath", ajuda você a navegar por uma estrutura de documento XML para que você possa selecionar nós ou valores de computação no conteúdo XML.

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

Parâmetro	Necessário	Type	Description
<xml>	Sim	Qualquer	A cadeia de caracteres XML para procurar nós ou valores que correspondam a um valor de expressão XPath
<XPath>	Sim	Qualquer	A expressão XPath usada para localizar nós ou valores XML correspondentes

Valor devolvido	Tipo	Description
<nó xml>	XML	Um nó XML quando apenas um único nó corresponde à expressão XPath especificada
<valor>	Qualquer	O valor de um nó XML quando apenas um único valor corresponde à expressão XPath especificada
[<xml-node1>, <xml-node2>, ...] -ou- [<valor1>, <valor2>, ...]	Matriz	Uma matriz com nós XML ou valores que correspondem à expressão XPath especificada

Exemplo 1

Seguindo no Exemplo 1, este exemplo localiza nós que correspondem ao <count></count> nó e adiciona esses valores de nó com a sum() função:

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

E devolve este resultado: 30

Exemplo 2

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

Expressão 1

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

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

Eis os argumentos:

Este 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>

Expressão XPath aqui:
- /*[name()=\"file\"]/*[name()=\"location\"]
- /*[local-name()=\"file\" and namespace-uri()=\"http://contoso.com\"]/*[local-name()=\"location\"]

Aqui está o nó de resultado que corresponde ao <location></location> nó:

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

Exemplo 3

Seguindo no Exemplo 3, este exemplo localiza o <location></location> valor no nó:

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

E devolve este resultado: "Paris"

Nota

Pode-se adicionar comentários a expressões de fluxo de dados, mas não em expressões de pipeline.

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