ServiceURL class
A ServiceURL represents a URL to the Azure Storage Queue service allowing you to manipulate queues.
- Extends
Constructors
| ServiceURL(string, Pipeline) | Creates an instance of ServiceURL. |
Inherited Properties
| url | URL string value. |
Methods
| get |
Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. See https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties |
| get |
Retrieves statistics related to replication for the Queue service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. See https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats |
| list |
Returns a list of the queues under the specified account. See https://docs.microsoft.com/en-us/rest/api/storageservices/list-queues1 |
| set |
Sets properties for a storage account’s Queue service endpoint, including properties for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings. See https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties |
| with |
Creates a new ServiceURL object identical to the source but with the specified request policy pipeline. |
Inherited Methods
| new |
A static method used to create a new Pipeline object with Credential provided. |
Constructor Details
ServiceURL(string, Pipeline)
Creates an instance of ServiceURL.
new ServiceURL(url: string, pipeline: Pipeline)Parameters
- url
-
string
A URL string pointing to Azure Storage queue service, such as "https://myaccount.queue.core.windows.net". You can append a SAS if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net?sasString".
- pipeline
- Pipeline
Call StorageURL.newPipeline() to create a default pipeline, or provide a customized pipeline.
Inherited Property Details
url
Method Details
getProperties(Aborter)
Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
See https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
function getProperties(aborter: Aborter): Promise<ServiceGetPropertiesResponse>Parameters
- aborter
- Aborter
Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation
Returns
Promise<ServiceGetPropertiesResponse>
getStatistics(Aborter)
Retrieves statistics related to replication for the Queue service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.
See https://docs.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
function getStatistics(aborter: Aborter): Promise<ServiceGetStatisticsResponse>Parameters
- aborter
- Aborter
Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation
Returns
Promise<ServiceGetStatisticsResponse>
listQueuesSegment(Aborter, string, IServiceListQueuesSegmentOptions)
Returns a list of the queues under the specified account.
See https://docs.microsoft.com/en-us/rest/api/storageservices/list-queues1
function listQueuesSegment(aborter: Aborter, marker?: string, options?: IServiceListQueuesSegmentOptions): Promise<ServiceListQueuesSegmentResponse>Parameters
- aborter
- Aborter
Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation
- marker
-
string
A string value that identifies the portion of the list of queues to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all queues remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.
- options
- IServiceListQueuesSegmentOptions
Returns
Promise<ServiceListQueuesSegmentResponse>
setProperties(Aborter, StorageServiceProperties)
Sets properties for a storage account’s Queue service endpoint, including properties for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
See https://docs.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties
function setProperties(aborter: Aborter, properties: StorageServiceProperties): Promise<ServiceSetPropertiesResponse>Parameters
- aborter
- Aborter
Create a new Aborter instance with Aborter.none or Aborter.timeout(), goto documents of Aborter for more examples about request cancellation
- properties
- StorageServiceProperties
Returns
Promise<ServiceSetPropertiesResponse>
withPipeline(Pipeline)
Creates a new ServiceURL object identical to the source but with the specified request policy pipeline.
function withPipeline(pipeline: Pipeline): ServiceURLParameters
- pipeline
- Pipeline
Returns
Inherited Method Details
newPipeline(Credential, INewPipelineOptions)
A static method used to create a new Pipeline object with Credential provided.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineParameters
- credential
- Credential
Such as AnonymousCredential, SharedKeyCredential or TokenCredential.
- pipelineOptions
- INewPipelineOptions
Optional. Options.
Returns
A new Pipeline object.
Inherited From StorageURL.newPipeline
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for