QueueURL class

Пакет:: @azure/storage-queue

QueueURL представляет URL-адрес очереди службы хранилища Azure.

Extends: StorageURL

Конструкторы

Создает экземпляр QueueURL.

Свойства

pipeline	Конвейер политики запроса.
url	Значение строки URL-адреса.

Методы

create(Aborter, IQueueCreateOptions)	Создает новую очередь под указанной учетной записью.
delete(Aborter)	Удаляет указанную очередь окончательно.
fromServiceURL(ServiceURL, string)	Создает объект QueueURL из ServiceURL
getAccessPolicy(Aborter)	Получает сведения о любых хранимых политиках доступа, указанных в очереди, которая может использоваться с подписанными URL-адресами. ПРЕДУПРЕЖДЕНИЕ. Дата JavaScript может потерять точность при анализе строки начала и истечения срока действия. Например, new Date("2018-12-31T03:44:23.8827891Z").toISOString() получит "2018-12-31T03:44:23.882Z".
getProperties(Aborter)	Возвращает все пользовательские метаданные и системные свойства для указанной очереди. Метаданные связаны с очередью как пары "значения имен".
newPipeline(Credential, INewPipelineOptions)	Статический метод, используемый для создания объекта Pipeline с предоставленными учетными данными.
setAccessPolicy(Aborter, ISignedIdentifier[])	Задает хранимые политики доступа для очереди, которая может использоваться с подписанными URL-адресами.
setMetadata(Aborter, IMetadata)	Задает одну или несколько определяемых пользователем пар "имя-значение" для указанной очереди. Если параметр не указан или метаданные, определенные в параметре параметра, метаданные очереди будут удалены.
withPipeline(Pipeline)	Создает новый объект QueueURL, идентичный источнику, но с указанным конвейером политики запроса.

Сведения о конструкторе

QueueURL(string, Pipeline)

Создает экземпляр QueueURL.

new QueueURL(url: string, pipeline: Pipeline)

Параметры

url: string

Строка URL-адреса, указывающая на очередь службы хранилища Azure, например "https://myaccount.queue.core.windows.net/myqueue". При использовании AnonymousCredential можно добавить SAS, например "https://myaccount.queue.core.windows.net/myqueue?sasString".

pipeline: Pipeline

Вызовите StorageURL.newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.

Сведения о свойстве

pipeline

Конвейер политики запроса.

pipeline: Pipeline

Значение свойства

Pipeline

url

Значение строки URL-адреса.

url: string

Значение свойства

string

Сведения о методе

create(Aborter, IQueueCreateOptions)

Создает новую очередь под указанной учетной записью.

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

Параметры

aborter: Aborter

Создание нового экземпляра Aborter с помощью Aborter.none или Aborter.timeout(), документов goto Aborter для получения дополнительных примеров об отмене запроса

options: IQueueCreateOptions

Возвращаемое значение

Promise<Models.QueueCreateResponse>

delete(Aborter)

Удаляет указанную очередь окончательно.

function delete(aborter: Aborter)

Параметры

aborter: Aborter

Возвращаемое значение

Promise<Models.QueueDeleteResponse>

fromServiceURL(ServiceURL, string)

Создает объект QueueURL из ServiceURL

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

Параметры

serviceURL: ServiceURL

queueName: string

Возвращаемое значение

QueueURL

getAccessPolicy(Aborter)

Получает сведения о любых хранимых политиках доступа, указанных в очереди, которая может использоваться с подписанными URL-адресами. ПРЕДУПРЕЖДЕНИЕ. Дата JavaScript может потерять точность при анализе строки начала и истечения срока действия. Например, new Date("2018-12-31T03:44:23.8827891Z").toISOString() получит "2018-12-31T03:44:23.882Z".

function getAccessPolicy(aborter: Aborter)

Параметры

aborter: Aborter

Возвращаемое значение

Promise<QueueGetAccessPolicyResponse>

getProperties(Aborter)

Возвращает все пользовательские метаданные и системные свойства для указанной очереди. Метаданные связаны с очередью как пары "значения имен".

function getProperties(aborter: Aborter)

Параметры

aborter: Aborter

Возвращаемое значение

Promise<Models.QueueGetPropertiesResponse>

newPipeline(Credential, INewPipelineOptions)

Статический метод, используемый для создания объекта Pipeline с предоставленными учетными данными.

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

Параметры

credential: Credential

Например, AnonymousCredential, SharedKeyCredential или TokenCredential.

pipelineOptions: INewPipelineOptions

Возвращаемое значение

Pipeline

Новый объект Pipeline.

setAccessPolicy(Aborter, ISignedIdentifier[])

Задает хранимые политики доступа для очереди, которая может использоваться с подписанными URL-адресами.

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

Параметры

aborter: Aborter

queueAcl: ISignedIdentifier[]

Возвращаемое значение

Promise<Models.QueueSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

Задает одну или несколько определяемых пользователем пар "имя-значение" для указанной очереди. Если параметр не указан или метаданные, определенные в параметре параметра, метаданные очереди будут удалены.

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

Параметры

aborter: Aborter

metadata: IMetadata

Возвращаемое значение

Promise<Models.QueueSetMetadataResponse>

withPipeline(Pipeline)

Создает новый объект QueueURL, идентичный источнику, но с указанным конвейером политики запроса.

function withPipeline(pipeline: Pipeline)

Параметры

pipeline: Pipeline

Возвращаемое значение

QueueURL

Обратная связь

Были ли сведения на этой странице полезными?