BlobChangeFeedClient class

Odwołanie

Pakiet:: @azure/storage-blob-changefeed

BlobChangeFeedClient.

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

Konstruktory

BlobChangeFeedClient(string, Pipeline)	Tworzy wystąpienie obiektu BlobChangeFeedClient.
BlobChangeFeedClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions, BlobChangeFeedClientOptions)	Tworzy wystąpienie obiektu BlobChangeFeedClient.

Metody

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Tworzy wystąpienie obiektu BlobChangeFeedClient na podstawie parametrów połączenia.

listChanges(BlobChangeFeedListChangesOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich zdarzeń zestawienia zmian na określonym koncie.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę zdarzeń zestawienia zmian na stronach.

Przykład użycia for await składni:

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

Przykład użycia polecenia 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();
}

Przykład użycia polecenia 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}`);
    }
  }
}

Przykład użycia stronicowania ze znacznikiem:

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

Szczegóły konstruktora

BlobChangeFeedClient(string, Pipeline)

Tworzy wystąpienie obiektu BlobChangeFeedClient.

new BlobChangeFeedClient(url: string, pipeline: Pipeline)

Parametry

url: string

Ciąg klienta wskazujący usługę obiektów blob usługi Azure Storage, taką jak "https://myaccount.blob.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz elementu AnonymousCredential, takiego jak "https://myaccount.blob.core.windows.net?sasString".

pipeline: Pipeline

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok, lub podaj dostosowany potok.

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

Tworzy wystąpienie obiektu BlobChangeFeedClient.

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

Parametry

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w @azure/identity celu uwierzytelnienia żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

options: StoragePipelineOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

Przykład użycia elementu DefaultAzureCredential z elementu @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

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

Przykład użycia nazwy/klucza konta:

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

Szczegóły metody

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Tworzy wystąpienie obiektu BlobChangeFeedClient na podstawie parametrów połączenia.

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

Parametry

connectionString: string

Parametry połączenia konta lub parametry połączenia sygnatury dostępu współdzielonego konta usługi Azure Storage. [ Uwaga — parametry połączenia konta mogą być używane tylko w środowisku uruchomieniowym NODE.JS. ] Przykład parametrów połączenia konta —DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Przykład parametrów połączenia sygnatury dostępu współdzielonego — 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

Opcjonalny. Opcje konfigurowania potoku HTTP.

changeFeedClientOptions: BlobChangeFeedClientOptions

Zwraca

BlobChangeFeedClient

listChanges(BlobChangeFeedListChangesOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich zdarzeń zestawienia zmian na określonym koncie.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę zdarzeń zestawienia zmian na stronach.

Przykład użycia for await składni:

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

Przykład użycia polecenia 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();
}

Przykład użycia polecenia 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}`);
    }
  }
}

Przykład użycia stronicowania ze znacznikiem:

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>

Parametry

options: BlobChangeFeedListChangesOptions

Opcje wyświetlania listy zdarzeń zestawienia zmian.

Zwraca

PagedAsyncIterableIterator<BlobChangeFeedEvent, BlobChangeFeedEventPage, PageSettings>

AsyncIterableIterator, który obsługuje stronicowanie.

Udostępnij za pośrednictwem

BlobChangeFeedClient class

Konstruktory

Metody

Szczegóły konstruktora

BlobChangeFeedClient(string, Pipeline)

Parametry

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

Parametry

Szczegóły metody

fromConnectionString(string, StoragePipelineOptions, BlobChangeFeedClientOptions)

Parametry

Zwraca

listChanges(BlobChangeFeedListChangesOptions)

Parametry

Zwraca

Dodatkowe zasoby