Disks | @azure/arm-compute

Interface representing a Disks.

Hierarchy

Disks

Implemented by

DisksImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, diskName: string, disk: Disk, options?: DisksCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DisksCreateOrUpdateResponse>, DisksCreateOrUpdateResponse>>

- Defined in operationsInterfaces/disks.ts:56
Creates or updates a 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.
- Optional options: DisksCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DisksCreateOrUpdateResponse>, DisksCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, diskName: string, disk: Disk, options?: DisksCreateOrUpdateOptionalParams): Promise<DisksCreateOrUpdateResponse>

- Defined in operationsInterfaces/disks.ts:76
Creates or updates a 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.
- Optional options: DisksCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<DisksCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, diskName: string, options?: DisksDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/disks.ts:135
Deletes a 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.
- Optional options: DisksDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, diskName: string, options?: DisksDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/disks.ts:148
Deletes a 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.
- Optional options: DisksDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginGrantAccess

beginGrantAccess(resourceGroupName: string, diskName: string, grantAccessData: GrantAccessData, options?: DisksGrantAccessOptionalParams): Promise<PollerLike<PollOperationState<DisksGrantAccessResponse>, DisksGrantAccessResponse>>

- Defined in operationsInterfaces/disks.ts:162
Grants access to a 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.
- grantAccessData: GrantAccessData
  
  Access data object supplied in the body of the get disk access operation.
- Optional options: DisksGrantAccessOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DisksGrantAccessResponse>, DisksGrantAccessResponse>>

beginGrantAccessAndWait

beginGrantAccessAndWait(resourceGroupName: string, diskName: string, grantAccessData: GrantAccessData, options?: DisksGrantAccessOptionalParams): Promise<DisksGrantAccessResponse>

- Defined in operationsInterfaces/disks.ts:182
Grants access to a 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.
- grantAccessData: GrantAccessData
  
  Access data object supplied in the body of the get disk access operation.
- Optional options: DisksGrantAccessOptionalParams
  
  The options parameters.
Returns Promise<DisksGrantAccessResponse>

beginRevokeAccess

beginRevokeAccess(resourceGroupName: string, diskName: string, options?: DisksRevokeAccessOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/disks.ts:196
Revokes access to a 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.
- Optional options: DisksRevokeAccessOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRevokeAccessAndWait

beginRevokeAccessAndWait(resourceGroupName: string, diskName: string, options?: DisksRevokeAccessOptionalParams): Promise<void>

- Defined in operationsInterfaces/disks.ts:209
Revokes access to a 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.
- Optional options: DisksRevokeAccessOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, diskName: string, disk: DiskUpdate, options?: DisksUpdateOptionalParams): Promise<PollerLike<PollOperationState<DisksUpdateResponse>, DisksUpdateResponse>>

- Defined in operationsInterfaces/disks.ts:91
Updates (patches) a 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.
- Optional options: DisksUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<DisksUpdateResponse>, DisksUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, diskName: string, disk: DiskUpdate, options?: DisksUpdateOptionalParams): Promise<DisksUpdateResponse>

- Defined in operationsInterfaces/disks.ts:108
Updates (patches) a 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.
- Optional options: DisksUpdateOptionalParams
  
  The options parameters.
Returns Promise<DisksUpdateResponse>

get

get(resourceGroupName: string, diskName: string, options?: DisksGetOptionalParams): Promise<DisksGetResponse>

- Defined in operationsInterfaces/disks.ts:122
Gets information about a 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.
- Optional options: DisksGetOptionalParams
  
  The options parameters.
Returns Promise<DisksGetResponse>

list

list(options?: DisksListOptionalParams): PagedAsyncIterableIterator<Disk>

- Defined in operationsInterfaces/disks.ts:46
Lists all the disks under a subscription.

Parameters
- Optional options: DisksListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Disk>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: DisksListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Disk>

- Defined in operationsInterfaces/disks.ts:38
Lists all the disks under a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: DisksListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Disk>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

diskName: string

disk: Disk

Optional options: DisksCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DisksCreateOrUpdateResponse>, DisksCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

diskName: string

disk: Disk

Optional options: DisksCreateOrUpdateOptionalParams

Returns Promise<DisksCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

diskName: string

Optional options: DisksDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

diskName: string

Optional options: DisksDeleteOptionalParams

Returns Promise<void>

beginGrantAccess

Parameters

resourceGroupName: string

diskName: string

grantAccessData: GrantAccessData

Optional options: DisksGrantAccessOptionalParams

Returns Promise<PollerLike<PollOperationState<DisksGrantAccessResponse>, DisksGrantAccessResponse>>

beginGrantAccessAndWait

Parameters

resourceGroupName: string

diskName: string

grantAccessData: GrantAccessData

Optional options: DisksGrantAccessOptionalParams

Returns Promise<DisksGrantAccessResponse>

beginRevokeAccess

Parameters

resourceGroupName: string

diskName: string

Optional options: DisksRevokeAccessOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRevokeAccessAndWait

Parameters

resourceGroupName: string

diskName: string

Optional options: DisksRevokeAccessOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

diskName: string

disk: DiskUpdate

Optional options: DisksUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<DisksUpdateResponse>, DisksUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

diskName: string

disk: DiskUpdate

Optional options: DisksUpdateOptionalParams

Returns Promise<DisksUpdateResponse>

get

Parameters

resourceGroupName: string

diskName: string

Optional options: DisksGetOptionalParams

Returns Promise<DisksGetResponse>

list

Parameters

Optional options: DisksListOptionalParams