Share via


GalleryImages interface

Interface representing a GalleryImages.

Methods

beginCreateOrUpdate(string, string, string, GalleryImage, GalleryImagesCreateOrUpdateOptionalParams)

Create or update a gallery image definition.

beginCreateOrUpdateAndWait(string, string, string, GalleryImage, GalleryImagesCreateOrUpdateOptionalParams)

Create or update a gallery image definition.

beginDelete(string, string, string, GalleryImagesDeleteOptionalParams)

Delete a gallery image.

beginDeleteAndWait(string, string, string, GalleryImagesDeleteOptionalParams)

Delete a gallery image.

beginUpdate(string, string, string, GalleryImageUpdate, GalleryImagesUpdateOptionalParams)

Update a gallery image definition.

beginUpdateAndWait(string, string, string, GalleryImageUpdate, GalleryImagesUpdateOptionalParams)

Update a gallery image definition.

get(string, string, string, GalleryImagesGetOptionalParams)

Retrieves information about a gallery image definition.

listByGallery(string, string, GalleryImagesListByGalleryOptionalParams)

List gallery image definitions in a gallery.

Method Details

beginCreateOrUpdate(string, string, string, GalleryImage, GalleryImagesCreateOrUpdateOptionalParams)

Create or update a gallery image definition.

function beginCreateOrUpdate(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImage: GalleryImage, options?: GalleryImagesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GalleryImage>, GalleryImage>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

galleryName

string

The name of the Shared Image Gallery.

galleryImageName

string

The name of the gallery image definition to be retrieved.

galleryImage
GalleryImage

Parameters supplied to the create or update gallery image operation.

options
GalleryImagesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GalleryImage>, GalleryImage>>

beginCreateOrUpdateAndWait(string, string, string, GalleryImage, GalleryImagesCreateOrUpdateOptionalParams)

Create or update a gallery image definition.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

galleryName

string

The name of the Shared Image Gallery.

galleryImageName

string

The name of the gallery image definition to be retrieved.

galleryImage
GalleryImage

Parameters supplied to the create or update gallery image operation.

options
GalleryImagesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<GalleryImage>

beginDelete(string, string, string, GalleryImagesDeleteOptionalParams)

Delete a gallery image.

function beginDelete(resourceGroupName: string, galleryName: string, galleryImageName: string, options?: GalleryImagesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

galleryName

string

The name of the Shared Image Gallery.

galleryImageName

string

The name of the gallery image definition to be retrieved.

options
GalleryImagesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, GalleryImagesDeleteOptionalParams)

Delete a gallery image.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

galleryName

string

The name of the Shared Image Gallery.

galleryImageName

string

The name of the gallery image definition to be retrieved.

options
GalleryImagesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, GalleryImageUpdate, GalleryImagesUpdateOptionalParams)

Update a gallery image definition.

function beginUpdate(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImage: GalleryImageUpdate, options?: GalleryImagesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GalleryImagesUpdateResponse>, GalleryImagesUpdateResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

galleryName

string

The name of the Shared Image Gallery.

galleryImageName

string

The name of the gallery image definition to be retrieved.

galleryImage
GalleryImageUpdate

Parameters supplied to the update gallery image operation.

options
GalleryImagesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<GalleryImagesUpdateResponse>, GalleryImagesUpdateResponse>>

beginUpdateAndWait(string, string, string, GalleryImageUpdate, GalleryImagesUpdateOptionalParams)

Update a gallery image definition.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

galleryName

string

The name of the Shared Image Gallery.

galleryImageName

string

The name of the gallery image definition to be retrieved.

galleryImage
GalleryImageUpdate

Parameters supplied to the update gallery image operation.

options
GalleryImagesUpdateOptionalParams

The options parameters.

Returns

get(string, string, string, GalleryImagesGetOptionalParams)

Retrieves information about a gallery image definition.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

galleryName

string

The name of the Shared Image Gallery.

galleryImageName

string

The name of the gallery image definition to be retrieved.

options
GalleryImagesGetOptionalParams

The options parameters.

Returns

Promise<GalleryImage>

listByGallery(string, string, GalleryImagesListByGalleryOptionalParams)

List gallery image definitions in a gallery.

function listByGallery(resourceGroupName: string, galleryName: string, options?: GalleryImagesListByGalleryOptionalParams): PagedAsyncIterableIterator<GalleryImage, GalleryImage[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

galleryName

string

The name of the Shared Image Gallery.

options
GalleryImagesListByGalleryOptionalParams

The options parameters.

Returns