TableServiceClient class

Paket:

@azure/data-tables

Ein TableServiceClient stellt einen Client für den Azure Tables-Dienst dar, mit dem Sie Vorgänge für die Tabellen und Entitäten ausführen können.

Konstruktoren

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)	Erstellt eine neue Instanz der TableServiceClient-Klasse.
TableServiceClient(string, SASCredential, TableServiceClientOptions)	Erstellt eine neue Instanz der TableServiceClient-Klasse.
TableServiceClient(string, TableServiceClientOptions)	Erstellt eine neue Instanz der TableServiceClient-Klasse.
TableServiceClient(string, TokenCredential, TableServiceClientOptions)	Erstellt eine neue Instanz der TableServiceClient-Klasse.

Eigenschaften

pipeline	Stellt eine Pipeline zum Stellen einer HTTP-Anforderung an eine URL dar. Pipelines können über mehrere Richtlinien verfügen, um die Bearbeitung jeder Anforderung vor und nach ihrer Erstellung an den Server zu verwalten.
url	Tabellenkonto-URL

Methoden

createTable(string, OperationOptions)	Erstellt eine neue Tabelle unter dem angegebenen Konto.
deleteTable(string, OperationOptions)	Der Vorgang löscht die angegebene Tabelle endgültig.
fromConnectionString(string, TableServiceClientOptions)	Erstellt eine Instanz von TableServiceClient aus der Verbindungszeichenfolge.
getProperties(OperationOptions)	Ruft die Eigenschaften des Tabellendiensts eines Kontos ab, einschließlich Eigenschaften für Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).
getStatistics(OperationOptions)	Ruft Statistiken zur Replikation für den Tabellendienst ab. Sie ist nur auf dem sekundären Standortendpunkt verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Konto aktiviert ist.
listTables(ListTableItemsOptions)	Fragt Tabellen unter dem angegebenen Konto ab.
setProperties(ServiceProperties, SetPropertiesOptions)	Legt Eigenschaften für den Tabellendienstendpunkt eines Kontos fest, einschließlich Eigenschaften für Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).

Details zum Konstruktor

TableServiceClient(string, NamedKeyCredential, TableServiceClientOptions)

Erstellt eine neue Instanz der TableServiceClient-Klasse.

new TableServiceClient(url: string, credential: NamedKeyCredential, options?: TableServiceClientOptions)

Parameter

url

string

Die URL des Dienstkontos, das das Ziel des gewünschten Vorgangs ist, z. B. "https://myaccount.table.core.windows.net"".

credential

NamedKeyCredential

NamedKeyCredential | SASCredential, die zum Authentifizieren von Anforderungen verwendet werden. Nur für Knoten unterstützt

options

TableServiceClientOptions

Optionen zum Konfigurieren der HTTP-Pipeline.

Beispiel für die Verwendung eines Kontonamens/-schlüssels:

const { AzureNamedKeyCredential, TableServiceClient } = require("@azure/data-tables")
const account = "<storage account name>"
const sharedKeyCredential = new AzureNamedKeyCredential(account, "<account key>");

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  sharedKeyCredential
);

TableServiceClient(string, SASCredential, TableServiceClientOptions)

Erstellt eine neue Instanz der TableServiceClient-Klasse.

new TableServiceClient(url: string, credential: SASCredential, options?: TableServiceClientOptions)

Parameter

url

string

Die URL des Dienstkontos, das das Ziel des gewünschten Vorgangs ist, z. B. "https://myaccount.table.core.windows.net"".

credential

SASCredential

SASCredential, die zum Authentifizieren von Anforderungen verwendet werden

options

TableServiceClientOptions

Optionen zum Konfigurieren der HTTP-Pipeline.

Beispiel für die Verwendung eines SAS-Tokens.

const { AzureSASCredential, TableServiceClient } = require("@azure/data-tables")
const account = "<storage account name>"
const sasCredential = new AzureSASCredential(account, "<account key>");

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  sasCredential
);

TableServiceClient(string, TableServiceClientOptions)

Erstellt eine neue Instanz der TableServiceClient-Klasse.

new TableServiceClient(url: string, options?: TableServiceClientOptions)

Parameter

url

string

Die URL des Dienstkontos, das das Ziel des gewünschten Vorgangs ist, z. B. "https://myaccount.table.core.windows.net"". Sie können eine SAS wie "https://myaccount.table.core.windows.net?sasString"" anfügen.

options

TableServiceClientOptions

Optionen zum Konfigurieren der HTTP-Pipeline. Beispiel zum Anfügen eines SAS-Tokens:

