GalleryImageVersions | @azure/arm-compute

Interface representing a GalleryImageVersions.

Hierarchy

GalleryImageVersions

Implemented by

GalleryImageVersionsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImageVersionName: string, galleryImageVersion: GalleryImageVersion, options?: GalleryImageVersionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<GalleryImageVersionsCreateOrUpdateResponse>, GalleryImageVersionsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/galleryImageVersions.ts:55
Create or update a gallery image version.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition resides.
- galleryImageName: string
  
  The name of the gallery image definition in which the Image Version is to be created.
- galleryImageVersionName: string
  
  The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: ..
- galleryImageVersion: GalleryImageVersion
  
  Parameters supplied to the create or update gallery image version operation.
- Optional options: GalleryImageVersionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GalleryImageVersionsCreateOrUpdateResponse>, GalleryImageVersionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImageVersionName: string, galleryImageVersion: GalleryImageVersion, options?: GalleryImageVersionsCreateOrUpdateOptionalParams): Promise<GalleryImageVersionsCreateOrUpdateResponse>

- Defined in operationsInterfaces/galleryImageVersions.ts:81
Create or update a gallery image version.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition resides.
- galleryImageName: string
  
  The name of the gallery image definition in which the Image Version is to be created.
- galleryImageVersionName: string
  
  The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: ..
- galleryImageVersion: GalleryImageVersion
  
  Parameters supplied to the create or update gallery image version operation.
- Optional options: GalleryImageVersionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<GalleryImageVersionsCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/galleryImageVersions.ts:157
Delete a gallery image version.

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

beginDeleteAndWait

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

- Defined in operationsInterfaces/galleryImageVersions.ts:172
Delete a gallery image version.

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

beginUpdate

beginUpdate(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImageVersionName: string, galleryImageVersion: GalleryImageVersionUpdate, options?: GalleryImageVersionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<GalleryImageVersionsUpdateResponse>, GalleryImageVersionsUpdateResponse>>

- Defined in operationsInterfaces/galleryImageVersions.ts:101
Update a gallery image version.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition resides.
- galleryImageName: string
  
  The name of the gallery image definition in which the Image Version is to be updated.
- galleryImageVersionName: string
  
  The name of the gallery image version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: ..
- galleryImageVersion: GalleryImageVersionUpdate
  
  Parameters supplied to the update gallery image version operation.
- Optional options: GalleryImageVersionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<GalleryImageVersionsUpdateResponse>, GalleryImageVersionsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImageVersionName: string, galleryImageVersion: GalleryImageVersionUpdate, options?: GalleryImageVersionsUpdateOptionalParams): Promise<GalleryImageVersionsUpdateResponse>

- Defined in operationsInterfaces/galleryImageVersions.ts:126
Update a gallery image version.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition resides.
- galleryImageName: string
  
  The name of the gallery image definition in which the Image Version is to be updated.
- galleryImageVersionName: string
  
  The name of the gallery image version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: ..
- galleryImageVersion: GalleryImageVersionUpdate
  
  Parameters supplied to the update gallery image version operation.
- Optional options: GalleryImageVersionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<GalleryImageVersionsUpdateResponse>

get

get(resourceGroupName: string, galleryName: string, galleryImageName: string, galleryImageVersionName: string, options?: GalleryImageVersionsGetOptionalParams): Promise<GalleryImageVersionsGetResponse>

- Defined in operationsInterfaces/galleryImageVersions.ts:142
Retrieves information about a gallery image version.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- galleryName: string
  
  The name of the Shared Image Gallery in which the Image Definition resides.
- galleryImageName: string
  
  The name of the gallery image definition in which the Image Version resides.
- galleryImageVersionName: string
  
  The name of the gallery image version to be retrieved.
- Optional options: GalleryImageVersionsGetOptionalParams
  
  The options parameters.
Returns Promise<GalleryImageVersionsGetResponse>

listByGalleryImage

listByGalleryImage(resourceGroupName: string, galleryName: string, galleryImageName: string, options?: GalleryImageVersionsListByGalleryImageOptionalParams): PagedAsyncIterableIterator<GalleryImageVersion>

- Defined in operationsInterfaces/galleryImageVersions.ts:36
List gallery image versions in 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 resides.
- galleryImageName: string
  
  The name of the Shared Image Gallery Image Definition from which the Image Versions are to be listed.
- Optional options: GalleryImageVersionsListByGalleryImageOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<GalleryImageVersion>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImageVersionName: string

galleryImageVersion: GalleryImageVersion

Optional options: GalleryImageVersionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<GalleryImageVersionsCreateOrUpdateResponse>, GalleryImageVersionsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImageVersionName: string

galleryImageVersion: GalleryImageVersion

Optional options: GalleryImageVersionsCreateOrUpdateOptionalParams

Returns Promise<GalleryImageVersionsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImageVersionName: string

Optional options: GalleryImageVersionsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImageVersionName: string

Optional options: GalleryImageVersionsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImageVersionName: string

galleryImageVersion: GalleryImageVersionUpdate

Optional options: GalleryImageVersionsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<GalleryImageVersionsUpdateResponse>, GalleryImageVersionsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImageVersionName: string

galleryImageVersion: GalleryImageVersionUpdate

Optional options: GalleryImageVersionsUpdateOptionalParams

Returns Promise<GalleryImageVersionsUpdateResponse>

get

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

galleryImageVersionName: string

Optional options: GalleryImageVersionsGetOptionalParams

Returns Promise<GalleryImageVersionsGetResponse>

listByGalleryImage

Parameters

resourceGroupName: string

galleryName: string

galleryImageName: string

Optional options: GalleryImageVersionsListByGalleryImageOptionalParams

Returns PagedAsyncIterableIterator<GalleryImageVersion>