QueueURL class

Um QueueURL representa uma URL para a fila de Armazenamento do Azure.

Extends

Construtores

QueueURL(string, Pipeline)

Cria uma instância de QueueURL.

Propriedades

pipeline

Pipeline de políticas de solicitação.

url

Valor da cadeia de caracteres de URL.

Métodos

create(Aborter, IQueueCreateOptions)

Cria uma nova fila na conta especificada.

delete(Aborter)

Exclui a fila especificada permanentemente.

fromServiceURL(ServiceURL, string)

Cria um objeto QueueURL a partir de ServiceURL

getAccessPolicy(Aborter)

Obtém detalhes sobre quaisquer políticas de acesso armazenado especificadas na fila que podem ser usadas com Assinaturas de Acesso Compartilhado. AVISO: JavaScript Date perderá a precisão ao analisar a cadeia de caracteres de início e expiração. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z".

getProperties(Aborter)

Obtém todos os metadados definidos pelo usuário e as propriedades do sistema para a fila especificada. Os metadados são associados à fila como pares nome-valores.

newPipeline(Credential, INewPipelineOptions)

Um método estático usado para criar um novo objeto Pipeline com Credential fornecido.

setAccessPolicy(Aborter, ISignedIdentifier[])

Define políticas de acesso armazenado para a fila que podem ser usadas com Assinaturas de Acesso Compartilhado.

setMetadata(Aborter, IMetadata)

Define um ou mais pares nome-valor definidos pelo usuário para a fila especificada. Se nenhuma opção for fornecida, ou nenhum metadados definido no parâmetro option, os metadados da fila serão removidos.

withPipeline(Pipeline)

Cria um novo objeto QueueURL idêntico à origem, mas com o pipeline de política de solicitação especificado.

Detalhes do Construtor

QueueURL(string, Pipeline)

Cria uma instância de QueueURL.

new QueueURL(url: string, pipeline: Pipeline)

Parâmetros

url

string

Uma cadeia de caracteres de URL apontando para a fila de Armazenamento do Azure, como "https://myaccount.queue.core.windows.net/myqueue". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline
Pipeline

Chame StorageURL.newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.

Detalhes de Propriedade

pipeline

Pipeline de políticas de solicitação.

pipeline: Pipeline

Valor de Propriedade

url

Valor da cadeia de caracteres de URL.

url: string

Valor de Propriedade

string

Detalhes de Método

create(Aborter, IQueueCreateOptions)

Cria uma nova fila na conta especificada.

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

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), vá para documentos do Aborter para obter mais exemplos sobre o cancelamento de solicitações

Devoluções

Promise<Models.QueueCreateResponse>

delete(Aborter)

Exclui a fila especificada permanentemente.

function delete(aborter: Aborter)

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), vá para documentos do Aborter para obter mais exemplos sobre o cancelamento de solicitações

Devoluções

Promise<Models.QueueDeleteResponse>

fromServiceURL(ServiceURL, string)

Cria um objeto QueueURL a partir de ServiceURL

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

Parâmetros

serviceURL
ServiceURL
queueName

string

Devoluções

getAccessPolicy(Aborter)

Obtém detalhes sobre quaisquer políticas de acesso armazenado especificadas na fila que podem ser usadas com Assinaturas de Acesso Compartilhado. AVISO: JavaScript Date perderá a precisão ao analisar a cadeia de caracteres de início e expiração. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z".

function getAccessPolicy(aborter: Aborter)

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), vá para documentos do Aborter para obter mais exemplos sobre o cancelamento de solicitações

Devoluções

getProperties(Aborter)

Obtém todos os metadados definidos pelo usuário e as propriedades do sistema para a fila especificada. Os metadados são associados à fila como pares nome-valores.

function getProperties(aborter: Aborter)

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), vá para documentos do Aborter para obter mais exemplos sobre o cancelamento de solicitações

Devoluções

Promise<Models.QueueGetPropertiesResponse>

newPipeline(Credential, INewPipelineOptions)

Um método estático usado para criar um novo objeto Pipeline com Credential fornecido.

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

Parâmetros

credential
Credential

Como AnonymousCredential, SharedKeyCredential ou TokenCredential.

pipelineOptions
INewPipelineOptions

Devoluções

Um novo objeto Pipeline.

setAccessPolicy(Aborter, ISignedIdentifier[])

Define políticas de acesso armazenado para a fila que podem ser usadas com Assinaturas de Acesso Compartilhado.

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

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), vá para documentos do Aborter para obter mais exemplos sobre o cancelamento de solicitações

queueAcl

ISignedIdentifier[]

Devoluções

Promise<Models.QueueSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

Define um ou mais pares nome-valor definidos pelo usuário para a fila especificada. Se nenhuma opção for fornecida, ou nenhum metadados definido no parâmetro option, os metadados da fila serão removidos.

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

Parâmetros

aborter
Aborter

Crie uma nova instância do Aborter com Aborter.none ou Aborter.timeout(), vá para documentos do Aborter para obter mais exemplos sobre o cancelamento de solicitações

metadata
IMetadata

Devoluções

Promise<Models.QueueSetMetadataResponse>

withPipeline(Pipeline)

Cria um novo objeto QueueURL idêntico à origem, mas com o pipeline de política de solicitação especificado.

function withPipeline(pipeline: Pipeline)

Parâmetros

pipeline
Pipeline

Devoluções