GalleryImages | @azure/arm-compute

Interface representing a GalleryImages.

Hierarchy

GalleryImages

Implemented by

GalleryImagesImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImage: GalleryImage, options?: GalleryImagesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<GalleryImagesCreateOrUpdateResponse>, GalleryImagesCreateOrUpdateResponse>>

- Defined in operationsInterfaces/galleryImages.ts:51
Create or update a gallery image definition.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition is to be created.
- galleryImageName: string
  
  The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
- galleryImage: GalleryImage
  
  Parameters supplied to the create or update gallery image operation.
- Optional options: GalleryImagesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GalleryImagesCreateOrUpdateResponse>, GalleryImagesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImage: GalleryImage, options?: GalleryImagesCreateOrUpdateOptionalParams): Promise<GalleryImagesCreateOrUpdateResponse>

- Defined in operationsInterfaces/galleryImages.ts:74
Create or update a gallery image definition.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition is to be created.
- galleryImageName: string
  
  The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
- galleryImage: GalleryImage
  
  Parameters supplied to the create or update gallery image operation.
- Optional options: GalleryImagesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<GalleryImagesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, galleryName: string, galleryImageName: string, options?: GalleryImagesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/galleryImages.ts:144
Delete a gallery image.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition is to be deleted.
- galleryImageName: string
  
  The name of the gallery image definition to be deleted.
- Optional options: GalleryImagesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, galleryName: string, galleryImageName: string, options?: GalleryImagesDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/galleryImages.ts:158
Delete a gallery image.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition is to be deleted.
- galleryImageName: string
  
  The name of the gallery image definition to be deleted.
- Optional options: GalleryImagesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImage: GalleryImageUpdate, options?: GalleryImagesUpdateOptionalParams): Promise<PollerLike<PollOperationState<GalleryImagesUpdateResponse>, GalleryImagesUpdateResponse>>

- Defined in operationsInterfaces/galleryImages.ts:92
Update a gallery image definition.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition is to be updated.
- galleryImageName: string
  
  The name of the gallery image definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
- galleryImage: GalleryImageUpdate
  
  Parameters supplied to the update gallery image operation.
- Optional options: GalleryImagesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GalleryImagesUpdateResponse>, GalleryImagesUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImage: GalleryImageUpdate, options?: GalleryImagesUpdateOptionalParams): Promise<GalleryImagesUpdateResponse>

- Defined in operationsInterfaces/galleryImages.ts:115
Update a gallery image definition.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition is to be updated.
- galleryImageName: string
  
  The name of the gallery image definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters.
- galleryImage: GalleryImageUpdate
  
  Parameters supplied to the update gallery image operation.
- Optional options: GalleryImagesUpdateOptionalParams
  
  The options parameters.
Returns Promise<GalleryImagesUpdateResponse>

get

get(resourceGroupName: string, galleryName: string, galleryImageName: string, options?: GalleryImagesGetOptionalParams): Promise<GalleryImagesGetResponse>

- Defined in operationsInterfaces/galleryImages.ts:130
Retrieves information about a gallery image definition.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery from which the Image Definitions are to be retrieved.
- galleryImageName: string
  
  The name of the gallery image definition to be retrieved.
- Optional options: GalleryImagesGetOptionalParams
  
  The options parameters.
Returns Promise<GalleryImagesGetResponse>

listByGallery

listByGallery(resourceGroupName: string, galleryName: string, options?: GalleryImagesListByGalleryOptionalParams): PagedAsyncIterableIterator<GalleryImage>

- Defined in operationsInterfaces/galleryImages.ts:35
List gallery image definitions in a gallery.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery from which Image Definitions are to be listed.
- Optional options: GalleryImagesListByGalleryOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<GalleryImage>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImage: GalleryImage

Optional options: GalleryImagesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<GalleryImagesCreateOrUpdateResponse>, GalleryImagesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImage: GalleryImage

Optional options: GalleryImagesCreateOrUpdateOptionalParams

Returns Promise<GalleryImagesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

Optional options: GalleryImagesDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

Optional options: GalleryImagesDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImage: GalleryImageUpdate

Optional options: GalleryImagesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<GalleryImagesUpdateResponse>, GalleryImagesUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImage: GalleryImageUpdate

Optional options: GalleryImagesUpdateOptionalParams

Returns Promise<GalleryImagesUpdateResponse>

get

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

Optional options: GalleryImagesGetOptionalParams

Returns Promise<GalleryImagesGetResponse>

listByGallery

Parameters

resourceGroupName: string

galleryName: string

Optional options: GalleryImagesListByGalleryOptionalParams

Returns PagedAsyncIterableIterator<GalleryImage>