QueueURL class

Pacote:: @azure/storage-queue

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

Extends: StorageURL

Construtores

Cria uma instância de QueueURL.

Propriedades

pipeline	Solicitar pipeline de política.
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 do ServiceURL
getAccessPolicy(Aborter)	Obtém detalhes sobre as políticas de acesso armazenadas especificadas na fila que podem ser usadas com Assinaturas de Acesso Compartilhado. AVISO: a Data do JavaScript potencialmente 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-valor.
newPipeline(Credential, INewPipelineOptions)	Um método estático usado para criar um novo objeto Pipeline com a Credencial fornecida.
setAccessPolicy(Aborter, ISignedIdentifier[])	Define políticas de acesso armazenadas para a fila que pode ser usada 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 de opção, 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 do 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 da propriedade

pipeline

Solicitar pipeline de política.

pipeline: Pipeline

Valor da propriedade

Pipeline

url

Valor da cadeia de caracteres de URL.

url: string

Valor da propriedade

string

Detalhes do 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(), documentos goto do Aborter para obter mais exemplos sobre cancelamento de solicitação

options: IQueueCreateOptions

Retornos

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(), documentos goto do Aborter para obter mais exemplos sobre cancelamento de solicitação

Retornos

Promise<Models.QueueDeleteResponse>

fromServiceURL(ServiceURL, string)

Cria um objeto QueueURL do ServiceURL

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

Parâmetros

serviceURL: ServiceURL

queueName: string

Retornos

QueueURL

getAccessPolicy(Aborter)

Obtém detalhes sobre as políticas de acesso armazenadas especificadas na fila que podem ser usadas com Assinaturas de Acesso Compartilhado. AVISO: a Data do JavaScript potencialmente 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(), documentos goto do Aborter para obter mais exemplos sobre cancelamento de solicitação

Retornos

Promise<QueueGetAccessPolicyResponse>

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-valor.

function getProperties(aborter: Aborter)

Parâmetros

aborter: Aborter

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

Retornos

Promise<Models.QueueGetPropertiesResponse>

newPipeline(Credential, INewPipelineOptions)

Um método estático usado para criar um novo objeto Pipeline com a Credencial fornecida.

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

Parâmetros

credential: Credential

Como AnonymousCredential, SharedKeyCredential ou TokenCredential.

pipelineOptions: INewPipelineOptions

Retornos

Pipeline

Um novo objeto Pipeline.

setAccessPolicy(Aborter, ISignedIdentifier[])

Define políticas de acesso armazenadas para a fila que pode ser usada 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(), documentos goto do Aborter para obter mais exemplos sobre cancelamento de solicitação

queueAcl: ISignedIdentifier[]

Retornos

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 de opção, 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(), documentos goto do Aborter para obter mais exemplos sobre cancelamento de solicitação

metadata: IMetadata

Retornos

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

Retornos

QueueURL

Comentários

Esta página foi útil?