CosmosDBv3FunctionOptions interface

Pacote:

@azure/functions

Extends

CosmosDBv3TriggerOptions,Partial<FunctionOptions>

Propriedades

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

Propriedades herdadas

checkpointDocumentCount	Personaliza a quantidade de documentos entre pontos de verificação de concessão. O padrão é após cada chamada de função.
checkpointInterval	Quando definido, ele define, em milissegundos, o intervalo entre pontos de verificação de concessão. O padrão é sempre após cada chamada de Função.
collectionName	O nome da coleção que está sendo monitorada
connectionStringSetting	Uma configuração de aplicativo (ou variável de ambiente) com a cadeia de conexão do Cosmos DB
createLeaseCollectionIfNotExists	Verifica a existência e cria automaticamente a coleção de concessões. O padrão é false
databaseName	O nome do banco de dados do Azure Cosmos DB com a coleção sendo monitorada
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 invocação, defina esses valores com context.extraOutputs.set()
feedPollDelay	O tempo (em milissegundos) para o atraso entre sondar uma partição para novas alterações no feed, depois que todas as alterações atuais forem drenadas. O padrão é cinco mil milissegundos (ou cinco segundos).
leaseAcquireInterval	Quando definido, ele define, em milissegundos, o intervalo para iniciar uma tarefa a ser computada se as partições forem distribuídas uniformemente entre instâncias de host conhecidas. O padrão é 13000 (13 segundos).
leaseCollectionName	O nome da coleção para armazenar concessões. Se não for definido, ele usará "concessões"
leaseCollectionPrefix	Quando definido, o valor é adicionado como um prefixo às concessões criadas na coleção Lease para essa função. O uso de um prefixo permite que duas Azure Functions separadas compartilhem a mesma coleção de concessão usando prefixos diferentes.
leaseCollectionThroughput	Quando createLeaseCollectionIfNotExists é definido como true, define a quantidade de Unidades de Solicitação a serem atribuídas à coleção de concessão criada
leaseConnectionStringSetting	O nome de uma configuração de aplicativo que contém a cadeia de conexão para o serviço que contém a coleção de concessão. Se não for definido, ele se conectará ao serviço definido por connectionStringSetting
leaseDatabaseName	O nome do banco de dados que contém a coleção 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 é realizada em uma concessão que representa uma partição. Se a concessão não for renovada dentro deste intervalo, ela será expirada 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).
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 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 do Azure Cosmos DB. Os valores devem ser separados por vírgulas. 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 retornado do manipulador de funções durante a invocação
startFromBeginning	Essa opção informa ao Gatilho para ler as alterações do início do histórico de alterações do contêiner em vez de começar no momento atual. Ler do começo funciona apenas na primeira vez em que gatilho inicia, pois nas execuções subsequentes os pontos de verificação já estão armazenados. Definir essa opção como true quando houver concessões já criadas não tem efeito.
useMultipleWriteLocations	Habilita contas de várias regiões para gravação na coleção de concessões.

Detalhes da propriedade

handler

handler: CosmosDBv3Handler

Valor da propriedade

CosmosDBv3Handler

retry

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

retry?: RetryOptions

Valor da propriedade

RetryOptions

trigger

trigger?: CosmosDBv3Trigger

Valor da propriedade

CosmosDBv3Trigger

Detalhes das propriedades herdadas

checkpointDocumentCount

Personaliza a quantidade de documentos entre pontos de verificação de concessão. O padrão é após cada chamada de função.

checkpointDocumentCount?: number

Valor da propriedade

number

Herdado deCosmosDBv3TriggerOptions.checkpointDocumentCount

checkpointInterval

Quando definido, ele define, em milissegundos, o intervalo entre pontos de verificação de concessão. O padrão é sempre após cada chamada de Função.

checkpointInterval?: number

Valor da propriedade

number

Herdado deCosmosDBv3TriggerOptions.checkpointInterval

collectionName

O nome da coleção que está sendo monitorada

collectionName: string

Valor da propriedade

