ServiceURL class

Package:

@azure/storage-file

A ServiceURL represents a URL to the Azure Storage File service allowing you to manipulate file shares.

Extends

StorageURL

Constructors

ServiceURL(string, Pipeline)

Creates an instance of ServiceURL.

Properties

pipeline	Request policy pipeline.
url	URL string value.

Methods

getProperties(Aborter)	Gets the properties of a storage account’s file service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
listSharesSegment(Aborter, undefined | string, IServiceListSharesSegmentOptions)	Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.
newPipeline(Credential, INewPipelineOptions)	A static method used to create a new Pipeline object with Credential provided.
setProperties(Aborter, StorageServiceProperties)	Sets properties for a storage account’s file service endpoint, including properties for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
withPipeline(Pipeline)	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 file service, such as "https://myaccount.file.core.windows.net". You can Append a SAS if using AnonymousCredential, such as "https://myaccount.file.core.windows.net?sasString".

pipeline

Pipeline

Call StorageURL.newPipeline() to create a default pipeline, or provide a customized pipeline.

Property Details

pipeline

Request policy pipeline.

pipeline: Pipeline

Property Value

Pipeline

url

URL string value.

url: string

Property Value

string

Method Details

getProperties(Aborter)

Gets the properties of a storage account’s file 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>

listSharesSegment(Aborter, undefined | string, IServiceListSharesSegmentOptions)

Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.

function listSharesSegment(aborter: Aborter, marker?: undefined | string, options?: IServiceListSharesSegmentOptions)

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

IServiceListSharesSegmentOptions

Returns

Promise<Models.ServiceListSharesSegmentResponse>

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.

pipelineOptions

INewPipelineOptions

Returns

Pipeline

A new Pipeline object.

setProperties(Aborter, StorageServiceProperties)

Sets properties for a storage account’s file 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

Returns

ServiceURL