MeshVolume | @azure/servicefabric

Class representing a MeshVolume.

Hierarchy

MeshVolume

Index

Constructors

constructor

Methods

Constructors

constructor

new MeshVolume(client: ServiceFabricClientContext): MeshVolume

- Defined in operations/meshVolume.ts:19
Create a MeshVolume.

Parameters
- client: ServiceFabricClientContext
  
  Reference to the service client.
Returns MeshVolume

Methods

createOrUpdate

createOrUpdate(volumeResourceName: string, volumeResourceDescription: VolumeResourceDescription, options?: msRest.RequestOptionsBase): Promise<Models.MeshVolumeCreateOrUpdateResponse>
createOrUpdate(volumeResourceName: string, volumeResourceDescription: VolumeResourceDescription, callback: msRest.ServiceCallback<VolumeResourceDescription>): void
createOrUpdate(volumeResourceName: string, volumeResourceDescription: VolumeResourceDescription, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VolumeResourceDescription>): void

- Defined in operations/meshVolume.ts:39
Creates a Volume resource with the specified name, description and properties. If Volume resource with the same name exists, then it is updated with the specified description and properties.

summary

Creates or updates a Volume resource.

Parameters
- volumeResourceName: string
  
  The identity of the volume.
- volumeResourceDescription: VolumeResourceDescription
  
  Description for creating a Volume resource.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshVolumeCreateOrUpdateResponse>

Promise<Models.MeshVolumeCreateOrUpdateResponse>
- Defined in operations/meshVolume.ts:45
Parameters
- volumeResourceName: string
  
  The identity of the volume.
- volumeResourceDescription: VolumeResourceDescription
  
  Description for creating a Volume resource.
- callback: msRest.ServiceCallback<VolumeResourceDescription>
  
  The callback
Returns void
- Defined in operations/meshVolume.ts:52
Parameters
- volumeResourceName: string
  
  The identity of the volume.
- volumeResourceDescription: VolumeResourceDescription
  
  Description for creating a Volume resource.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VolumeResourceDescription>
  
  The callback
Returns void

deleteMethod

deleteMethod(volumeResourceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
deleteMethod(volumeResourceName: string, callback: msRest.ServiceCallback<void>): void
deleteMethod(volumeResourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/meshVolume.ts:101
Deletes the Volume resource identified by the name.

summary

Deletes the Volume resource.

Parameters
- volumeResourceName: string
  
  The identity of the volume.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/meshVolume.ts:106
Parameters
- volumeResourceName: string
  
  The identity of the volume.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/meshVolume.ts:112
Parameters
- volumeResourceName: string
  
  The identity of the volume.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

get

get(volumeResourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.MeshVolumeGetResponse>
get(volumeResourceName: string, callback: msRest.ServiceCallback<VolumeResourceDescription>): void
get(volumeResourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VolumeResourceDescription>): void

- Defined in operations/meshVolume.ts:72
Gets the information about the Volume resource with the given name. The information include the description and other properties of the Volume.

summary

Gets the Volume resource with the given name.

Parameters
- volumeResourceName: string
  
  The identity of the volume.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshVolumeGetResponse>

Promise<Models.MeshVolumeGetResponse>
- Defined in operations/meshVolume.ts:77
Parameters
- volumeResourceName: string
  
  The identity of the volume.
- callback: msRest.ServiceCallback<VolumeResourceDescription>
  
  The callback
Returns void
- Defined in operations/meshVolume.ts:83
Parameters
- volumeResourceName: string
  
  The identity of the volume.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VolumeResourceDescription>
  
  The callback
Returns void

list

list(options?: msRest.RequestOptionsBase): Promise<Models.MeshVolumeListResponse>
list(callback: msRest.ServiceCallback<PagedVolumeResourceDescriptionList>): void
list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<PagedVolumeResourceDescriptionList>): void

- Defined in operations/meshVolume.ts:130
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.

summary

Lists all the volume resources.

Parameters
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.MeshVolumeListResponse>

Promise<Models.MeshVolumeListResponse>
- Defined in operations/meshVolume.ts:134
Parameters
- callback: msRest.ServiceCallback<PagedVolumeResourceDescriptionList>
  
  The callback
Returns void
- Defined in operations/meshVolume.ts:139
Parameters
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<PagedVolumeResourceDescriptionList>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ServiceFabricClientContext

Returns MeshVolume

Methods

createOrUpdate

Parameters

volumeResourceName: string

volumeResourceDescription: VolumeResourceDescription

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshVolumeCreateOrUpdateResponse>

Parameters

volumeResourceName: string

volumeResourceDescription: VolumeResourceDescription

callback: msRest.ServiceCallback<VolumeResourceDescription>

Returns void

Parameters

volumeResourceName: string

volumeResourceDescription: VolumeResourceDescription

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<VolumeResourceDescription>

Returns void

deleteMethod

Parameters

volumeResourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

Parameters

volumeResourceName: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

volumeResourceName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<void>

Returns void

get

Parameters

volumeResourceName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshVolumeGetResponse>

Parameters

volumeResourceName: string

callback: msRest.ServiceCallback<VolumeResourceDescription>

Returns void

Parameters

volumeResourceName: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<VolumeResourceDescription>

Returns void

list

Parameters

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.MeshVolumeListResponse>

Parameters

callback: msRest.ServiceCallback<PagedVolumeResourceDescriptionList>

Returns void

Parameters

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<PagedVolumeResourceDescriptionList>

Returns void