ImagesImpl | @azure/arm-compute

Class containing Images operations.

Hierarchy

ImagesImpl

Implements

Images

Index

Constructors

constructor

Methods

Constructors

constructor

new ImagesImpl(client: ComputeManagementClientContext): ImagesImpl

- Defined in operations/images.ts:41
Initialize a new instance of the class Images class.

Parameters
- client: ComputeManagementClientContext
  
  Reference to the service client
Returns ImagesImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, imageName: string, parameters: Image, options?: ImagesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ImagesCreateOrUpdateResponse>, ImagesCreateOrUpdateResponse>>

Implementation of Images.beginCreateOrUpdate
- Defined in operations/images.ts:154
Create or update an image.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- imageName: string
  
  The name of the image.
- parameters: Image
  
  Parameters supplied to the Create Image operation.
- Optional options: ImagesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ImagesCreateOrUpdateResponse>, ImagesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, imageName: string, parameters: Image, options?: ImagesCreateOrUpdateOptionalParams): Promise<ImagesCreateOrUpdateResponse>

Implementation of Images.beginCreateOrUpdateAndWait
- Defined in operations/images.ts:222
Create or update an image.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- imageName: string
  
  The name of the image.
- parameters: Image
  
  Parameters supplied to the Create Image operation.
- Optional options: ImagesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ImagesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, imageName: string, options?: ImagesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Images.beginDelete
- Defined in operations/images.ts:330
Deletes an Image.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- imageName: string
  
  The name of the image.
- Optional options: ImagesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, imageName: string, options?: ImagesDeleteOptionalParams): Promise<void>

Implementation of Images.beginDeleteAndWait
- Defined in operations/images.ts:391
Deletes an Image.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- imageName: string
  
  The name of the image.
- Optional options: ImagesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, imageName: string, parameters: ImageUpdate, options?: ImagesUpdateOptionalParams): Promise<PollerLike<PollOperationState<ImagesUpdateResponse>, ImagesUpdateResponse>>

Implementation of Images.beginUpdate
- Defined in operations/images.ts:244
Update an image.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- imageName: string
  
  The name of the image.
- parameters: ImageUpdate
  
  Parameters supplied to the Update Image operation.
- Optional options: ImagesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ImagesUpdateResponse>, ImagesUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, imageName: string, parameters: ImageUpdate, options?: ImagesUpdateOptionalParams): Promise<ImagesUpdateResponse>

Implementation of Images.beginUpdateAndWait
- Defined in operations/images.ts:309
Update an image.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- imageName: string
  
  The name of the image.
- parameters: ImageUpdate
  
  Parameters supplied to the Update Image operation.
- Optional options: ImagesUpdateOptionalParams
  
  The options parameters.
Returns Promise<ImagesUpdateResponse>

get

get(resourceGroupName: string, imageName: string, options?: ImagesGetOptionalParams): Promise<ImagesGetResponse>

Implementation of Images.get
- Defined in operations/images.ts:410
Gets an image.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- imageName: string
  
  The name of the image.
- Optional options: ImagesGetOptionalParams
  
  The options parameters.
Returns Promise<ImagesGetResponse>

list

list(options?: ImagesListOptionalParams): PagedAsyncIterableIterator<Image>

Implementation of Images.list
- Defined in operations/images.ts:109
Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.

Parameters
- Optional options: ImagesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Image>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ImagesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Image>

Implementation of Images.listByResourceGroup
- Defined in operations/images.ts:56
Gets the list of images under a resource group.

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

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ComputeManagementClientContext

Returns ImagesImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

imageName: string

parameters: Image

Optional options: ImagesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ImagesCreateOrUpdateResponse>, ImagesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

imageName: string

parameters: Image

Optional options: ImagesCreateOrUpdateOptionalParams

Returns Promise<ImagesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

imageName: string

Optional options: ImagesDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

imageName: string

Optional options: ImagesDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

imageName: string

parameters: ImageUpdate

Optional options: ImagesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ImagesUpdateResponse>, ImagesUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

imageName: string

parameters: ImageUpdate

Optional options: ImagesUpdateOptionalParams

Returns Promise<ImagesUpdateResponse>

get

Parameters

resourceGroupName: string

imageName: string

Optional options: ImagesGetOptionalParams

Returns Promise<ImagesGetResponse>

list

Parameters

Optional options: ImagesListOptionalParams

Returns PagedAsyncIterableIterator<Image>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: ImagesListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Image>