QueueURL class

Pacchetto:: @azure/storage-queue

QueueURL rappresenta un URL della coda di Archiviazione di Azure.

Extends: StorageURL

Costruttori

Crea un'istanza di QueueURL.

Proprietà

pipeline	Pipeline dei criteri di richiesta.
url	Valore stringa URL.

Metodi

create(Aborter, IQueueCreateOptions)	Crea una nuova coda nell'account specificato.
delete(Aborter)	Elimina definitivamente la coda specificata.
fromServiceURL(ServiceURL, string)	Crea un oggetto QueueURL da ServiceURL
getAccessPolicy(Aborter)	Ottiene informazioni dettagliate sui criteri di accesso archiviati specificati nella coda che possono essere usati con firme di accesso condiviso. AVVISO: La data JavaScript potrebbe perdere precisione durante l'analisi della stringa di inizio e di scadenza. Ad esempio, new Date("2018-12-31T03:44:23.8827891Z").toISOString() otterrà "2018-12-31T03:44:23.882Z".
getProperties(Aborter)	Ottiene tutti i metadati e le proprietà di sistema definiti dall'utente per la coda specificata. I metadati sono associati alla coda come coppie nome-valore.
newPipeline(Credential, INewPipelineOptions)	Metodo statico usato per creare un nuovo oggetto Pipeline con credenziali fornite.
setAccessPolicy(Aborter, ISignedIdentifier[])	Imposta i criteri di accesso archiviati per la coda che può essere usata con firme di accesso condiviso.
setMetadata(Aborter, IMetadata)	Imposta una o più coppie nome-valore definite dall'utente per la coda specificata. Se non viene specificata alcuna opzione o nessun metadati definito nel parametro di opzione, i metadati della coda verranno rimossi.
withPipeline(Pipeline)	Crea un nuovo oggetto QueueURL identico all'origine, ma con la pipeline dei criteri di richiesta specificata.

Dettagli costruttore

QueueURL(string, Pipeline)

Crea un'istanza di QueueURL.

new QueueURL(url: string, pipeline: Pipeline)

Parametri

url: string

Stringa URL che punta alla coda di Archiviazione di Azure, ad esempio "https://myaccount.queue.core.windows.net/myqueue". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline: Pipeline

Chiamare StorageURL.newPipeline() per creare una pipeline predefinita o fornire una pipeline personalizzata.

Dettagli proprietà

pipeline

Pipeline dei criteri di richiesta.

pipeline: Pipeline

Valore della proprietà

Pipeline

url

Valore stringa URL.

url: string

Valore della proprietà

string

Dettagli metodo

create(Aborter, IQueueCreateOptions)

Crea una nuova coda nell'account specificato.

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

Parametri

aborter: Aborter

Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta

options: IQueueCreateOptions

Restituisce

Promise<Models.QueueCreateResponse>

delete(Aborter)

Elimina definitivamente la coda specificata.

function delete(aborter: Aborter)

Parametri

aborter: Aborter

Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta

Restituisce

Promise<Models.QueueDeleteResponse>

fromServiceURL(ServiceURL, string)

Crea un oggetto QueueURL da ServiceURL

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

Parametri

serviceURL: ServiceURL

queueName: string

Restituisce

QueueURL

getAccessPolicy(Aborter)

Ottiene informazioni dettagliate sui criteri di accesso archiviati specificati nella coda che possono essere usati con firme di accesso condiviso. AVVISO: La data JavaScript potrebbe perdere precisione durante l'analisi della stringa di inizio e di scadenza. Ad esempio, new Date("2018-12-31T03:44:23.8827891Z").toISOString() otterrà "2018-12-31T03:44:23.882Z".

function getAccessPolicy(aborter: Aborter)

Parametri

aborter: Aborter

Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta

Restituisce

Promise<QueueGetAccessPolicyResponse>

getProperties(Aborter)

Ottiene tutti i metadati e le proprietà di sistema definiti dall'utente per la coda specificata. I metadati sono associati alla coda come coppie nome-valore.

function getProperties(aborter: Aborter)

Parametri

aborter: Aborter

Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta

Restituisce

Promise<Models.QueueGetPropertiesResponse>

newPipeline(Credential, INewPipelineOptions)

Metodo statico usato per creare un nuovo oggetto Pipeline con credenziali fornite.

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

Parametri

credential: Credential

Ad esempio AnonymousCredential, SharedKeyCredential o TokenCredential.

pipelineOptions: INewPipelineOptions

Restituisce

Pipeline

Nuovo oggetto Pipeline.

setAccessPolicy(Aborter, ISignedIdentifier[])

Imposta i criteri di accesso archiviati per la coda che può essere usata con firme di accesso condiviso.

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

Parametri

aborter: Aborter

Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta

queueAcl: ISignedIdentifier[]

Restituisce

Promise<Models.QueueSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

Imposta una o più coppie nome-valore definite dall'utente per la coda specificata. Se non viene specificata alcuna opzione o nessun metadati definito nel parametro di opzione, i metadati della coda verranno rimossi.

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

Parametri

aborter: Aborter

Creare una nuova istanza di Aborter con Aborter.none o Aborter.timeout(), documenti goto di Aborter per altri esempi sull'annullamento della richiesta

metadata: IMetadata

Restituisce

Promise<Models.QueueSetMetadataResponse>

withPipeline(Pipeline)

Crea un nuovo oggetto QueueURL identico all'origine, ma con la pipeline dei criteri di richiesta specificata.

function withPipeline(pipeline: Pipeline)

Parametri

pipeline: Pipeline

Restituisce

QueueURL

Commenti e suggerimenti

Questa pagina è stata utile?