Volume class
Class representing a Volume.
Constructors
| Volume(Service |
Create a Volume. |
Methods
Constructor Details
Volume(ServiceFabricMeshManagementClientContext)
Create a Volume.
new Volume(client: ServiceFabricMeshManagementClientContext)Parameters
Reference to the service client.
Method Details
create(string, string, VolumeResourceDescription, RequestOptionsBase)
Creates a volume resource with the specified name, description and properties. If a volume resource with the same name exists, then it is updated with the specified description and properties.
function create(resourceGroupName: string, volumeResourceName: string, volumeResourceDescription: VolumeResourceDescription, options?: RequestOptionsBase): Promise<VolumeCreateResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- volumeResourceDescription
- VolumeResourceDescription
Description for creating a Volume resource.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<VolumeCreateResponse>
Promise<Models.VolumeCreateResponse>
create(string, string, VolumeResourceDescription, RequestOptionsBase, ServiceCallback<VolumeResourceDescription>)
function create(resourceGroupName: string, volumeResourceName: string, volumeResourceDescription: VolumeResourceDescription, options: RequestOptionsBase, callback: ServiceCallback<VolumeResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- volumeResourceDescription
- VolumeResourceDescription
Description for creating a Volume resource.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
create(string, string, VolumeResourceDescription, ServiceCallback<VolumeResourceDescription>)
function create(resourceGroupName: string, volumeResourceName: string, volumeResourceDescription: VolumeResourceDescription, callback: ServiceCallback<VolumeResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- volumeResourceDescription
- VolumeResourceDescription
Description for creating a Volume resource.
- callback
The callback
deleteMethod(string, string, RequestOptionsBase)
Deletes the volume resource identified by the name.
function deleteMethod(resourceGroupName: string, volumeResourceName: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, volumeResourceName: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, volumeResourceName: string, callback: ServiceCallback<void>)Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- callback
-
ServiceCallback<void>
The callback
get(string, string, RequestOptionsBase)
Gets the information about the volume resource with the given name. The information include the description and other properties of the volume.
function get(resourceGroupName: string, volumeResourceName: string, options?: RequestOptionsBase): Promise<VolumeGetResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<VolumeGetResponse>
Promise<Models.VolumeGetResponse>
get(string, string, RequestOptionsBase, ServiceCallback<VolumeResourceDescription>)
function get(resourceGroupName: string, volumeResourceName: string, options: RequestOptionsBase, callback: ServiceCallback<VolumeResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
get(string, string, ServiceCallback<VolumeResourceDescription>)
function get(resourceGroupName: string, volumeResourceName: string, callback: ServiceCallback<VolumeResourceDescription>)Parameters
- resourceGroupName
-
string
Azure resource group name
- volumeResourceName
-
string
The identity of the volume.
- callback
The callback
listByResourceGroup(string, RequestOptionsBase)
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.
function listByResourceGroup(resourceGroupName: string, options?: RequestOptionsBase): Promise<VolumeListByResourceGroupResponse>Parameters
- resourceGroupName
-
string
Azure resource group name
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<VolumeListByResourceGroupResponse>
Promise<Models.VolumeListByResourceGroupResponse>
listByResourceGroup(string, RequestOptionsBase, ServiceCallback<VolumeResourceDescriptionList>)
function listByResourceGroup(resourceGroupName: string, options: RequestOptionsBase, callback: ServiceCallback<VolumeResourceDescriptionList>)Parameters
- resourceGroupName
-
string
Azure resource group name
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listByResourceGroup(string, ServiceCallback<VolumeResourceDescriptionList>)
function listByResourceGroup(resourceGroupName: string, callback: ServiceCallback<VolumeResourceDescriptionList>)Parameters
- resourceGroupName
-
string
Azure resource group name
- callback
The callback
listByResourceGroupNext(string, RequestOptionsBase)
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.
function listByResourceGroupNext(nextPageLink: string, options?: RequestOptionsBase): Promise<VolumeListByResourceGroupNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.VolumeListByResourceGroupNextResponse>
listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<VolumeResourceDescriptionList>)
function listByResourceGroupNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<VolumeResourceDescriptionList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listByResourceGroupNext(string, ServiceCallback<VolumeResourceDescriptionList>)
function listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback<VolumeResourceDescriptionList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
listBySubscription(RequestOptionsBase)
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.
function listBySubscription(options?: RequestOptionsBase): Promise<VolumeListBySubscriptionResponse>Parameters
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<VolumeListBySubscriptionResponse>
Promise<Models.VolumeListBySubscriptionResponse>
listBySubscription(RequestOptionsBase, ServiceCallback<VolumeResourceDescriptionList>)
function listBySubscription(options: RequestOptionsBase, callback: ServiceCallback<VolumeResourceDescriptionList>)Parameters
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listBySubscription(ServiceCallback<VolumeResourceDescriptionList>)
function listBySubscription(callback: ServiceCallback<VolumeResourceDescriptionList>)Parameters
- callback
The callback
listBySubscriptionNext(string, RequestOptionsBase)
Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.
function listBySubscriptionNext(nextPageLink: string, options?: RequestOptionsBase): Promise<VolumeListBySubscriptionNextResponse>Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<VolumeListBySubscriptionNextResponse>
Promise<Models.VolumeListBySubscriptionNextResponse>
listBySubscriptionNext(string, RequestOptionsBase, ServiceCallback<VolumeResourceDescriptionList>)
function listBySubscriptionNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<VolumeResourceDescriptionList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listBySubscriptionNext(string, ServiceCallback<VolumeResourceDescriptionList>)
function listBySubscriptionNext(nextPageLink: string, callback: ServiceCallback<VolumeResourceDescriptionList>)Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback