@azure/storage-queue 12.20.0-alpha.20230622.3 → 12.20.0-alpha.20230801.3

package/types/3.1/storage-queue.d.ts

@@ -1,21 +1,22 @@
 import { AbortSignalLike } from '@azure/abort-controller';
 import { AzureLogger } from '@azure/logger';
-import { CompatResponse } from '@azure/core-http-compat';
 import * as coreClient from '@azure/core-client';
 import * as coreHttpCompat from '@azure/core-http-compat';
-import { HttpHeadersLike } from '@azure/core-http-compat';
+import { HttpHeadersLike as HttpHeaders } from '@azure/core-http-compat';
+import { CompatResponse as HttpOperationResponse } from '@azure/core-http-compat';
 import { HttpPipelineLogLevel } from '@azure/core-http-compat';
+import { RequestBodyType as HttpRequestBody } from '@azure/core-rest-pipeline';
 import { KeepAliveOptions } from '@azure/core-http-compat';
 import { OperationTracingOptions } from '@azure/core-tracing';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { ProxySettings } from '@azure/core-rest-pipeline';
 import { RequestPolicy } from '@azure/core-http-compat';
 import { RequestPolicyFactory } from '@azure/core-http-compat';
-import { RequestPolicyOptionsLike } from '@azure/core-http-compat';
+import { RequestPolicyOptionsLike as RequestPolicyOptions } from '@azure/core-http-compat';
 import { RestError } from '@azure/core-rest-pipeline';
 import { TokenCredential } from '@azure/core-auth';
 import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
-import { WebResourceLike } from '@azure/core-http-compat';
+import { WebResourceLike as WebResource } from '@azure/core-http-compat';
 /** An Access policy */
 export declare interface AccessPolicy {
     /** the date-time the policy is active */
@@ -226,7 +227,7 @@ export declare class AnonymousCredential extends Credential_2 {
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): AnonymousCredentialPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
 }
 /**
  * AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources
@@ -238,7 +239,7 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
      * @param nextPolicy -
      * @param options -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
 }
 /**
  * The base class from which all request policies derive.
@@ -251,7 +252,7 @@ export declare abstract class BaseRequestPolicy implements RequestPolicy {
     /**
      * The options that can be passed to a given request policy.
      */
-    readonly _options: RequestPolicyOptionsLike;
+    readonly _options: RequestPolicyOptions;
     /**
      * The main method to implement that manipulates a request/response.
      */
@@ -263,12 +264,12 @@ export declare abstract class BaseRequestPolicy implements RequestPolicy {
     /**
      * The options that can be passed to a given request policy.
      */
-    _options: RequestPolicyOptionsLike);
+    _options: RequestPolicyOptions);
     /**
      * Sends a network request based on the given web resource.
      * @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
      */
-    abstract sendRequest(webResource: WebResourceLike): Promise<CompatResponse>;
+    abstract sendRequest(webResource: WebResource): Promise<HttpOperationResponse>;
     /**
      * Get whether or not a log with the provided log level should be logged.
      * @param logLevel - The log level of the log that will be logged.
@@ -316,7 +317,7 @@ declare abstract class Credential_2 implements RequestPolicyFactory {
      * @param _nextPolicy -
      * @param _options -
      */
-    create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptionsLike): RequestPolicy;
+    create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
 }
 export { Credential_2 as Credential };
 /**
@@ -329,19 +330,19 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
      *
      * @param request -
      */
-    sendRequest(request: WebResourceLike): Promise<CompatResponse>;
+    sendRequest(request: WebResource): Promise<HttpOperationResponse>;
     /**
      * Child classes must implement this method with request signing. This method
      * will be executed in {@link sendRequest}.
      *
      * @param request -
      */
-    protected signRequest(request: WebResourceLike): WebResourceLike;
+    protected signRequest(request: WebResource): WebResource;
 }
 /**
  * A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
  */
