@azure/storage-queue package

Clases

AccountSASPermissions	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que representa los permisos concedidos por un AccountSAS. Establecer un valor en true significa que cualquier SAS que use estos permisos concederá permisos para esa operación. Una vez establecidos todos los valores, debe serializarse con toString y establecerse como el campo de permisos en un objeto accountSASSignatureValues de. Es posible construir la cadena de permisos sin esta clase, pero el orden de los permisos es particular y esta clase garantiza la corrección.
AccountSASResourceTypes	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que representa los recursos a los que puede acceder un AccountSAS. Establecer un valor en true significa que cualquier SAS que use estos permisos concederá acceso a ese tipo de recurso. Una vez establecidos todos los valores, debe serializarse con toString y establecerse como el campo resources en un objeto accountSASSignatureValues de. Es posible construir la cadena de recursos sin esta clase, pero el orden de los recursos es concreto y esta clase garantiza la corrección.
AccountSASServices	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que represente los servicios accesibles por accountSAS. Establecer un valor en true significa que cualquier SAS que use estos permisos concederá acceso a ese servicio. Una vez establecidos todos los valores, debe serializarse con toString y establecerse como el campo de servicios en un objeto accountSASSignatureValues de. Es posible construir la cadena de servicios sin esta clase, pero el orden de los servicios es particular y esta clase garantiza la corrección.
AnonymousCredential	AnonymousCredential proporciona un miembro credentialPolicyCreator que se usa para crear objetos AnonymousCredentialPolicy. AnonymousCredentialPolicy se usa con solicitudes HTTP(S) que leen recursos públicos o que se usan con firmas de acceso compartido (SAS).
AnonymousCredentialPolicy	AnonymousCredentialPolicy se usa con solicitudes HTTP(S) que leen recursos públicos o que se usan con firmas de acceso compartido (SAS).
BaseRequestPolicy	Clase base de la que derivan todas las directivas de solicitud.
Credential	Credential es una clase abstracta para la firma de solicitudes HTTP de Azure Storage. Esta clase hospedará una factoría credentialPolicyCreator que genera CredentialPolicy.
CredentialPolicy	Directiva de credenciales que se usa para firmar solicitudes HTTP(S) antes de enviarlos. Se trata de una clase abstracta.
Pipeline	Una clase pipeline que contiene directivas de solicitud HTTP. Puede crear una canalización predeterminada llamando a newPipeline. O bien, puede crear una canalización con sus propias directivas mediante el constructor de Pipeline. Consulte newPipeline y las directivas proporcionadas antes de implementar la canalización personalizada.
QueueClient	QueueClient representa una dirección URL a los mensajes de una cola de Azure Storage que le permite manipular sus mensajes.
QueueSASPermissions	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que representa los permisos concedidos por un ServiceSAS a una cola. Establecer un valor en true significa que cualquier SAS que use estos permisos concederá permisos para esa operación. Una vez establecidos todos los valores, debe serializarse con toString y establecerse como el campo de permisos en un objeto QueueSASSignatureValues de. Es posible construir la cadena de permisos sin esta clase, pero el orden de los permisos es particular y esta clase garantiza la corrección.
QueueServiceClient	QueueServiceClient representa una dirección URL al servicio de colas de Azure Storage que le permite manipular colas.
RestError	Tipo de error personalizado para solicitudes de canalización con error.
SASQueryParameters	Representa los componentes que componen los parámetros de consulta de saS de Azure Storage. El usuario no construye directamente este tipo; solo lo generan los AccountSASSignatureValues y QueueSASSignatureValues. Una vez generado, se puede codificar en un toString() y anexarse directamente a una dirección URL (aunque debe tenerse cuidado aquí en caso de que haya parámetros de consulta existentes, lo que podría afectar a los medios adecuados de anexar estos parámetros de consulta). NOTA: Las instancias de esta clase son inmutables.
StorageBrowserPolicy	StorageBrowserPolicy controlará las diferencias entre Node.js y el entorno de ejecución del explorador, entre los que se incluyen: Los exploradores almacenan en caché las solicitudes GET/HEAD agregando encabezados condicionales como "IF_MODIFIED_SINCE". StorageBrowserPolicy es una directiva que se usa para agregar una consulta de marca de tiempo a la dirección URL de solicitud GET/HEAD, por lo que evita la memoria caché del explorador. Eliminación del encabezado de cookie para la seguridad Eliminación del encabezado de longitud de contenido para evitar la advertencia de exploradores
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory es una clase de fábrica que ayuda a generar objetos StorageBrowserPolicy.
StorageRetryPolicy	Directiva de reintento con reintento exponencial y reintento lineal implementado.
StorageRetryPolicyFactory	StorageRetryPolicyFactory es una clase de fábrica que ayuda a generar objetos StorageRetryPolicy.
StorageSharedKeyCredential	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. StorageSharedKeyCredential para la autorización de clave de cuenta del servicio Azure Storage.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy es una directiva que se usa para firmar la solicitud HTTP con una clave compartida.

