@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 . Es posible construir la cadena de permisos sin esta clase, pero el orden de los permisos es particular y esta clase garantiza la exactitud. |
AccountSASResourceTypes |
SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que representa los recursos accesibles por 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 . Es posible construir la cadena de recursos sin esta clase, pero el orden de los recursos es particular y esta clase garantiza la exactitud. |
AccountSASServices |
SOLO ESTÁ DISPONIBLE EN NODE.JS RUNTIME. Se trata de una clase auxiliar para construir una cadena que representa los servicios accesibles por un 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 . Es posible construir la cadena de servicios sin esta clase, pero el orden de los servicios es particular y esta clase garantiza la exactitud. |
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á un generador credentialPolicyCreator que genera CredentialPolicy. |
CredentialPolicy |
Directiva de credenciales usada para firmar solicitudes HTTP(S) antes de enviarlas. Esta es una clase abstracta. |
HttpHeaders |
Colección de pares clave-valor de encabezado HTTP. |
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 de 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 campo de permisos en un objeto 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 del servicio de cola de Azure Storage que le permite manipular colas. |
RequestPolicyOptions |
Propiedades opcionales que se pueden usar al crear una requestPolicy. |
RestError |
Error resultante de una solicitud HTTP a un punto de conexión de servicio. |
SASQueryParameters |
Representa los componentes que componen los parámetros de consulta de una SAS de Azure Storage. El usuario no construye directamente este tipo; solo lo generan los tipos AccountSASSignatureValues y QueueSASSignatureValues . Una vez generado, se puede codificar en y toString() 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 para 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:
|
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. |
WebResource |
Crea un nuevo objeto WebResource. Esta clase proporciona una abstracción sobre una llamada REST, ya que es independiente de la biblioteca o implementación y ajusta las propiedades necesarias para iniciar una solicitud. |
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 se puede aplicar realmente a las direcciones URL de la cola. Tenga en cuenta que 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 de HTTP que permite que una aplicación web que se ejecuta en un dominio tenga acceso a 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 |
Objeto devuelto en la matriz QueueMessageList al llamar a Put Message en una cola. |
GeoReplication |
Geo-Replication información del servicio de almacenamiento secundario |
HttpOperationResponse |
Objeto contenedor para la solicitud http y la respuesta. El objeto deserializado se almacena en la |
IHttpClient |
Interfaz que puede enviar HttpRequests y recibir httpResponses prometidos. |
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 cadena clave-valor. |
Metrics |
Interfaz que representa Las métricas. |
PeekedMessageItem |
El objeto devuelto en la matriz QueueMessageList al llamar a Vistazo Messages en una cola |
PipelineOptions |
Interfaz de opción para el constructor pipeline. |
QueueClearMessagesOptions |
Opciones para configurar la operación clearMessages |
QueueCreateHeaders |
Define encabezados para Queue_create operación. |
QueueCreateIfNotExistsResponse |
Contiene datos de respuesta para la operación createIfNotExists . |
QueueCreateOptions |
Opciones para configurar la operación de creación |
QueueDeleteHeaders |
Define encabezados para Queue_delete operación. |
QueueDeleteIfExistsResponse |
Contiene datos de respuesta para la operación deleteIfExists . |
QueueDeleteMessageOptions |
Opciones para configurar la operación deleteMessage |
QueueDeleteOptions |
Opciones para configurar la operación de eliminación |
QueueExistsOptions |
Opciones para configurar la operación exists |
QueueGenerateSasUrlOptions |
Opciones para configurar la operación generateSasUrl . |
QueueGetAccessPolicyHeaders |
Define encabezados para Queue_getAccessPolicy operación. |
QueueGetAccessPolicyOptions |
Opciones para configurar la operación getAccessPolicy |
QueueGetPropertiesHeaders |
Define encabezados para Queue_getProperties operación. |
QueueGetPropertiesOptions |
Opciones para configurar la operación getProperties |
QueueItem |
Una cola de Azure Storage. |
QueuePeekMessagesOptions |
Opciones para configurar la operación peekMessages |
QueueReceiveMessageOptions |
Opciones para configurar la operación 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 la operación 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 la operación setAccessPolicy |
QueueSetMetadataHeaders |
Define encabezados para Queue_setMetadata operación. |
QueueSetMetadataOptions |
Opciones para configurar la operación setMetadata |
QueueUpdateMessageOptions |
Opciones para configurar la operación updateMessage |
RequestPolicy |
Estructura subyacente de una directiva de solicitud. |
RetentionPolicy |
la directiva de retención |
SasIPRange |
Intervalo IP permitido para una SAS. |
ServiceGenerateAccountSasUrlOptions |
Opciones para configurar la operación generateAccountSasUrl . |
ServiceGetPropertiesHeaders |
Define encabezados para Service_getProperties operación. |
ServiceGetPropertiesOptions |
Opciones para configurar la operación getProperties |
ServiceGetStatisticsHeaders |
Define encabezados para Service_getStatistics operación. |
ServiceGetStatisticsOptions |
Opciones para configurar la operación getStatistics |
ServiceListQueuesOptions |
Opciones para configurar la operación listQueues |
ServiceListQueuesSegmentHeaders |
Define encabezados para Service_listQueuesSegment operación. |
ServiceSetPropertiesHeaders |
Define encabezados para Service_setProperties operación. |
ServiceSetPropertiesOptions |
Opciones para configurar la operación setProperties |
SignedIdentifier |
Identificador firmado. |
SignedIdentifierModel |
identificador firmado |
StoragePipelineOptions |
Interfaz de opción para el método newPipeline(). |
StorageRetryOptions |
Interfaz de opciones de reintentos de cola de Storage. |
Alias de tipos
CredentialPolicyCreator |
Función de generador que crea una nueva CredentialPolicy que usa nextPolicy proporcionada. |
GeoReplicationStatusType |
Define valores para GeoReplicationStatusType. |
HttpRequestBody |
Posibles tipos de cuerpo de solicitud HTTP |
ListQueuesIncludeType |
Define valores para ListQueuesIncludeType. Entre los valores posibles se incluyen: "metadatos". |
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 clearMessages . |
QueueCreateResponse |
Contiene datos de respuesta para la operación de creación. |
QueueDeleteMessageResponse |
Contiene datos de respuesta para la operación deleteMessage . |
QueueDeleteResponse |
Contiene datos de respuesta para la operación de eliminación. |
QueueGetAccessPolicyResponse |
Contiene datos de respuesta para la operación getAccessPolicy . |
QueueGetPropertiesResponse |
Contiene datos de respuesta para la operación getProperties. |
QueuePeekMessagesResponse |
Contiene los datos de respuesta de la operación peekMessages . |
QueueReceiveMessageResponse |
Contiene los datos de respuesta de la operación receiveMessages . |
QueueSendMessageResponse |
Contiene los datos de respuesta de la operación 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 updateMessage . |
ReceivedMessageItem |
Objeto devuelto en la Consulte: QueueReceiveMessageResponse |
RequestPolicyFactory |
Crea una nueva requestPolicy por solicitud que usa nextPolicy proporcionada. |
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. |
StorageQueueAudience |
Define las audiencias de nube conocidas para Storage. |
StorageRetryPolicyType |
Tipos RetryPolicy. |
Funciones
deserialization |
Cree una nueva serialización RequestPolicyCreator que serializará los cuerpos de solicitud HTTP a medida que pasan a través de la canalización HTTP. |
generate |
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. Consulta https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas. |
generate |
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 expirar Los permisos de & manualmente si se inicializa con este constructor. |
get |
|
new |
Crea un nuevo objeto Pipeline con credential proporcionado. |
Detalles de la función
deserializationPolicy(DeserializationContentTypes, SerializerOptions)
Cree una nueva serialización RequestPolicyCreator que serializará los cuerpos de solicitud HTTP a medida que pasan a través de la canalización HTTP.
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory
Parámetros
- deserializationContentTypes
- DeserializationContentTypes
- parsingOptions
- SerializerOptions
Devoluciones
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.
Consulta 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
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 expirar Los permisos de & manualmente si se inicializa con este constructor.
function generateQueueSASQueryParameters(queueSASSignatureValues: QueueSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
Parámetros
- queueSASSignatureValues
- QueueSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Devoluciones
getQueueServiceAccountAudience(string)
function getQueueServiceAccountAudience(storageAccountName: string): string
Parámetros
- storageAccountName
-
string
Devoluciones
string
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 @azure/identity
paquete para autenticar las solicitudes en el 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.