-export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike) => CredentialPolicy;
+export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy;
 /** The object returned in the QueueMessageList array when calling Get Messages on a Queue. */
 export declare interface DequeuedMessageItem {
     /** The Id of the Message. */
@@ -409,6 +410,9 @@ export declare interface GeoReplication {
 }
 /** Defines values for GeoReplicationStatusType. */
 export declare type GeoReplicationStatusType = "live" | "bootstrap" | "unavailable";
+export { HttpHeaders };
+export { HttpOperationResponse };
+export { HttpRequestBody };
 /**
  * A representation of an HTTP response that
  * includes a reference to the request that
@@ -418,11 +422,11 @@ export declare interface HttpResponse {
     /**
      * The headers from the response.
      */
-    headers: HttpHeadersLike;
+    headers: HttpHeaders;
     /**
      * The original request that resulted in this response.
      */
-    request: WebResourceLike;
+    request: WebResource;
     /**
      * The HTTP status code returned from the service.
      */
@@ -1894,6 +1898,10 @@ export declare type QueueUpdateMessageResponse = MessageIdUpdateResponse;
  * See: {@link QueueReceiveMessageResponse}
  */
 export declare type ReceivedMessageItem = DequeuedMessageItem;
+export { RequestPolicy as IHttpClient };
+export { RequestPolicy };
+export { RequestPolicyFactory };
+export { RequestPolicyOptions };
 /**
  * An object with a simple _response property.
  */
@@ -2336,13 +2344,13 @@ export declare class StorageBrowserPolicy extends BaseRequestPolicy {
      * @param nextPolicy -
      * @param options -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
     /**
      * Sends out request.
      *
      * @param request -
      */
-    sendRequest(request: WebResourceLike): Promise<CompatResponse>;
+    sendRequest(request: WebResource): Promise<HttpOperationResponse>;
 }
 /**
  * StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
@@ -2354,7 +2362,7 @@ export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageBrowserPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy;
 }
 /**
  * A StorageClient represents a based client class for {@link QueueServiceClient}, {@link QueueClient} and etc.
@@ -2401,6 +2409,10 @@ declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedSer
     /** Overrides client endpoint. */
     endpoint?: string;
 }
+/**
+ * The OAuth scope to use with Azure Storage.
+ */
+export declare const StorageOAuthScopes: string | string[];
 /**
  * Options interface for the {@link newPipeline} function.
  */
@@ -2488,13 +2500,13 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
      * @param options -
      * @param retryOptions -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, retryOptions?: StorageRetryOptions);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryOptions?: StorageRetryOptions);
     /**
      * Sends request.
      *
      * @param request -
      */
-    sendRequest(request: WebResourceLike): Promise<CompatResponse>;
+    sendRequest(request: WebResource): Promise<HttpOperationResponse>;
     /**
      * Decide and perform next retry. Won't mutate request parameter.
      *
@@ -2505,7 +2517,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
      * @param attempt -           How many retries has been attempted to performed, starting from 1, which includes
      *                                   the attempt will be performed by this method call.
      */
-    protected attemptSendRequest(request: WebResourceLike, secondaryHas404: boolean, attempt: number): Promise<CompatResponse>;
+    protected attemptSendRequest(request: WebResource, secondaryHas404: boolean, attempt: number): Promise<HttpOperationResponse>;
     /**
      * Decide whether to retry according to last HTTP response and retry counters.
      *
@@ -2514,7 +2526,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
      * @param response -
      * @param err -
      */
-    protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: CompatResponse, err?: RestError): boolean;
+    protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: HttpOperationResponse, err?: RestError): boolean;
     /**
      * Delay a calculated time between retries.
      *
@@ -2540,7 +2552,7 @@ export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageRetryPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy;
 }
 /**
  * RetryPolicy types.
@@ -2581,7 +2593,7 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageSharedKeyCredentialPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageSharedKeyCredentialPolicy;
     /**
      * Generates a hash signature for an HTTP request or for a SAS.
      *
@@ -2603,13 +2615,13 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
      * @param options -
      * @param factory -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, factory: StorageSharedKeyCredential);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, factory: StorageSharedKeyCredential);
     /**
      * Signs request.
      *
      * @param request -
      */
-    protected signRequest(request: WebResourceLike): WebResourceLike;
+    protected signRequest(request: WebResource): WebResource;
     /**
      * Retrieve header value according to shared key sign rules.
      * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
@@ -2639,6 +2651,7 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
      */
     private getCanonicalizedResourceString;
 }