Interfaces

AccessPolicy	Una directiva de acceso
AccountSASSignatureValues	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. AccountSASSignatureValues se usa para generar una firma de acceso compartido (SAS) para una cuenta de Azure Storage. Una vez que todos los valores aquí se establecen correctamente, llame a generateSASQueryParameters() para obtener una representación de la SAS que realmente se puede aplicar a las direcciones URL de la cola. Nota: tanto esta clase como SASQueryParameters existen porque el primero es mutable y una representación lógica, mientras que esta última es inmutable y se usa para generar solicitudes REST reales. Consulte https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 para obtener más información conceptual sobre SAS Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas para obtener descripciones de los parámetros, incluidos los que son necesarios.
CommonOptions	Interfaz para las opciones comunes a cada operación remota.
CorsRule	CORS es una característica HTTP que permite que una aplicación web que se ejecute en un dominio acceda a los recursos de otro dominio. Los exploradores web implementan una restricción de seguridad conocida como directiva de mismo origen que impide que una página web llame a las API en un dominio diferente; CORS proporciona una manera segura de permitir que un dominio (el dominio de origen) llame a las API de otro dominio.
DequeuedMessageItem	Objeto devuelto en la matriz QueueMessageList al llamar a Get Messages en una cola.
EnqueuedMessage	El objeto devuelto en la matriz QueueMessageList al llamar a Put Message en una cola
GeoReplication	Geo-Replication información del servicio de almacenamiento secundario
HttpHeaders	Colección de pares clave-valor de encabezado HTTP.
HttpOperationResponse	Respuesta HTTP compatible con core-v1(core-http).
HttpResponse	Representación de una respuesta HTTP que incluye una referencia a la solicitud que la originó.
IHttpClient	Una interfaz compatible para las directivas de solicitud core-http
ListQueuesSegmentResponse	Objeto devuelto al llamar a List Queues en un servicio queue.
Logging	Configuración de registro de Azure Analytics.
MessageIdDeleteHeaders	Define encabezados para MessageId_delete operación.
MessageIdUpdateHeaders	Define encabezados para MessageId_update operación.
MessagesClearHeaders	Define encabezados para Messages_clear operación.
MessagesDequeueHeaders	Define encabezados para Messages_dequeue operación.
MessagesDequeueOptionalParams	Parámetros opcionales.
MessagesEnqueueHeaders	Define encabezados para Messages_enqueue operación.
MessagesEnqueueOptionalParams	Parámetros opcionales.
MessagesPeekHeaders	Define encabezados para Messages_peek operación.
MessagesPeekOptionalParams	Parámetros opcionales.
Metadata	Colección de pares de cadenas clave-valor.
Metrics	Interfaz que representa las métricas.
PeekedMessageItem	El objeto devuelto en la matriz QueueMessageList al llamar a Peek Messages en una cola
PipelineLike	Interfaz para la clase canalización de que contiene directivas de solicitud HTTP. Puede crear una canalización predeterminada llamando a newPipeline. O bien, puede crear una canalización con sus propias directivas mediante el constructor de Pipeline. Consulte newPipeline y las directivas proporcionadas antes de implementar la canalización personalizada.
PipelineOptions	Interfaz de opción para el constructor de canalización.
QueueClearMessagesOptions	Opciones para configurar operación clearMessages
QueueCreateHeaders	Define encabezados para Queue_create operación.
QueueCreateIfNotExistsResponse	Contiene datos de respuesta para la operación de createIfNotExists.
QueueCreateOptions	Opciones para configurar operación de creación de
QueueDeleteHeaders	Define encabezados para Queue_delete operación.
QueueDeleteIfExistsResponse	Contiene datos de respuesta para la operación de deleteIfExists.
QueueDeleteMessageOptions	Opciones para configurar la operación de deleteMessage de
QueueDeleteOptions	Opciones para configurar operación de eliminación de
QueueExistsOptions	Existen opciones para configurar operación
QueueGenerateSasUrlOptions	Opciones para configurar operación generateSasUrl.
QueueGetAccessPolicyHeaders	Define encabezados para Queue_getAccessPolicy operación.
QueueGetAccessPolicyOptions	Opciones para configurar operación getAccessPolicy
QueueGetPropertiesHeaders	Define encabezados para Queue_getProperties operación.
QueueGetPropertiesOptions	Opciones para configurar operación getProperties
QueueItem	Una cola de Azure Storage.
QueuePeekMessagesOptions	Opciones para configurar operación de peekMessages
QueueReceiveMessageOptions	Opciones para configurar operación de receiveMessages
QueueSASSignatureValues	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. QueueSASSignatureValues se usa para ayudar a generar tokens saS de Queue Service para colas.
QueueSendMessageOptions	Opciones para configurar operación de sendMessage
QueueServiceProperties	Propiedades del servicio de almacenamiento.
QueueServiceStatistics	Estadísticas del servicio de almacenamiento.
QueueSetAccessPolicyHeaders	Define encabezados para Queue_setAccessPolicy operación.
QueueSetAccessPolicyOptions	Opciones para configurar operación setAccessPolicy
QueueSetMetadataHeaders	Define encabezados para Queue_setMetadata operación.
QueueSetMetadataOptions	Opciones para configurar operación setMetadata
QueueUpdateMessageOptions	Opciones para configurar operación updateMessage
RequestPolicyFactory	Interfaz de compatibilidad con RequestPolicyFactory de core-http
RequestPolicyOptions	Interfaz de compatibilidad con RequestPolicy
ResponseLike	Objeto con una propiedad _response simple.
ResponseWithBody	Objeto con una propiedad _response que tiene el cuerpo y los encabezados ya analizados en tipos conocidos.
ResponseWithHeaders	Objeto con una propiedad _response que tiene encabezados ya analizados en un objeto con tipo.
RetentionPolicy	la directiva de retención
SasIPRange	Intervalo IP permitido para una SAS.
ServiceClientOptions	Subconjunto de @azure/core-http ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Opciones para configurar operación de generateAccountSasUrl.
ServiceGetPropertiesHeaders	Define encabezados para Service_getProperties operación.
ServiceGetPropertiesOptions	Opciones para configurar operación getProperties
ServiceGetStatisticsHeaders	Define encabezados para Service_getStatistics operación.
ServiceGetStatisticsOptions	Opciones para configurar operación de getStatistics
ServiceListQueuesOptions	Opciones para configurar operación de listQueues
ServiceListQueuesSegmentHeaders	Define encabezados para Service_listQueuesSegment operación.
ServiceSetPropertiesHeaders	Define encabezados para Service_setProperties operación.
ServiceSetPropertiesOptions	Opciones para configurar operación setProperties
SignedIdentifier	Identificador firmado.
SignedIdentifierModel	identificador firmado
StoragePipelineOptions	Interfaz de opciones de la función newPipeline.
StorageRetryOptions	Interfaz de opciones de reintento de blobs de storage.
WebResource	Descripción de una solicitud HTTP que se va a realizar en un servidor remoto.

