CosmosDBv4FunctionOptions interface

Pacote:

@azure/functions

Extends

CosmosDBv4TriggerOptions,Partial<FunctionOptions>

Propriedades

handler
retry	Uma política de repetição opcional para executar novamente uma execução com falha até que a conclusão bem-sucedida ocorra ou o número máximo de novas tentativas seja atingido. Saiba mais aqui
trigger

Propriedades Herdadas

connection	Uma configuração de aplicativo (ou variável de ambiente) com a cadeia de conexão do Cosmos DB
containerName	O nome do contêiner que está sendo monitorado
createLeaseContainerIfNotExists	Verifica a existência e cria automaticamente o contêiner de concessão. O padrão é false
databaseName	O nome do banco de dados do Azure Cosmos DB com o contêiner sendo monitorado
extraInputs	Configuração para um conjunto opcional de entradas secundárias Durante a invocação, obtenha esses valores com context.extraInputs.get()
extraOutputs	Configuração para um conjunto opcional de saídas secundárias Durante a chamada, defina esses valores com context.extraOutputs.set()
feedPollDelay	O tempo (em milissegundos) para o atraso entre a sondagem de uma partição para novas alterações no feed, depois que todas as alterações atuais são drenadas. O padrão é 5.000 milissegundos ou 5 segundos.
leaseAcquireInterval	Quando definido, ele define, em milissegundos, o intervalo para iniciar uma tarefa para calcular se as partições são distribuídas uniformemente entre instâncias de host conhecidas. O padrão é 13000 (13 segundos).
leaseConnection	O nome de uma configuração de aplicativo que contém a cadeia de conexão com o serviço que contém o contêiner de concessão. Se não estiver definido, ele se conectará ao serviço definido por connection
leaseContainerName	O nome do contêiner para armazenar locações. Se não estiver definido, usará "arrendamentos"
leaseContainerPrefix	Quando definido, o valor é adicionado como um prefixo às concessões criadas no contêiner Lease para essa função. O uso de um prefixo permite que duas Funções do Azure separadas compartilhem o mesmo contêiner de Concessão usando prefixos diferentes.
leaseDatabaseName	O nome do banco de dados que contém o contêiner para armazenar concessões . Se não estiver definido, ele usará o valor de databaseName
leaseExpirationInterval	Quando definido, ele define, em milissegundos, o intervalo para o qual a concessão é tomada em uma concessão que representa uma partição. Se a concessão não for renovada dentro desse intervalo, ela expirará e a propriedade da partição será movida para outra instância. O padrão é 60000 (60 segundos).
leaseRenewInterval	Quando definido, ele define, em milissegundos, o intervalo de renovação para todas as concessões de partições atualmente mantidas por uma instância. O padrão é 17000 (17 segundos).
leasesContainerThroughput	Quando createLeaseContainerIfNotExists é definido como true, define a quantidade de Unidades de Solicitação a serem atribuídas ao contêiner de concessão criado
maxItemsPerInvocation	Quando definida, essa propriedade define o número máximo de itens recebidos por chamada de função. Se as operações no contêiner monitorado forem executadas por meio de procedimentos armazenados, o escopo da transação será preservado ao ler itens do feed de alterações. Como resultado, o número de itens recebidos pode ser maior do que o valor especificado para que os itens alterados pela mesma transação sejam retornados como parte de um lote atômico.
preferredLocations	Define locais preferenciais (regiões) para contas de banco de dados replicadas geograficamente no serviço Azure Cosmos DB. Os valores devem ser separados por vírgula. Por exemplo, Leste dos EUA, Centro-Sul dos EUA, Norte da Europa
return	Configuração para a saída primária opcional da função Esta é a saída principal que você deve definir como o valor de retorno do manipulador de função durante a invocação
startFromBeginning	Essa opção informa ao Gatilho para ler as alterações desde o início do histórico de alterações do contêiner em vez de começar no momento atual. A leitura desde o início só funciona na primeira vez que o gatilho é iniciado, pois nas execuções subsequentes, os pontos de verificação já estão armazenados. Definir essa opção como true quando há concessões já criadas não tem efeito.
startFromTime	Obtém ou define a data e a hora a partir das quais inicializar a operação de leitura do feed de alterações. O formato recomendado é ISO 8601 com o designador UTC, como 2021-02-16T14:19:29Z. Isso é usado apenas para definir o estado inicial do gatilho. Depois que o gatilho tiver um estado de concessão, alterar esse valor não terá efeito.

Detalhes de Propriedade

handler

handler: CosmosDBv4Handler

Valor de Propriedade

CosmosDBv4Handler

retry

Uma política de repetição opcional para executar novamente uma execução com falha até que a conclusão bem-sucedida ocorra ou o número máximo de novas tentativas seja atingido. Saiba mais aqui

retry?: RetryOptions

Valor de Propriedade

RetryOptions

trigger

trigger?: CosmosDBv4Trigger

Valor de Propriedade

CosmosDBv4Trigger

Detalhes da Propriedade Herdada

connection

Uma configuração de aplicativo (ou variável de ambiente) com a cadeia de conexão do Cosmos DB

connection: string

Valor de Propriedade

string

herdado de CosmosDBv4TriggerOptions.connection

containerName

O nome do contêiner que está sendo monitorado

containerName: string

Valor de Propriedade

string

herdado de CosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

Verifica a existência e cria automaticamente o contêiner de concessão. O padrão é false

createLeaseContainerIfNotExists?: boolean

Valor de Propriedade

boolean

herdado doCosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

O nome do banco de dados do Azure Cosmos DB com o contêiner sendo monitorado

databaseName: string

Valor de Propriedade

string

