QueueURL class

Paket:: @azure/storage-queue

Eine QueueURL stellt eine URL zur Azure Storage-Warteschlange dar.

Extends: StorageURL

Konstruktoren

Erstellt eine Instanz von QueueURL.

Eigenschaften

pipeline	Anforderungsrichtlinienpipeline.
url	URL-Zeichenfolgenwert.

Methoden

create(Aborter, IQueueCreateOptions)	Erstellt eine neue Warteschlange unter dem angegebenen Konto.
delete(Aborter)	Löscht die angegebene Warteschlange dauerhaft.
fromServiceURL(ServiceURL, string)	Erstellt ein QueueURL-Objekt aus ServiceURL
getAccessPolicy(Aborter)	Ruft Details zu allen in der Warteschlange angegebenen gespeicherten Zugriffsrichtlinien ab, die mit Freigegebenen Zugriffssignaturen verwendet werden können. WARNUNG: Das JavaScript-Datum kann beim Analysieren der Start- und Ablaufzeichenfolge eine potenzielle Genauigkeit verlieren. Beispiel: "New Date("2018-12-31T03:44:23.8827891Z"). toISOString() erhält beispielsweise "2018-12-31T03:44:23.882Z".
getProperties(Aborter)	Ruft alle benutzerdefinierten Metadaten und Systemeigenschaften für die angegebene Warteschlange ab. Metadaten werden der Warteschlange als Name-Werte-Paare zugeordnet.
newPipeline(Credential, INewPipelineOptions)	Eine statische Methode zum Erstellen eines neuen Pipelineobjekts mit bereitgestellten Anmeldeinformationen.
setAccessPolicy(Aborter, ISignedIdentifier[])	Legt gespeicherte Zugriffsrichtlinien für die Warteschlange fest, die mit Freigegebenen Zugriffssignaturen verwendet werden kann.
setMetadata(Aborter, IMetadata)	Legt ein oder mehrere benutzerdefinierte Namens-Wert-Paare für die angegebene Warteschlange fest. Wenn im Optionsparameter keine Option angegeben oder keine Metadaten definiert sind, werden die Warteschlangenmetadaten entfernt.
withPipeline(Pipeline)	Erstellt ein neues QueueURL -Objekt identisch mit der Quelle, aber mit der angegebenen Anforderungsrichtlinienpipeline.

Details zum Konstruktor

QueueURL(string, Pipeline)

Erstellt eine Instanz von QueueURL.

new QueueURL(url: string, pipeline: Pipeline)

Parameter

url: string

Eine URL-Zeichenfolge, die auf die Azure Storage-Warteschlange verweist, z. B. "https://myaccount.queue.core.windows.net/myqueue". Sie können eine SAS anfügen, wenn Anonyme Anmeldeinformationen verwendet werden, z. B. "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline: Pipeline

Rufen Sie StorageURL.newPipeline() auf, um eine Standardpipeline zu erstellen oder eine angepasste Pipeline bereitzustellen.

Details zur Eigenschaft

pipeline

Anforderungsrichtlinienpipeline.

pipeline: Pipeline

Eigenschaftswert

Pipeline

url

URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Details zur Methode

create(Aborter, IQueueCreateOptions)

Erstellt eine neue Warteschlange unter dem angegebenen Konto.

function create(aborter: Aborter, options?: IQueueCreateOptions)

Parameter

aborter: Aborter

Erstellen einer neuen Aborter-Instanz mit "Aborter.none" oder "Aborter.timeout(), goto documents of Aborter for more examples about request cancellation

options: IQueueCreateOptions

Gibt zurück

Promise<Models.QueueCreateResponse>

delete(Aborter)

Löscht die angegebene Warteschlange dauerhaft.

function delete(aborter: Aborter)

Parameter

aborter: Aborter

Erstellen einer neuen Aborter-Instanz mit "Aborter.none" oder "Aborter.timeout(), goto documents of Aborter for more examples about request cancellation

Gibt zurück

Promise<Models.QueueDeleteResponse>

fromServiceURL(ServiceURL, string)

Erstellt ein QueueURL-Objekt aus ServiceURL

static function fromServiceURL(serviceURL: ServiceURL, queueName: string)

Parameter

serviceURL: ServiceURL

queueName: string

Gibt zurück

QueueURL

getAccessPolicy(Aborter)

Ruft Details zu allen in der Warteschlange angegebenen gespeicherten Zugriffsrichtlinien ab, die mit Freigegebenen Zugriffssignaturen verwendet werden können. WARNUNG: Das JavaScript-Datum kann beim Analysieren der Start- und Ablaufzeichenfolge eine potenzielle Genauigkeit verlieren. Beispiel: "New Date("2018-12-31T03:44:23.8827891Z"). toISOString() erhält beispielsweise "2018-12-31T03:44:23.882Z".

function getAccessPolicy(aborter: Aborter)

Parameter

aborter: Aborter

Erstellen einer neuen Aborter-Instanz mit "Aborter.none" oder "Aborter.timeout(), goto documents of Aborter for more examples about request cancellation

Gibt zurück

Promise<QueueGetAccessPolicyResponse>

getProperties(Aborter)

Ruft alle benutzerdefinierten Metadaten und Systemeigenschaften für die angegebene Warteschlange ab. Metadaten werden der Warteschlange als Name-Werte-Paare zugeordnet.

function getProperties(aborter: Aborter)

Parameter

aborter: Aborter

Erstellen einer neuen Aborter-Instanz mit "Aborter.none" oder "Aborter.timeout(), goto documents of Aborter for more examples about request cancellation

Gibt zurück

Promise<Models.QueueGetPropertiesResponse>

newPipeline(Credential, INewPipelineOptions)

Eine statische Methode zum Erstellen eines neuen Pipelineobjekts mit bereitgestellten Anmeldeinformationen.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)

Parameter

credential: Credential

Wie anonyme Anmeldeinformationen, SharedKeyCredential oder TokenCredential.

pipelineOptions: INewPipelineOptions

Gibt zurück

Pipeline

Ein neues Pipelineobjekt.

setAccessPolicy(Aborter, ISignedIdentifier[])

Legt gespeicherte Zugriffsrichtlinien für die Warteschlange fest, die mit Freigegebenen Zugriffssignaturen verwendet werden kann.

function setAccessPolicy(aborter: Aborter, queueAcl?: ISignedIdentifier[])

Parameter

aborter: Aborter

Erstellen einer neuen Aborter-Instanz mit "Aborter.none" oder "Aborter.timeout(), goto documents of Aborter for more examples about request cancellation

queueAcl: ISignedIdentifier[]

Gibt zurück

Promise<Models.QueueSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

Legt ein oder mehrere benutzerdefinierte Namens-Wert-Paare für die angegebene Warteschlange fest. Wenn im Optionsparameter keine Option angegeben oder keine Metadaten definiert sind, werden die Warteschlangenmetadaten entfernt.

function setMetadata(aborter: Aborter, metadata?: IMetadata)

Parameter

aborter: Aborter

Erstellen einer neuen Aborter-Instanz mit "Aborter.none" oder "Aborter.timeout(), goto documents of Aborter for more examples about request cancellation

metadata: IMetadata

Gibt zurück

Promise<Models.QueueSetMetadataResponse>

withPipeline(Pipeline)

Erstellt ein neues QueueURL -Objekt identisch mit der Quelle, aber mit der angegebenen Anforderungsrichtlinienpipeline.

function withPipeline(pipeline: Pipeline)

Parameter

pipeline: Pipeline

Gibt zurück

QueueURL

Feedback

War diese Seite hilfreich?