+export { WebResource };
 /**
  * A type that represents an operation result with a known _response property.
  */

package/types/latest/storage-queue.d.ts

@@ -1,21 +1,22 @@
 import { AbortSignalLike } from '@azure/abort-controller';
 import { AzureLogger } from '@azure/logger';
-import { CompatResponse } from '@azure/core-http-compat';
 import * as coreClient from '@azure/core-client';
 import * as coreHttpCompat from '@azure/core-http-compat';
-import { HttpHeadersLike } from '@azure/core-http-compat';
+import { HttpHeadersLike as HttpHeaders } from '@azure/core-http-compat';
+import { CompatResponse as HttpOperationResponse } from '@azure/core-http-compat';
 import { HttpPipelineLogLevel } from '@azure/core-http-compat';
+import { RequestBodyType as HttpRequestBody } from '@azure/core-rest-pipeline';
 import { KeepAliveOptions } from '@azure/core-http-compat';
 import { OperationTracingOptions } from '@azure/core-tracing';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { ProxySettings } from '@azure/core-rest-pipeline';
 import { RequestPolicy } from '@azure/core-http-compat';
 import { RequestPolicyFactory } from '@azure/core-http-compat';
-import { RequestPolicyOptionsLike } from '@azure/core-http-compat';
+import { RequestPolicyOptionsLike as RequestPolicyOptions } from '@azure/core-http-compat';
 import { RestError } from '@azure/core-rest-pipeline';
 import { TokenCredential } from '@azure/core-auth';
 import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
-import { WebResourceLike } from '@azure/core-http-compat';
+import { WebResourceLike as WebResource } from '@azure/core-http-compat';
 
 /** An Access policy */
 export declare interface AccessPolicy {
@@ -232,7 +233,7 @@ export declare class AnonymousCredential extends Credential_2 {
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): AnonymousCredentialPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
 }
 
 /**
@@ -245,7 +246,7 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
      * @param nextPolicy -
      * @param options -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
 }
 
 /**
@@ -259,7 +260,7 @@ export declare abstract class BaseRequestPolicy implements RequestPolicy {
     /**
      * The options that can be passed to a given request policy.
      */
-    readonly _options: RequestPolicyOptionsLike;
+    readonly _options: RequestPolicyOptions;
     /**
      * The main method to implement that manipulates a request/response.
      */
@@ -271,12 +272,12 @@ export declare abstract class BaseRequestPolicy implements RequestPolicy {
     /**
      * The options that can be passed to a given request policy.
      */
-    _options: RequestPolicyOptionsLike);
+    _options: RequestPolicyOptions);
     /**
      * Sends a network request based on the given web resource.
      * @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
      */
-    abstract sendRequest(webResource: WebResourceLike): Promise<CompatResponse>;
+    abstract sendRequest(webResource: WebResource): Promise<HttpOperationResponse>;
     /**
      * Get whether or not a log with the provided log level should be logged.
      * @param logLevel - The log level of the log that will be logged.
@@ -327,7 +328,7 @@ declare abstract class Credential_2 implements RequestPolicyFactory {
      * @param _nextPolicy -
      * @param _options -
      */
-    create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptionsLike): RequestPolicy;
+    create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
 }
 export { Credential_2 as Credential }
 
@@ -341,20 +342,20 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
      *
      * @param request -
      */
-    sendRequest(request: WebResourceLike): Promise<CompatResponse>;
+    sendRequest(request: WebResource): Promise<HttpOperationResponse>;
     /**
      * Child classes must implement this method with request signing. This method
      * will be executed in {@link sendRequest}.
      *
      * @param request -
      */
-    protected signRequest(request: WebResourceLike): WebResourceLike;
+    protected signRequest(request: WebResource): WebResource;
 }
 
 /**
  * A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
  */