herdado de CosmosDBv4TriggerOptions.databaseName

extraInputs

Configuração para um conjunto opcional de entradas secundárias Durante a invocação, obtenha esses valores com context.extraInputs.get()

extraInputs?: FunctionInput[]

Valor de Propriedade

FunctionInput[]

herdado de Partial.extraInputs

extraOutputs

Configuração para um conjunto opcional de saídas secundárias Durante a chamada, defina esses valores com context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Valor de Propriedade

FunctionOutput[]

herdado de Partial.extraOutputs

feedPollDelay

O tempo (em milissegundos) para o atraso entre a sondagem de uma partição para novas alterações no feed, depois que todas as alterações atuais são drenadas. O padrão é 5.000 milissegundos ou 5 segundos.

feedPollDelay?: number

Valor de Propriedade

number

herdado de CosmosDBv4TriggerOptions.feedPollDelay

leaseAcquireInterval

Quando definido, ele define, em milissegundos, o intervalo para iniciar uma tarefa para calcular se as partições são distribuídas uniformemente entre instâncias de host conhecidas. O padrão é 13000 (13 segundos).

leaseAcquireInterval?: number

Valor de Propriedade

number

herdado de CosmosDBv4TriggerOptions.leaseAcquireInterval

leaseConnection

O nome de uma configuração de aplicativo que contém a cadeia de conexão com o serviço que contém o contêiner de concessão. Se não estiver definido, ele se conectará ao serviço definido por connection

leaseConnection?: string

Valor de Propriedade

string

herdado de CosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

O nome do contêiner para armazenar locações. Se não estiver definido, usará "arrendamentos"

leaseContainerName?: string

Valor de Propriedade

string

herdado de CosmosDBv4TriggerOptions.leaseContainerName

leaseContainerPrefix

Quando definido, o valor é adicionado como um prefixo às concessões criadas no contêiner Lease para essa função. O uso de um prefixo permite que duas Funções do Azure separadas compartilhem o mesmo contêiner de Concessão usando prefixos diferentes.

leaseContainerPrefix?: string

Valor de Propriedade

string

herdado de CosmosDBv4TriggerOptions.leaseContainerPrefix

leaseDatabaseName

O nome do banco de dados que contém o contêiner para armazenar concessões . Se não estiver definido, ele usará o valor de databaseName

leaseDatabaseName?: string

Valor de Propriedade

string

herdado de CosmosDBv4TriggerOptions.leaseDatabaseName

leaseExpirationInterval

Quando definido, ele define, em milissegundos, o intervalo para o qual a concessão é tomada em uma concessão que representa uma partição. Se a concessão não for renovada dentro desse intervalo, ela expirará e a propriedade da partição será movida para outra instância. O padrão é 60000 (60 segundos).

leaseExpirationInterval?: number

Valor de Propriedade

number

herdado de CosmosDBv4TriggerOptions.leaseExpirationInterval

leaseRenewInterval

Quando definido, ele define, em milissegundos, o intervalo de renovação para todas as concessões de partições atualmente mantidas por uma instância. O padrão é 17000 (17 segundos).

leaseRenewInterval?: number

Valor de Propriedade

number

herdado de CosmosDBv4TriggerOptions.leaseRenewInterval

leasesContainerThroughput

Quando createLeaseContainerIfNotExists é definido como true, define a quantidade de Unidades de Solicitação a serem atribuídas ao contêiner de concessão criado

leasesContainerThroughput?: number

Valor de Propriedade

number

herdado de CosmosDBv4TriggerOptions.leasesContainerThroughput

maxItemsPerInvocation

Quando definida, essa propriedade define o número máximo de itens recebidos por chamada de função. Se as operações no contêiner monitorado forem executadas por meio de procedimentos armazenados, o escopo da transação será preservado ao ler itens do feed de alterações. Como resultado, o número de itens recebidos pode ser maior do que o valor especificado para que os itens alterados pela mesma transação sejam retornados como parte de um lote atômico.

maxItemsPerInvocation?: number

Valor de Propriedade

number

herdado de CosmosDBv4TriggerOptions.maxItemsPerInvocation

preferredLocations

Define locais preferenciais (regiões) para contas de banco de dados replicadas geograficamente no serviço Azure Cosmos DB. Os valores devem ser separados por vírgula. Por exemplo, Leste dos EUA, Centro-Sul dos EUA, Norte da Europa

preferredLocations?: string

Valor de Propriedade

string

herdado deCosmosDBv4TriggerOptions.preferredLocations

return

Configuração para a saída primária opcional da função Esta é a saída principal que você deve definir como o valor de retorno do manipulador de função durante a invocação

return?: FunctionOutput

Valor de Propriedade

FunctionOutput

herdado de Partial.return

startFromBeginning

Essa opção informa ao Gatilho para ler as alterações desde o início do histórico de alterações do contêiner em vez de começar no momento atual. A leitura desde o início só funciona na primeira vez que o gatilho é iniciado, pois nas execuções subsequentes, os pontos de verificação já estão armazenados. Definir essa opção como true quando há concessões já criadas não tem efeito.

startFromBeginning?: boolean

Valor de Propriedade

boolean

herdado doCosmosDBv4TriggerOptions.startFromBeginning

startFromTime

Obtém ou define a data e a hora a partir das quais inicializar a operação de leitura do feed de alterações. O formato recomendado é ISO 8601 com o designador UTC, como 2021-02-16T14:19:29Z. Isso é usado apenas para definir o estado inicial do gatilho. Depois que o gatilho tiver um estado de concessão, alterar esse valor não terá efeito.

startFromTime?: string

Valor de Propriedade

string

herdado deCosmosDBv4TriggerOptions.startFromTime