QueueURL class

Pakiet:: @azure/storage-queue

KolejkaURL reprezentuje adres URL kolejki usługi Azure Storage.

Rozszerzenie: StorageURL

Konstruktory

Tworzy wystąpienie elementu QueueURL.

Właściwości

pipeline	Żądanie potoku zasad.
url	Wartość ciągu adresu URL.

Metody

create(Aborter, IQueueCreateOptions)	Tworzy nową kolejkę w ramach określonego konta.
delete(Aborter)	Usuwa określoną kolejkę trwale.
fromServiceURL(ServiceURL, string)	Tworzy obiekt QueueURL z biblioteki ServiceURL
getAccessPolicy(Aborter)	Pobiera szczegółowe informacje o wszystkich przechowywanych zasadach dostępu określonych w kolejce, które mogą być używane z sygnaturami dostępu współdzielonego. OSTRZEŻENIE: Data języka JavaScript może utracić precyzję podczas analizowania ciągu rozpoczęcia i wygaśnięcia. Na przykład nowa data("2018-12-31T03:44:23.8827891Z").toISOString() otrzyma wartość "2018-12-31T03:44:23.882Z".
getProperties(Aborter)	Pobiera wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonej kolejki. Metadane są skojarzone z kolejką jako pary name-values.
newPipeline(Credential, INewPipelineOptions)	Metoda statyczna użyta do utworzenia nowego obiektu potoku z podanym poświadczenie.
setAccessPolicy(Aborter, ISignedIdentifier[])	Ustawia przechowywane zasady dostępu dla kolejki, które mogą być używane z sygnaturami dostępu współdzielonego.
setMetadata(Aborter, IMetadata)	Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonej kolejki. Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze opcji, metadane kolejki zostaną usunięte.
withPipeline(Pipeline)	Tworzy nowy obiekt QueueURL identyczny ze źródłem, ale z określonym potokiem zasad żądania.

Szczegóły konstruktora

QueueURL(string, Pipeline)

Tworzy wystąpienie elementu QueueURL.

new QueueURL(url: string, pipeline: Pipeline)

Parametry

url: string

Ciąg adresu URL wskazujący kolejkę usługi Azure Storage, na przykład "https://myaccount.queue.core.windows.net/myqueue". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline: Pipeline

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

Szczegóły właściwości

pipeline

Żądanie potoku zasad.

pipeline: Pipeline

Wartość właściwości

Pipeline

url

Wartość ciągu adresu URL.

url: string

Wartość właściwości

string

Szczegóły metody

create(Aborter, IQueueCreateOptions)

Tworzy nową kolejkę w ramach określonego konta.

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

Parametry

aborter: Aborter

Tworzenie nowego wystąpienia Aborter z elementem Aborter.none lub Aborter.timeout(), goto documents of Aborter (Goto documents of Aborter), aby uzyskać więcej przykładów na temat anulowania żądania

options: IQueueCreateOptions

Zwraca

Promise<Models.QueueCreateResponse>

delete(Aborter)

Usuwa określoną kolejkę trwale.

function delete(aborter: Aborter)

Parametry

aborter: Aborter

Zwraca

Promise<Models.QueueDeleteResponse>

fromServiceURL(ServiceURL, string)

Tworzy obiekt QueueURL z biblioteki ServiceURL

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

Parametry

serviceURL: ServiceURL

queueName: string

Zwraca

QueueURL

getAccessPolicy(Aborter)

Pobiera szczegółowe informacje o wszystkich przechowywanych zasadach dostępu określonych w kolejce, które mogą być używane z sygnaturami dostępu współdzielonego. OSTRZEŻENIE: Data języka JavaScript może utracić precyzję podczas analizowania ciągu rozpoczęcia i wygaśnięcia. Na przykład nowa data("2018-12-31T03:44:23.8827891Z").toISOString() otrzyma wartość "2018-12-31T03:44:23.882Z".

function getAccessPolicy(aborter: Aborter)

Parametry

aborter: Aborter

Zwraca

Promise<QueueGetAccessPolicyResponse>

getProperties(Aborter)

Pobiera wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonej kolejki. Metadane są skojarzone z kolejką jako pary name-values.

function getProperties(aborter: Aborter)

Parametry

aborter: Aborter

Zwraca

Promise<Models.QueueGetPropertiesResponse>

newPipeline(Credential, INewPipelineOptions)

Metoda statyczna użyta do utworzenia nowego obiektu potoku z podanym poświadczenie.

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

Parametry

credential: Credential

Na przykład AnonymousCredential, SharedKeyCredential lub TokenCredential.

pipelineOptions: INewPipelineOptions

Zwraca

Pipeline

Nowy obiekt Pipeline.

setAccessPolicy(Aborter, ISignedIdentifier[])

Ustawia przechowywane zasady dostępu dla kolejki, które mogą być używane z sygnaturami dostępu współdzielonego.

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

Parametry

aborter: Aborter

queueAcl: ISignedIdentifier[]

Zwraca

Promise<Models.QueueSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonej kolejki. Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze opcji, metadane kolejki zostaną usunięte.

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

Parametry

aborter: Aborter

metadata: IMetadata

Zwraca

Promise<Models.QueueSetMetadataResponse>

withPipeline(Pipeline)

Tworzy nowy obiekt QueueURL identyczny ze źródłem, ale z określonym potokiem zasad żądania.

function withPipeline(pipeline: Pipeline)

Parametry

pipeline: Pipeline

Zwraca

QueueURL

Opinia

Czy ta strona była pomocna?