const account = "<storage account name>";
const sasToken = "<SAS token>";

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net?${sasToken}`,
);

TableServiceClient(string, TokenCredential, TableServiceClientOptions)

Erstellt eine neue Instanz der TableServiceClient-Klasse.

new TableServiceClient(url: string, credential: TokenCredential, options?: TableServiceClientOptions)

Parameter

url

string

Die URL des Dienstkontos, das das Ziel des gewünschten Vorgangs ist, z. B. "https://myaccount.table.core.windows.net"".

credential

TokenCredential

Azure Active Directory-Anmeldeinformationen, die zum Authentifizieren von Anforderungen verwendet werden

options

TableServiceClientOptions

Optionen zum Konfigurieren der HTTP-Pipeline.

Beispiel für die Verwendung von Azure Active Directory-Anmeldeinformationen:

cons { DefaultAzureCredential } = require("@azure/identity");
const { TableServiceClient } = require("@azure/data-tables")
const account = "<storage account name>"
const credential = new DefaultAzureCredential();

const tableServiceClient = new TableServiceClient(
  `https://${account}.table.core.windows.net`,
  credential
);

Details zur Eigenschaft

pipeline

Stellt eine Pipeline zum Stellen einer HTTP-Anforderung an eine URL dar. Pipelines können über mehrere Richtlinien verfügen, um die Bearbeitung jeder Anforderung vor und nach ihrer Erstellung an den Server zu verwalten.

pipeline: Pipeline

Eigenschaftswert

Pipeline

url

Tabellenkonto-URL

url: string

Eigenschaftswert

string

Details zur Methode

createTable(string, OperationOptions)

Erstellt eine neue Tabelle unter dem angegebenen Konto.

function createTable(name: string, options?: OperationOptions): Promise<void>

Parameter

name

string

Der Name der Tabelle.

options

OperationOptions

Die Optionsparameter.

Gibt zurück

Promise<void>

deleteTable(string, OperationOptions)

Der Vorgang löscht die angegebene Tabelle endgültig.

function deleteTable(name: string, options?: OperationOptions): Promise<void>

Parameter

name

string

Der Name der Tabelle.

options

OperationOptions

Die Optionsparameter.

Gibt zurück

Promise<void>

fromConnectionString(string, TableServiceClientOptions)

Erstellt eine Instanz von TableServiceClient aus der Verbindungszeichenfolge.

static function fromConnectionString(connectionString: string, options?: TableServiceClientOptions): TableServiceClient

Parameter

connectionString

string

Kontoverbindungszeichenfolge oder SAS-Verbindungszeichenfolge eines Azure-Speicherkontos. [ Hinweis: Die Kontoverbindungszeichenfolge kann nur in NODE.JS Runtime verwendet werden. ] Beispiel für die Kontoverbindungszeichenfolge :DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net SAS-Verbindungszeichenfolgenbeispiel: BlobEndpoint=https://myaccount.table.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

TableServiceClientOptions

Optionen zum Konfigurieren der HTTP-Pipeline.

Gibt zurück

TableServiceClient

Ein neuer TableServiceClient aus der angegebenen Verbindungszeichenfolge.

getProperties(OperationOptions)

Ruft die Eigenschaften des Tabellendiensts eines Kontos ab, einschließlich Eigenschaften für Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).

function getProperties(options?: OperationOptions): Promise<GetPropertiesResponse>

Parameter

options

OperationOptions

Die Optionsparameter.

Gibt zurück

Promise<GetPropertiesResponse>

getStatistics(OperationOptions)

Ruft Statistiken zur Replikation für den Tabellendienst ab. Sie ist nur auf dem sekundären Standortendpunkt verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Konto aktiviert ist.

function getStatistics(options?: OperationOptions): Promise<GetStatisticsResponse>

Parameter

options

OperationOptions

Die Optionsparameter.

Gibt zurück

Promise<GetStatisticsResponse>

listTables(ListTableItemsOptions)

Fragt Tabellen unter dem angegebenen Konto ab.

function listTables(options?: ListTableItemsOptions): PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

Parameter

options

ListTableItemsOptions

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<TableItem, TableItemResultPage, PageSettings>

setProperties(ServiceProperties, SetPropertiesOptions)

Legt Eigenschaften für den Tabellendienstendpunkt eines Kontos fest, einschließlich Eigenschaften für Analytics- und CORS-Regeln (Cross-Origin Resource Sharing).

function setProperties(properties: ServiceProperties, options?: SetPropertiesOptions): Promise<ServiceSetPropertiesHeaders>

Parameter

properties

ServiceProperties

Die Table Service-Eigenschaften.

options

SetPropertiesOptions

Die Optionsparameter.

Gibt zurück

Promise<ServiceSetPropertiesHeaders>