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. |
Methods
| get |
Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. |
| 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. |
| list |
Returns a list of the queues under the specified account. |
| new |
A static method used to create a new Pipeline object with Credential provided. |
| 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. |
| with |
Creates a new ServiceURL object identical to the source but with the specified request policy pipeline. |
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.
Property Details
pipeline
url
URL string value.
url: stringProperty Value
string
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.
function getProperties(aborter: Aborter)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<Models.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.
function getStatistics(aborter: Aborter)Parameters
- aborter
- Aborter
Returns
Promise<Models.ServiceGetStatisticsResponse>
listQueuesSegment(Aborter, undefined | string, IServiceListQueuesSegmentOptions)
Returns a list of the queues under the specified account.
function listQueuesSegment(aborter: Aborter, marker?: undefined | string, options?: IServiceListQueuesSegmentOptions)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
-
undefined | string
- options
- IServiceListQueuesSegmentOptions
Returns
Promise<Models.ServiceListQueuesSegmentResponse>
newPipeline(Credential, INewPipelineOptions)
A static method used to create a new Pipeline object with Credential provided.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)Parameters
- credential
- Credential
Such as AnonymousCredential, SharedKeyCredential or TokenCredential.
- pipelineOptions
- INewPipelineOptions
Returns
A new Pipeline object.
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.
function setProperties(aborter: Aborter, properties: StorageServiceProperties)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<Models.ServiceSetPropertiesResponse>
withPipeline(Pipeline)
Creates a new ServiceURL object identical to the source but with the specified request policy pipeline.
function withPipeline(pipeline: Pipeline)Parameters
- pipeline
- Pipeline
