Images | @azure/arm-compute

Interface representing a Images.

Hierarchy

Images

Implemented by

ImagesImpl

Index

Methods

beginCreateOrUpdate

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

- Defined in operationsInterfaces/images.ts:51
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>

- Defined in operationsInterfaces/images.ts:69
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>>

- Defined in operationsInterfaces/images.ts:109
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>

- Defined in operationsInterfaces/images.ts:120
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>>

- Defined in operationsInterfaces/images.ts:82
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>

- Defined in operationsInterfaces/images.ts:97
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>

- Defined in operationsInterfaces/images.ts:131
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>

- Defined in operationsInterfaces/images.ts:43
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>

- Defined in operationsInterfaces/images.ts:34
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

Implemented by

Index

Methods

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>