BlobChangeFeedClient class

Referens

Paket:: @azure/storage-blob-changefeed

BlobChangeFeedClient.

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

Konstruktorer

BlobChangeFeedClient(string, Pipeline)	Skapar en instans av BlobChangeFeedClient.
BlobChangeFeedClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions, BlobChangeFeedClientOptions)	Skapar en instans av BlobChangeFeedClient.

Metoder

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Skapar en instans av BlobChangeFeedClient från anslutningssträngen.

listChanges(BlobChangeFeedListChangesOptions)

Returnerar en asynkron iterbar iterator för att visa en lista över alla ändringsflödeshändelser i det angivna kontot.

.byPage() returnerar en asynkron itererbar iterator för att visa en lista över ändringsflödeshändelser på sidor.

Exempel med syntax for await :

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

Exempel med 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();
}

Exempel med 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}`);
    }
  }
}

Exempel med sidindelning med en markör:

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}`);
  }
}

Konstruktorinformation

BlobChangeFeedClient(string, Pipeline)

Skapar en instans av BlobChangeFeedClient.

new BlobChangeFeedClient(url: string, pipeline: Pipeline)

Parametrar

url: string

En klientsträng som pekar på Azure Storage-blobtjänsten, till exempel "https://myaccount.blob.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net?sasString".

pipeline: Pipeline

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

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

Skapar en instans av BlobChangeFeedClient.

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

Parametrar

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity begäranden till tjänsten. Du kan också ange ett -objekt som implementerar TokenCredential-gränssnittet. Om inget anges används AnonymousCredential.

options: StoragePipelineOptions

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

Exempel med DefaultAzureCredential från @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

Exempel med ett kontonamn/nyckel:

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

Metodinformation

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Skapar en instans av BlobChangeFeedClient från anslutningssträngen.

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

Parametrar

connectionString: string

Kontoanslutningssträng eller en SAS-anslutningssträng för ett Azure Storage-konto. [ Obs! – Kontoanslutningssträngen kan bara användas i NODE.JS körning. ] Exempel på kontoanslutningssträng –DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net EXEMPEL på SAS-anslutningssträng – 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

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

changeFeedClientOptions: BlobChangeFeedClientOptions

Returer

BlobChangeFeedClient

listChanges(BlobChangeFeedListChangesOptions)

Returnerar en asynkron iterbar iterator för att visa en lista över alla ändringsflödeshändelser i det angivna kontot.

.byPage() returnerar en asynkron itererbar iterator för att visa en lista över ändringsflödeshändelser på sidor.

Exempel med syntax for await :

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

Exempel med 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();
}

Exempel med 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}`);
    }
  }
}

Exempel med sidindelning med en markör:

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>

Parametrar

options: BlobChangeFeedListChangesOptions

Alternativ för att visa ändringsflödeshändelser.

Returer

PagedAsyncIterableIterator<BlobChangeFeedEvent, BlobChangeFeedEventPage, PageSettings>

En asyncIterableIterator som stöder sidindelning.

Dela via

BlobChangeFeedClient class

Konstruktorer

Metoder

Konstruktorinformation

BlobChangeFeedClient(string, Pipeline)

Parametrar

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

Parametrar

Metodinformation

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Parametrar

Returer

listChanges(BlobChangeFeedListChangesOptions)

Parametrar

Returer

Ytterligare resurser