Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Volume

Package version

Class representing a Volume.

Hierarchy

  • Volume

Index

Constructors

Methods

Constructors

constructor

Methods

create

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

    summary

    Creates or updates a volume resource.

    Parameters

    • resourceGroupName: string

      Azure resource group name

    • volumeResourceName: string

      The identity of the volume.

    • volumeResourceDescription: VolumeResourceDescription

      Description for creating a Volume resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VolumeCreateResponse>

    Promise<Models.VolumeCreateResponse>

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • volumeResourceName: string

      The identity of the volume.

    • volumeResourceDescription: VolumeResourceDescription

      Description for creating a Volume resource.

    • callback: msRest.ServiceCallback<VolumeResourceDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • 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(resourceGroupName: string, volumeResourceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, volumeResourceName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, volumeResourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes the volume resource identified by the name.

    summary

    Deletes the volume resource.

    Parameters

    • resourceGroupName: string

      Azure resource group name

    • volumeResourceName: string

      The identity of the volume.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • volumeResourceName: string

      The identity of the volume.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • volumeResourceName: string

      The identity of the volume.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

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

  • 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

    • resourceGroupName: string

      Azure resource group name

    • volumeResourceName: string

      The identity of the volume.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VolumeGetResponse>

    Promise<Models.VolumeGetResponse>

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • volumeResourceName: string

      The identity of the volume.

    • callback: msRest.ServiceCallback<VolumeResourceDescription>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • volumeResourceName: string

      The identity of the volume.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<VolumeResourceDescription>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.VolumeListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<VolumeResourceDescriptionList>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VolumeResourceDescriptionList>): void

  • Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.

    summary

    Gets all the volume resources in a given resource group.

    Parameters

    • resourceGroupName: string

      Azure resource group name

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VolumeListByResourceGroupResponse>

    Promise<Models.VolumeListByResourceGroupResponse>

  • Parameters

    Returns void

  • Parameters

    • resourceGroupName: string

      Azure resource group name

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<VolumeResourceDescriptionList>

      The callback

    Returns void

listByResourceGroupNext

  • listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VolumeListByResourceGroupNextResponse>
  • listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<VolumeResourceDescriptionList>): void
  • listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VolumeResourceDescriptionList>): void

  • Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.

    summary

    Gets all the volume resources in a given resource group.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VolumeListByResourceGroupNextResponse>

    Promise<Models.VolumeListByResourceGroupNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<VolumeResourceDescriptionList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<VolumeResourceDescriptionList>

      The callback

    Returns void

listBySubscription

  • listBySubscription(options?: msRest.RequestOptionsBase): Promise<Models.VolumeListBySubscriptionResponse>
  • listBySubscription(callback: msRest.ServiceCallback<VolumeResourceDescriptionList>): void
  • listBySubscription(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VolumeResourceDescriptionList>): void

  • Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.

    summary

    Gets all the volume resources in a given subscription.

    Parameters

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VolumeListBySubscriptionResponse>

    Promise<Models.VolumeListBySubscriptionResponse>

  • Parameters

    Returns void

  • Parameters

    Returns void

listBySubscriptionNext

  • listBySubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VolumeListBySubscriptionNextResponse>
  • listBySubscriptionNext(nextPageLink: string, callback: msRest.ServiceCallback<VolumeResourceDescriptionList>): void
  • listBySubscriptionNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VolumeResourceDescriptionList>): void

  • Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.

    summary

    Gets all the volume resources in a given subscription.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.VolumeListBySubscriptionNextResponse>

    Promise<Models.VolumeListBySubscriptionNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<VolumeResourceDescriptionList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<VolumeResourceDescriptionList>

      The callback

    Returns void

Generated using TypeDoc