Disks interface
Interface representing a Disks.
Methods
Method Details
beginCreateOrUpdate(string, string, Disk, DisksCreateOrUpdateOptionalParams)
Creates or updates a disk.
function beginCreateOrUpdate(resourceGroupName: string, diskName: string, disk: Disk, options?: DisksCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Disk>, Disk>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- disk
- Disk
Disk object supplied in the body of the Put disk operation.
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<Disk>, Disk>>
beginCreateOrUpdateAndWait(string, string, Disk, DisksCreateOrUpdateOptionalParams)
Creates or updates a disk.
function beginCreateOrUpdateAndWait(resourceGroupName: string, diskName: string, disk: Disk, options?: DisksCreateOrUpdateOptionalParams): Promise<Disk>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- disk
- Disk
Disk object supplied in the body of the Put disk operation.
The options parameters.
Returns
Promise<Disk>
beginDelete(string, string, DisksDeleteOptionalParams)
Deletes a disk.
function beginDelete(resourceGroupName: string, diskName: string, options?: DisksDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- options
- DisksDeleteOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, DisksDeleteOptionalParams)
Deletes a disk.
function beginDeleteAndWait(resourceGroupName: string, diskName: string, options?: DisksDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- options
- DisksDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginGrantAccess(string, string, GrantAccessData, DisksGrantAccessOptionalParams)
Grants access to a disk.
function beginGrantAccess(resourceGroupName: string, diskName: string, grantAccessData: GrantAccessData, options?: DisksGrantAccessOptionalParams): Promise<SimplePollerLike<OperationState<AccessUri>, AccessUri>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- grantAccessData
- GrantAccessData
Access data object supplied in the body of the get disk access operation.
- options
- DisksGrantAccessOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<AccessUri>, AccessUri>>
beginGrantAccessAndWait(string, string, GrantAccessData, DisksGrantAccessOptionalParams)
Grants access to a disk.
function beginGrantAccessAndWait(resourceGroupName: string, diskName: string, grantAccessData: GrantAccessData, options?: DisksGrantAccessOptionalParams): Promise<AccessUri>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- grantAccessData
- GrantAccessData
Access data object supplied in the body of the get disk access operation.
- options
- DisksGrantAccessOptionalParams
The options parameters.
Returns
Promise<AccessUri>
beginRevokeAccess(string, string, DisksRevokeAccessOptionalParams)
Revokes access to a disk.
function beginRevokeAccess(resourceGroupName: string, diskName: string, options?: DisksRevokeAccessOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- options
- DisksRevokeAccessOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<void>, void>>
beginRevokeAccessAndWait(string, string, DisksRevokeAccessOptionalParams)
Revokes access to a disk.
function beginRevokeAccessAndWait(resourceGroupName: string, diskName: string, options?: DisksRevokeAccessOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- options
- DisksRevokeAccessOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, DiskUpdate, DisksUpdateOptionalParams)
Updates (patches) a disk.
function beginUpdate(resourceGroupName: string, diskName: string, disk: DiskUpdate, options?: DisksUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Disk>, Disk>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- disk
- DiskUpdate
Disk object supplied in the body of the Patch disk operation.
- options
- DisksUpdateOptionalParams
The options parameters.
Returns
Promise<SimplePollerLike<OperationState<Disk>, Disk>>
beginUpdateAndWait(string, string, DiskUpdate, DisksUpdateOptionalParams)
Updates (patches) a disk.
function beginUpdateAndWait(resourceGroupName: string, diskName: string, disk: DiskUpdate, options?: DisksUpdateOptionalParams): Promise<Disk>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- disk
- DiskUpdate
Disk object supplied in the body of the Patch disk operation.
- options
- DisksUpdateOptionalParams
The options parameters.
Returns
Promise<Disk>
get(string, string, DisksGetOptionalParams)
Gets information about a disk.
function get(resourceGroupName: string, diskName: string, options?: DisksGetOptionalParams): Promise<Disk>Parameters
- resourceGroupName
-
string
The name of the resource group.
- diskName
-
string
The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
- options
- DisksGetOptionalParams
The options parameters.
Returns
Promise<Disk>
list(DisksListOptionalParams)
Lists all the disks under a subscription.
function list(options?: DisksListOptionalParams): PagedAsyncIterableIterator<Disk, Disk[], PageSettings>Parameters
- options
- DisksListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, DisksListByResourceGroupOptionalParams)
Lists all the disks under a resource group.
function listByResourceGroup(resourceGroupName: string, options?: DisksListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Disk, Disk[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.