-export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike) => CredentialPolicy;
+export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy;
 
 /** The object returned in the QueueMessageList array when calling Get Messages on a Queue. */
 export declare interface DequeuedMessageItem {
@@ -429,6 +430,12 @@ export declare interface GeoReplication {
 /** Defines values for GeoReplicationStatusType. */
 export declare type GeoReplicationStatusType = "live" | "bootstrap" | "unavailable";
 
+export { HttpHeaders }
+
+export { HttpOperationResponse }
+
+export { HttpRequestBody }
+
 /**
  * A representation of an HTTP response that
  * includes a reference to the request that
@@ -438,11 +445,11 @@ export declare interface HttpResponse {
     /**
      * The headers from the response.
      */
-    headers: HttpHeadersLike;
+    headers: HttpHeaders;
     /**
      * The original request that resulted in this response.
      */
-    request: WebResourceLike;
+    request: WebResource;
     /**
      * The HTTP status code returned from the service.
      */
@@ -2009,6 +2016,13 @@ export declare type QueueUpdateMessageResponse = MessageIdUpdateResponse;
  */
 export declare type ReceivedMessageItem = DequeuedMessageItem;
 
+export { RequestPolicy as IHttpClient }
+export { RequestPolicy }
+
+export { RequestPolicyFactory }
+
+export { RequestPolicyOptions }
+
 /**
  * An object with a simple _response property.
  */
@@ -2484,13 +2498,13 @@ export declare class StorageBrowserPolicy extends BaseRequestPolicy {
      * @param nextPolicy -
      * @param options -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
     /**
      * Sends out request.
      *
      * @param request -
      */
-    sendRequest(request: WebResourceLike): Promise<CompatResponse>;
+    sendRequest(request: WebResource): Promise<HttpOperationResponse>;
 }
 
 /**
@@ -2503,7 +2517,7 @@ export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageBrowserPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy;
 }
 
 /**
@@ -2554,6 +2568,11 @@ declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedSer
     endpoint?: string;
 }
 
+/**
+ * The OAuth scope to use with Azure Storage.
+ */
+export declare const StorageOAuthScopes: string | string[];
+
 /**
  * Options interface for the {@link newPipeline} function.
  */
@@ -2643,13 +2662,13 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
      * @param options -
      * @param retryOptions -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, retryOptions?: StorageRetryOptions);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryOptions?: StorageRetryOptions);
     /**
      * Sends request.
      *
      * @param request -
      */
-    sendRequest(request: WebResourceLike): Promise<CompatResponse>;
+    sendRequest(request: WebResource): Promise<HttpOperationResponse>;
     /**
      * Decide and perform next retry. Won't mutate request parameter.
      *
@@ -2660,7 +2679,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
      * @param attempt -           How many retries has been attempted to performed, starting from 1, which includes
      *                                   the attempt will be performed by this method call.
      */
-    protected attemptSendRequest(request: WebResourceLike, secondaryHas404: boolean, attempt: number): Promise<CompatResponse>;
+    protected attemptSendRequest(request: WebResource, secondaryHas404: boolean, attempt: number): Promise<HttpOperationResponse>;
     /**
      * Decide whether to retry according to last HTTP response and retry counters.
      *
@@ -2669,7 +2688,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
      * @param response -
      * @param err -
      */
-    protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: CompatResponse, err?: RestError): boolean;
+    protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: HttpOperationResponse, err?: RestError): boolean;
     /**
      * Delay a calculated time between retries.
      *
@@ -2696,7 +2715,7 @@ export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageRetryPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy;
 }
 
 /**
@@ -2739,7 +2758,7 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageSharedKeyCredentialPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageSharedKeyCredentialPolicy;
     /**
      * Generates a hash signature for an HTTP request or for a SAS.
      *
@@ -2762,13 +2781,13 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
      * @param options -
      * @param factory -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, factory: StorageSharedKeyCredential);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, factory: StorageSharedKeyCredential);
     /**
      * Signs request.
      *
      * @param request -
      */
-    protected signRequest(request: WebResourceLike): WebResourceLike;
+    protected signRequest(request: WebResource): WebResource;
     /**
      * Retrieve header value according to shared key sign rules.
      * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
@@ -2799,6 +2818,8 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
     private getCanonicalizedResourceString;
 }
 
+export { WebResource }
+
 /**
  * A type that represents an operation result with a known _response property.
  */