BlobChangeFeedClient class

Pakket:

@azure/storage-blob-changefeed

BlobChangeFeedClient.

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

Constructors

BlobChangeFeedClient(string, Pipeline)	Hiermee maakt u een exemplaar van BlobChangeFeedClient.
BlobChangeFeedClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions, BlobChangeFeedClientOptions)	Hiermee maakt u een exemplaar van BlobChangeFeedClient.

Methoden

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Hiermee maakt u een exemplaar van BlobChangeFeedClient op basis van de verbindingsreeks.

listChanges(BlobChangeFeedListChangesOptions)

Retourneert een asynchrone iterator om alle wijzigingenfeed-gebeurtenissen in het opgegeven account weer te geven. .byPage() retourneert een asynchrone iterator om de wijzigingenfeed-gebeurtenissen in pagina's weer te geven. Voorbeeld van for await syntaxis: let i = 1; for await (const event of blobChangeFeedClient.listChanges()) { console.log(`Event ${i++}, type: ${event.eventType}`); } Voorbeeld van 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(); } Voorbeeld van 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}`); } } } Voorbeeld van het gebruik van paging met een markering: 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}`); } }

Constructordetails

BlobChangeFeedClient(string, Pipeline)

Hiermee maakt u een exemplaar van BlobChangeFeedClient.

new BlobChangeFeedClient(url: string, pipeline: Pipeline)

Parameters

url

string

Een clienttekenreeks die verwijst naar de Azure Storage-blobservice, zoals 'https://myaccount.blob.core.windows.net". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net?sasString".

pipeline

Pipeline

Roep newPipeline() aan om een standaardpijplijn te maken of geef een aangepaste pijplijn op.

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

Hiermee maakt u een exemplaar van BlobChangeFeedClient.

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

Parameters

url

string

Een clienttekenreeks die verwijst naar de Azure Storage-blobservice, zoals 'https://myaccount.blob.core.windows.net". U kunt een SAS toevoegen als u AnonymousCredential gebruikt, zoals 'https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Zoals AnonymousCredential, StorageSharedKeyCredential of referenties van het @azure/identity-pakket om aanvragen voor de service te verifiëren. U kunt ook een object opgeven waarmee de TokenCredential-interface wordt geïmplementeerd. Als dit niet is opgegeven, wordt AnonymousCredential gebruikt.

options

StoragePipelineOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

Voorbeeld van het gebruik van DefaultAzureCredential uit @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

Voorbeeld van een accountnaam/-sleutel:

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

Methodedetails

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Hiermee maakt u een exemplaar van BlobChangeFeedClient op basis van de verbindingsreeks.

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

Parameters

connectionString

string

Verbindingsreeks voor het account of een SAS-verbindingsreeks van een Azure-opslagaccount. [ Opmerking: de verbindingsreeks van het account kan alleen worden gebruikt in NODE.JS runtime. ] Voorbeeld van accountverbindingsreeks - voorbeeld van DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-verbindingsreeks - 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

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

changeFeedClientOptions

BlobChangeFeedClientOptions

Retouren

BlobChangeFeedClient

listChanges(BlobChangeFeedListChangesOptions)

Retourneert een asynchrone iterator om alle wijzigingenfeed-gebeurtenissen in het opgegeven account weer te geven.

.byPage() retourneert een asynchrone iterator om de wijzigingenfeed-gebeurtenissen in pagina's weer te geven.

Voorbeeld van for await syntaxis:

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

Voorbeeld van 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();
}

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

Voorbeeld van het gebruik van paging met een markering:

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>

Parameters

options

BlobChangeFeedListChangesOptions

Opties om wijzigingsfeedgebeurtenissen weer te geven.

Retouren

PagedAsyncIterableIterator<BlobChangeFeedEvent, BlobChangeFeedEventPage, PageSettings>

Een asyncIterableIterator die paging ondersteunt.