BlobChangeFeedClient class

Referência

Pacote:: @azure/storage-blob-changefeed

BlobChangeFeedClient.

Consulte https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-change-feed?tabs=azure-portal

Construtores

BlobChangeFeedClient(string, Pipeline)	Cria uma instância de BlobChangeFeedClient.
BlobChangeFeedClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions, BlobChangeFeedClientOptions)	Cria uma instância de BlobChangeFeedClient.

Métodos

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Cria uma instância de BlobChangeFeedClient da cadeia de conexão.

listChanges(BlobChangeFeedListChangesOptions)

Retorna um iterador iterável assíncrono para listar todos os eventos do feed de alterações na conta especificada.

.byPage() retorna um iterador iterável assíncrono para listar os eventos do feed de alterações nas páginas.

Exemplo usando for await a sintaxe:

let i = 1;
for await (const event of blobChangeFeedClient.listChanges()) {
  console.log(`Event ${i++}, type: ${event.eventType}`);
}

Exemplo usando iter.next():

let i = 1;
const iter = blobChangeFeedClient.listChanges();
let eventItem = await iter.next();
while (!eventItem.done) {
  console.log(`Event ${i++}, type: ${eventItem.eventType}`);
  eventItem = await iter.next();
}

Exemplo usando byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const eventPage of blobChangeFeedClient.listChanges().byPage({ maxPageSize: 20 })) {
  if (eventPage.events) {
    for (const event of eventPage.events) {
      console.log(`Event ${i++}, type: ${event.eventType}`);
    }
  }
}

Exemplo usando paginação com um marcador:

let i = 1;
let iterator = blobChangeFeedClient.listChanges().byPage({ maxPageSize: 2 });
let eventPage = (await iterator.next()).value;

if (eventPage.events) {
  for (const container of eventPage.events) {
    console.log(`Event ${i++}, type: ${event.eventType}`);
  }
}

// Gets next marker
let marker = eventPage.continuationToken;
// Passing next marker as continuationToken
iterator = blobChangeFeedClient
  .listChanges()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
eventPage = (await iterator.next()).value;

if (eventPage.events) {
  for (const container of eventPage.events) {
     console.log(`Event ${i++}, type: ${event.eventType}`);
  }
}

Detalhes do construtor

BlobChangeFeedClient(string, Pipeline)

Cria uma instância de BlobChangeFeedClient.

new BlobChangeFeedClient(url: string, pipeline: Pipeline)

Parâmetros

url: string

Uma cadeia de caracteres do cliente apontando para o serviço de blob do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net?sasString".

pipeline: Pipeline

Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.

BlobChangeFeedClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions, BlobChangeFeedClientOptions)

Cria uma instância de BlobChangeFeedClient.

new BlobChangeFeedClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions, changeFeedClientOptions?: BlobChangeFeedClientOptions)

Parâmetros

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

options: StoragePipelineOptions

Opcional. Opções para configurar o pipeline HTTP.

Exemplo usando DefaultAzureCredential de @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

const blobChangeFeedClient = new BlobChangeFeedClient(
  `https://${account}.blob.core.windows.net`,
  defaultAzureCredential
);

Exemplo usando um nome/chave de conta:

const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");

const blobChangeFeedClient = new BlobChangeFeedClient(
  `https://${account}.blob.core.windows.net`,
  sharedKeyCredential
);

changeFeedClientOptions: BlobChangeFeedClientOptions

Detalhes do método

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Cria uma instância de BlobChangeFeedClient da cadeia de conexão.

static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions, changeFeedClientOptions?: BlobChangeFeedClientOptions): BlobChangeFeedClient

Parâmetros

connectionString: string

Cadeia de conexão de conta ou uma cadeia de conexão SAS de uma conta de armazenamento do Azure. [ Observação - A cadeia de conexão da conta só pode ser usada em NODE.JS runtime. ] Exemplo de cadeia de conexão de conta –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemplo de cadeia de conexão SAS – BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

options: StoragePipelineOptions

Opcional. Opções para configurar o pipeline HTTP.

changeFeedClientOptions: BlobChangeFeedClientOptions

Retornos

BlobChangeFeedClient

listChanges(BlobChangeFeedListChangesOptions)

Retorna um iterador iterável assíncrono para listar todos os eventos do feed de alterações na conta especificada.

.byPage() retorna um iterador iterável assíncrono para listar os eventos do feed de alterações nas páginas.

Exemplo usando for await a sintaxe:

let i = 1;
for await (const event of blobChangeFeedClient.listChanges()) {
  console.log(`Event ${i++}, type: ${event.eventType}`);
}

Exemplo usando iter.next():

let i = 1;
const iter = blobChangeFeedClient.listChanges();
let eventItem = await iter.next();
while (!eventItem.done) {
  console.log(`Event ${i++}, type: ${eventItem.eventType}`);
  eventItem = await iter.next();
}

Exemplo usando byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const eventPage of blobChangeFeedClient.listChanges().byPage({ maxPageSize: 20 })) {
  if (eventPage.events) {
    for (const event of eventPage.events) {
      console.log(`Event ${i++}, type: ${event.eventType}`);
    }
  }
}

Exemplo usando paginação com um marcador:

let i = 1;
let iterator = blobChangeFeedClient.listChanges().byPage({ maxPageSize: 2 });
let eventPage = (await iterator.next()).value;

if (eventPage.events) {
  for (const container of eventPage.events) {
    console.log(`Event ${i++}, type: ${event.eventType}`);
  }
}

// Gets next marker
let marker = eventPage.continuationToken;
// Passing next marker as continuationToken
iterator = blobChangeFeedClient
  .listChanges()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
eventPage = (await iterator.next()).value;

if (eventPage.events) {
  for (const container of eventPage.events) {
     console.log(`Event ${i++}, type: ${event.eventType}`);
  }
}

function listChanges(options?: BlobChangeFeedListChangesOptions): PagedAsyncIterableIterator<BlobChangeFeedEvent, BlobChangeFeedEventPage, PageSettings>

Parâmetros

options: BlobChangeFeedListChangesOptions

Opções para listar eventos do feed de alterações.

Retornos

PagedAsyncIterableIterator<BlobChangeFeedEvent, BlobChangeFeedEventPage, PageSettings>

Um asyncIterableIterator que dá suporte à paginação.

Compartilhar via

BlobChangeFeedClient class

Construtores

Métodos

Detalhes do construtor

BlobChangeFeedClient(string, Pipeline)

Parâmetros

BlobChangeFeedClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions, BlobChangeFeedClientOptions)

Parâmetros

Detalhes do método

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Parâmetros

Retornos

listChanges(BlobChangeFeedListChangesOptions)

Parâmetros

Retornos

Recursos adicionais