CosmosDBv3TriggerOptions interface

Pacote:

@azure/functions

Propriedades

checkpointDocumentCount	Personaliza a quantidade de documentos entre os pontos de verificação de locação. O padrão é após cada chamada de função.
checkpointInterval	Quando definido, ele define, em milissegundos, o intervalo entre os pontos de verificação de locaçã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 locações. O padrão é false
databaseName	O nome do banco de dados do Azure Cosmos DB com a coleção sendo monitorada
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).
leaseCollectionName	O nome da coleção para armazenar locações. Se não estiver definido, usará "arrendamentos"
leaseCollectionPrefix	Quando definido, o valor é adicionado como um prefixo às concessões criadas na coleção Lease para esta função. O uso de um prefixo permite que duas Funções do Azure 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 com o serviço que contém a coleção de concessão. Se não estiver 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 é 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).
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
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.
useMultipleWriteLocations	Permite que contas de várias regiões gravem na coleção de locações.

Detalhes de Propriedade

checkpointDocumentCount

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

checkpointDocumentCount?: number

Valor de Propriedade

number

checkpointInterval

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

checkpointInterval?: number

Valor de Propriedade

number

collectionName

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

collectionName: string

Valor de Propriedade

string

connectionStringSetting

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

connectionStringSetting: string

Valor de Propriedade

string

createLeaseCollectionIfNotExists

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

createLeaseCollectionIfNotExists?: boolean

Valor de Propriedade

boolean

databaseName

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

databaseName: string

Valor de Propriedade

string

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

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

leaseCollectionName

O nome da coleção para armazenar locações. Se não estiver definido, usará "arrendamentos"

leaseCollectionName?: string

Valor de Propriedade

string

leaseCollectionPrefix

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

leaseCollectionPrefix?: string

Valor de Propriedade

string

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 de Propriedade

number

leaseConnectionStringSetting

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

leaseConnectionStringSetting?: string

Valor de Propriedade

string

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 de Propriedade

string

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

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

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

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

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

useMultipleWriteLocations

Permite que contas de várias regiões gravem na coleção de locações.

useMultipleWriteLocations?: boolean

Valor de Propriedade

boolean