Alias de tipos

CredentialPolicyCreator	Función de fábrica que crea una nueva CredentialPolicy que usa nextPolicy proporcionada.
GeoReplicationStatusType	Define valores para GeoReplicationStatusType.
HttpRequestBody	Tipos de cuerpos admitidos en la solicitud. NodeJS.ReadableStream y () => NodeJS.ReadableStream es solo Node. Blob, ReadableStream y () => ReadableStream son solo el explorador.
ListQueuesIncludeType	Define valores para ListQueuesIncludeType. Entre los valores posibles se incluyen los siguientes: 'metadata'
MessageIdDeleteResponse	Contiene datos de respuesta para la operación de eliminación.
MessageIdUpdateResponse	Contiene datos de respuesta para la operación de actualización.
MessagesClearResponse	Contiene datos de respuesta para la operación clear.
QueueClearMessagesResponse	Contiene datos de respuesta para la operación de clearMessages.
QueueCreateResponse	Contiene datos de respuesta para la operación de creación.
QueueDeleteMessageResponse	Contiene datos de respuesta para la operación de deleteMessage.
QueueDeleteResponse	Contiene datos de respuesta para la operación de eliminación.
QueueGetAccessPolicyResponse	Contiene datos de respuesta para la operación de getAccessPolicy.
QueueGetPropertiesResponse	Contiene datos de respuesta para la operación getProperties.
QueuePeekMessagesResponse	Contiene los datos de respuesta de la operación peekMessages de.
QueueReceiveMessageResponse	Contiene los datos de respuesta de la operación de receiveMessages.
QueueSendMessageResponse	Contiene los datos de respuesta de la operación de sendMessage.
QueueSetAccessPolicyResponse	Contiene datos de respuesta para la operación setAccessPolicy.
QueueSetMetadataResponse	Contiene datos de respuesta para la operación setMetadata.
QueueUpdateMessageResponse	Contiene datos de respuesta para la operación de updateMessage de.
ReceivedMessageItem	Objeto devuelto en la matriz de receivedMessageItems al llamar a receiveMessages. Consulte: QueueReceiveMessageResponse
ServiceGetPropertiesResponse	Contiene datos de respuesta para la operación getProperties.
ServiceGetStatisticsResponse	Contiene datos de respuesta para la operación getStatistics.
ServiceListQueuesSegmentResponse	Contiene datos de respuesta para la operación listQueuesSegment.
ServiceSetPropertiesResponse	Contiene datos de respuesta para la operación setProperties.
WithResponse	Tipo que representa un resultado de operación con una propiedad _response conocida.

