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.

Inherited Properties

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. See https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-service-properties}
listSharesSegment(Aborter, 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.
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. See https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-service-properties}
withPipeline(Pipeline)	Creates a new ServiceURL object identical to the source but with the specified request policy pipeline.

Inherited Methods

newPipeline(Credential, INewPipelineOptions)

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 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.

Inherited Property Details

url

URL string value.

url: string

Property Value

string

Inherited From StorageURL.url

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.

See https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-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>

listSharesSegment(Aborter, 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?: string, options?: IServiceListSharesSegmentOptions): Promise<ServiceListSharesSegmentResponse>

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 to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.

options

IServiceListSharesSegmentOptions

Returns

Promise<ServiceListSharesSegmentResponse>

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.

See https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-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): ServiceURL

Parameters

pipeline

Pipeline

Returns

ServiceURL

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): Pipeline

Parameters

credential

Credential

Such as AnonymousCredential, SharedKeyCredential.

pipelineOptions

INewPipelineOptions

Optional. Options.

Returns

Pipeline

A new Pipeline object.

Inherited From StorageURL.newPipeline