string

Herdado deCosmosDBv3TriggerOptions.collectionName

connectionStringSetting

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

connectionStringSetting: string

Valor da propriedade

string

Herdado deCosmosDBv3TriggerOptions.connectionStringSetting

createLeaseCollectionIfNotExists

Verifica a existência e cria automaticamente a coleção de concessões. O padrão é false

createLeaseCollectionIfNotExists?: boolean

Valor da propriedade

boolean

Herdado deCosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

databaseName

O nome do banco de dados do Azure Cosmos DB com a coleção sendo monitorada

databaseName: string

Valor da propriedade

string

Herdado deCosmosDBv3TriggerOptions.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 da propriedade

FunctionInput[]

herdado de partial.extraInputs

extraOutputs

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

extraOutputs?: FunctionOutput[]

Valor da propriedade

FunctionOutput[]

herdado de partial.extraOutputs

feedPollDelay

O tempo (em milissegundos) para o atraso entre sondar uma partição para novas alterações no feed, depois que todas as alterações atuais forem drenadas. O padrão é cinco mil milissegundos (ou cinco segundos).

feedPollDelay?: number

Valor da propriedade

number

Herdado deCosmosDBv3TriggerOptions.feedPollDelay

leaseAcquireInterval

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

leaseAcquireInterval?: number

Valor da propriedade

number

Herdado deCosmosDBv3TriggerOptions.leaseAcquireInterval

leaseCollectionName

O nome da coleção para armazenar concessões. Se não for definido, ele usará "concessões"

leaseCollectionName?: string

Valor da propriedade

string

Herdado deCosmosDBv3TriggerOptions.leaseCollectionName

leaseCollectionPrefix

Quando definido, o valor é adicionado como um prefixo às concessões criadas na coleção Lease para essa função. O uso de um prefixo permite que duas Azure Functions separadas compartilhem a mesma coleção de concessão usando prefixos diferentes.

leaseCollectionPrefix?: string

Valor da propriedade

string

Herdado deCosmosDBv3TriggerOptions.leaseCollectionPrefix

leaseCollectionThroughput

Quando createLeaseCollectionIfNotExists é definido como true, define a quantidade de Unidades de Solicitação a serem atribuídas à coleção de concessão criada

leaseCollectionThroughput?: number

Valor da propriedade

number

Herdado deCosmosDBv3TriggerOptions.leaseCollectionThroughput

leaseConnectionStringSetting

O nome de uma configuração de aplicativo que contém a cadeia de conexão para o serviço que contém a coleção de concessão. Se não for definido, ele se conectará ao serviço definido por connectionStringSetting

leaseConnectionStringSetting?: string

Valor da propriedade

string

Herdado deCosmosDBv3TriggerOptions.leaseConnectionStringSetting

leaseDatabaseName

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

leaseDatabaseName?: string

Valor da propriedade

string

Herdado deCosmosDBv3TriggerOptions.leaseDatabaseName

leaseExpirationInterval

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

leaseExpirationInterval?: number

Valor da propriedade

number

Herdado deCosmosDBv3TriggerOptions.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 da propriedade

number

Herdado deCosmosDBv3TriggerOptions.leaseRenewInterval

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 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 da propriedade

number

Herdado deCosmosDBv3TriggerOptions.maxItemsPerInvocation

preferredLocations

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

preferredLocations?: string

Valor da propriedade

string

Herdado deCosmosDBv3TriggerOptions.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 retornado do manipulador de funções durante a invocação

return?: FunctionOutput

Valor da propriedade

FunctionOutput

Herdado de Partial.return

startFromBeginning

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

startFromBeginning?: boolean

Valor da propriedade

boolean

Herdado deCosmosDBv3TriggerOptions.startFromBeginning

useMultipleWriteLocations

Habilita contas de várias regiões para gravação na coleção de concessões.

useMultipleWriteLocations?: boolean

Valor da propriedade

boolean

Herdado deCosmosDBv3TriggerOptions.useMultipleWriteLocations