QueueURL class

Balíček:: @azure/storage-queue

FrontaURL představuje adresu URL fronty Azure Storage.

Extends: StorageURL

Konstruktory

Vytvoří instanci QueueURL.

Vlastnosti

pipeline	Kanál zásad žádosti
url	Hodnota řetězce adresy URL.

Metody

create(Aborter, IQueueCreateOptions)	Vytvoří novou frontu pod zadaným účtem.
delete(Aborter)	Odstraní zadanou frontu trvale.
fromServiceURL(ServiceURL, string)	Vytvoří objekt QueueURL ze služby ServiceURL.
getAccessPolicy(Aborter)	Získá podrobnosti o všech uložených zásadách přístupu zadaných ve frontě, které lze použít se sdílenými přístupovými podpisy. UPOZORNĚNÍ: Datum JavaScriptu může při analýze řetězce zahájení a konce platnosti dojít ke ztrátě přesnosti. Například nové datum("2018-12-31T03:44:23.8827891Z"). toISOString() získá "2018-12-31T03:44:23.882Z".
getProperties(Aborter)	Získá všechna uživatelsky definovaná metadata a systémové vlastnosti pro zadanou frontu. Metadata jsou přidružena k frontě jako páry name-values.
newPipeline(Credential, INewPipelineOptions)	Statická metoda používaná k vytvoření nového objektu kanálu s zadanými přihlašovacími údaji.
setAccessPolicy(Aborter, ISignedIdentifier[])	Nastaví uložené zásady přístupu pro frontu, kterou lze použít se sdílenými přístupovými podpisy.
setMetadata(Aborter, IMetadata)	Nastaví jeden nebo více uživatelsky definovaných párů name-value pro zadanou frontu. Pokud není k dispozici žádná možnost nebo v parametru možnosti nejsou definována žádná metadata, metadata fronty budou odebrána.
withPipeline(Pipeline)	Vytvoří nový objekt QueueURL shodný se zdrojem, ale se zadaným kanálem zásad požadavku.

Podrobnosti konstruktoru

QueueURL(string, Pipeline)

Vytvoří instanci QueueURL.

new QueueURL(url: string, pipeline: Pipeline)

Parametry

url: string

Řetězec adresy URL odkazující na frontu služby Azure Storage, například "https://myaccount.queue.core.windows.net/myqueue". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline: Pipeline

Voláním metody StorageURL.newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený kanál.

Podrobnosti vlastnosti

pipeline

Kanál zásad žádosti

pipeline: Pipeline

Hodnota vlastnosti

Pipeline

url

Hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

Podrobnosti metody

create(Aborter, IQueueCreateOptions)

Vytvoří novou frontu pod zadaným účtem.

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

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

options: IQueueCreateOptions

Návraty

Promise<Models.QueueCreateResponse>

delete(Aborter)

Odstraní zadanou frontu trvale.

function delete(aborter: Aborter)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

Návraty

Promise<Models.QueueDeleteResponse>

fromServiceURL(ServiceURL, string)

Vytvoří objekt QueueURL ze služby ServiceURL.

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

Parametry

serviceURL: ServiceURL

queueName: string

Návraty

QueueURL

getAccessPolicy(Aborter)

Získá podrobnosti o všech uložených zásadách přístupu zadaných ve frontě, které lze použít se sdílenými přístupovými podpisy. UPOZORNĚNÍ: Datum JavaScriptu může při analýze řetězce zahájení a konce platnosti dojít ke ztrátě přesnosti. Například nové datum("2018-12-31T03:44:23.8827891Z"). toISOString() získá "2018-12-31T03:44:23.882Z".

function getAccessPolicy(aborter: Aborter)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

Návraty

Promise<QueueGetAccessPolicyResponse>

getProperties(Aborter)

Získá všechna uživatelsky definovaná metadata a systémové vlastnosti pro zadanou frontu. Metadata jsou přidružena k frontě jako páry name-values.

function getProperties(aborter: Aborter)

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

Návraty

Promise<Models.QueueGetPropertiesResponse>

newPipeline(Credential, INewPipelineOptions)

Statická metoda používaná k vytvoření nového objektu kanálu s zadanými přihlašovacími údaji.

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

Parametry

credential: Credential

Například AnonymousCredential, SharedKeyCredential nebo TokenCredential.

pipelineOptions: INewPipelineOptions

Návraty

Pipeline

Nový objekt kanálu.

setAccessPolicy(Aborter, ISignedIdentifier[])

Nastaví uložené zásady přístupu pro frontu, kterou lze použít se sdílenými přístupovými podpisy.

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

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

queueAcl: ISignedIdentifier[]

Návraty

Promise<Models.QueueSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

Nastaví jeden nebo více uživatelsky definovaných párů name-value pro zadanou frontu. Pokud není k dispozici žádná možnost nebo v parametru možnosti nejsou definována žádná metadata, metadata fronty budou odebrána.

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

Parametry

aborter: Aborter

Vytvoření nové instance Aborter s Aborter.none nebo Aborter.timeout(), goto dokumenty Aborter pro další příklady o zrušení žádosti

metadata: IMetadata

Návraty

Promise<Models.QueueSetMetadataResponse>

withPipeline(Pipeline)

Vytvoří nový objekt QueueURL shodný se zdrojem, ale se zadaným kanálem zásad požadavku.

function withPipeline(pipeline: Pipeline)

Parametry

pipeline: Pipeline

Návraty

QueueURL

Váš názor

Byla tato stránka užitečná?