Enumeraciones

SASProtocol	Protocolos para SAS generados.
StorageQueueAudience	Define las audiencias en la nube conocidas para Storage.
StorageRetryPolicyType	Tipos RetryPolicy.

Funciones

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Genera un objeto SASQueryParameters que contiene todos los parámetros de consulta de SAS necesarios para realizar una solicitud REST real. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)	SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Crea una instancia de SASQueryParameters. Solo acepta la configuración necesaria para crear una SAS. Para la configuración opcional, establezca las propiedades correspondientes directamente, como permisos, startsOn e identificador. ADVERTENCIA: Cuando no se proporciona el identificador, se requieren permisos y expiresOn. Debe asignar valor al identificador o expirarOn & permisos manualmente si se inicializa con este constructor.
getQueueServiceAccountAudience(string)	Para obtener la audiencia de OAuth para una cuenta de almacenamiento para queue service.
isPipelineLike(unknown)	Asistente para decidir si un argumento determinado satisface el contrato de canalización
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Crea un nuevo objeto Pipeline con credential proporcionado.

Detalles de la función

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Genera un objeto SASQueryParameters que contiene todos los parámetros de consulta de SAS necesarios para realizar una solicitud REST real.

Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parámetros

accountSASSignatureValues

AccountSASSignatureValues

Valores de firma de SAS de la cuenta

sharedKeyCredential

StorageSharedKeyCredential

Credencial de clave compartida.

Devoluciones

SASQueryParameters

generateQueueSASQueryParameters(QueueSASSignatureValues, StorageSharedKeyCredential)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME.

Crea una instancia de SASQueryParameters.

Solo acepta la configuración necesaria para crear una SAS. Para la configuración opcional, establezca las propiedades correspondientes directamente, como permisos, startsOn e identificador.

ADVERTENCIA: Cuando no se proporciona el identificador, se requieren permisos y expiresOn. Debe asignar valor al identificador o expirarOn & permisos manualmente si se inicializa con este constructor.

function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Parámetros

queueSASSignatureValues

QueueSASSignatureValues

sharedKeyCredential

StorageSharedKeyCredential

Devoluciones

SASQueryParameters

getQueueServiceAccountAudience(string)

Para obtener la audiencia de OAuth para una cuenta de almacenamiento para queue service.

function getQueueServiceAccountAudience(storageAccountName: string): string

Parámetros

storageAccountName

string

Devoluciones

string

isPipelineLike(unknown)

Asistente para decidir si un argumento determinado satisface el contrato de canalización

function isPipelineLike(pipeline: unknown): pipeline

Parámetros

pipeline

unknown

Argumento que puede ser una canalización

Devoluciones

pipeline

true cuando el argumento satisface el contrato de canalización

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un nuevo objeto Pipeline con credential proporcionado.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Parámetros

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del paquete de @azure/identity para autenticar las solicitudes al servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

pipelineOptions

StoragePipelineOptions

Opcional. Opciones.

Devoluciones

Pipeline

Nuevo objeto Pipeline.