@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 campo de permisos en un objeto <xref:AccountSASSignatureValues>. 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 <xref:AccountSASSignatureValues>. 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 campo de servicios en un objeto <xref:AccountSASSignatureValues>. 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 <xref:CredentialPolicyCreator> usado para crear objetos <xref:AnonymousCredentialPolicy>. <xref: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).

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 como referencia 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 <xref:QueueSASSignatureValues>. 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.

SASQueryParameters

Representa los componentes que componen los parámetros de consulta de saS de Azure Storage. El usuario no construye directamente este tipo; solo se genera mediante los tipos <xref:AccountSASSignatureValues> y <xref:QueueSASSignatureValues>. Una vez generado, se puede codificar en un <xref:String> 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:

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

  2. Eliminación del encabezado de cookie para la seguridad

  3. 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 <xref:StorageBrowserPolicy>.

StorageClient

StorageClient representa una clase de cliente basada para <xref:QueueServiceClient>, <xref:QueueClient> y etc.

StorageClientContext
StorageRetryPolicy

Directiva de reintento con reintento exponencial y reintento lineal implementado.

StorageRetryPolicyFactory

StorageRetryPolicyFactory es una clase de fábrica que ayuda a generar objetos <xref: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: que tanto esta clase como <xref:SASQueryParameters> existen porque la primera es mutable y una representación lógica, mientras que esta última es inmutable y se usa para generar solicitudes REST reales.

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

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

PipelineOptions

Interfaz de opción para el constructor de canalización.

QueueClearMessagesOptions

Opciones para configurar <xref:QueueClient.clearMessages> operación

QueueCreateHeaders

Define encabezados para Queue_create operación.

QueueCreateIfNotExistsResponse

Contiene datos de respuesta para la operación de <xref:QueueClient.createIfNotExists>.

QueueCreateOptions

Opciones para configurar <xref:QueueClient.create> operación

QueueDeleteHeaders

Define encabezados para Queue_delete operación.

QueueDeleteIfExistsResponse

Contiene datos de respuesta para la operación de <xref:QueueClient.deleteIfExists>.

QueueDeleteMessageOptions

Opciones para configurar la operación de <xref:QueueClient.deleteMessage>

QueueDeleteOptions

Opciones para configurar <xref:QueueClient.delete> operación

QueueExistsOptions

Opciones para configurar <xref:QueueClient.exists> operación

QueueGenerateSasUrlOptions

Opciones para configurar <xref:QueueClient.generateSasUrl> operación.

QueueGetAccessPolicyHeaders

Define encabezados para Queue_getAccessPolicy operación.

QueueGetAccessPolicyOptions

Opciones para configurar <xref:QueueClient.getAccessPolicy> operación

QueueGetPropertiesHeaders

Define encabezados para Queue_getProperties operación.

QueueGetPropertiesOptions

Opciones para configurar <xref:QueueClient.getProperties> operación

QueueItem

Una cola de Azure Storage.

QueuePeekMessagesOptions

Opciones para configurar <xref:QueueClient.peekMessages> operación

QueueReceiveMessageOptions

Opciones para configurar <xref:QueueClient.receiveMessages> operación

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 <xref:QueueClient.sendMessage> operación

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 <xref:QueueClient.setAccessPolicy> operación

QueueSetMetadataHeaders

Define encabezados para Queue_setMetadata operación.

QueueSetMetadataOptions

Opciones para configurar <xref:QueueClient.setMetadata> operación

QueueUpdateMessageOptions

Opciones para configurar <xref:QueueClient.updateMessage> operación

RetentionPolicy

la directiva de retención

SasIPRange

Intervalo IP permitido para una SAS.

ServiceGenerateAccountSasUrlOptions

Opciones para configurar <xref:QueueServiceClient.generateAccountSasUrl> operación.

ServiceGetPropertiesHeaders

Define encabezados para Service_getProperties operación.

ServiceGetPropertiesOptions

Opciones para configurar <xref:QueueServiceClient.getProperties> operación

ServiceGetStatisticsHeaders

Define encabezados para Service_getStatistics operación.

ServiceGetStatisticsOptions

Opciones para configurar <xref:QueueServiceClient.getStatistics> operación

ServiceListQueuesOptions

Opciones para configurar <xref:QueueServiceClient.listQueues> operación

ServiceListQueuesSegmentHeaders

Define encabezados para Service_listQueuesSegment operación.

ServiceSetPropertiesHeaders

Define encabezados para Service_setProperties operación.

ServiceSetPropertiesOptions

Opciones para configurar <xref:QueueServiceClient.setProperties> operación

SignedIdentifier

Identificador firmado.

SignedIdentifierModel

identificador firmado

StorageClientOptionalParams

Parámetros opcionales.

StoragePipelineOptions

Interfaz de opción para el método newPipeline().

StorageRetryOptions

Interfaz de opciones de reintento de cola de Storage.

Alias de tipos

CredentialPolicyCreator

Función de fábrica que crea una nueva CredentialPolicy que usa nextPolicy proporcionada.

GeoReplicationStatusType

Define valores para GeoReplicationStatusType.

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 <xref:QueueClient.clearMessages>.

QueueCreateResponse

Contiene datos de respuesta para la operación de creación.

QueueDeleteMessageResponse

Contiene datos de respuesta para la operación de <xref:QueueClient.deleteMessage>.

QueueDeleteResponse

Contiene datos de respuesta para la operación de eliminación.

QueueGetAccessPolicyResponse

Contiene datos de respuesta para la operación de <xref:QueueClient.getAccessPolicy>.

QueueGetPropertiesResponse

Contiene datos de respuesta para la operación getProperties.

QueuePeekMessagesResponse

Contiene los datos de respuesta de la operación de <xref:QueueClient.peekMessages>.

QueueReceiveMessageResponse

Contiene los datos de respuesta de la operación de <xref:QueueClient.receiveMessages>.

QueueSendMessageResponse

Contiene los datos de respuesta de la operación de <xref:QueueClient.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 <xref:QueueClient.updateMessage>.

ReceivedMessageItem

Objeto devuelto en la matriz de receivedMessageItems al llamar a <xref:QueueClient.receiveMessages>. Consulte: <xref: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.

Enumeraciones

SASProtocol

Protocolos para SAS generados.

StorageRetryPolicyType

Tipos RetryPolicy.

Funciones

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Genera un objeto <xref:SASQueryParameters> que contiene todos los parámetros de consulta de SAS necesarios para realizar una solicitud REST real.

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.

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 <xref:SASQueryParameters> que contiene todos los parámetros de consulta de SAS necesarios para realizar una solicitud REST real.

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)

Parámetros

accountSASSignatureValues
AccountSASSignatureValues

Valores de firma de SAS de la cuenta

sharedKeyCredential
StorageSharedKeyCredential

Credencial de clave compartida.

Devoluciones

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)

Parámetros

queueSASSignatureValues
QueueSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

Devoluciones

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un nuevo objeto Pipeline con credential proporcionado.

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

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

Opciones.

Devoluciones

Nuevo objeto Pipeline.