Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomImages

Package version

Class representing a CustomImages.

Hierarchy

  • CustomImages

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(resourceGroupName: string, labName: string, name: string, customImage: CustomImage, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Create or replace an existing custom image. This operation can take a while to complete.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the custom image.

    • customImage: CustomImage

      A custom image.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, labName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Delete custom image. This operation can take a while to complete.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the custom image.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(resourceGroupName: string, labName: string, name: string, customImage: CustomImage, options?: msRest.RequestOptionsBase): Promise<Models.CustomImagesCreateOrUpdateResponse>

  • Create or replace an existing custom image. This operation can take a while to complete.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the custom image.

    • customImage: CustomImage

      A custom image.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.CustomImagesCreateOrUpdateResponse>

    Promise<Models.CustomImagesCreateOrUpdateResponse>

deleteMethod

  • deleteMethod(resourceGroupName: string, labName: string, name: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Delete custom image. This operation can take a while to complete.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the custom image.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(resourceGroupName: string, labName: string, name: string, options?: Models.CustomImagesGetOptionalParams): Promise<Models.CustomImagesGetResponse>
  • get(resourceGroupName: string, labName: string, name: string, callback: msRest.ServiceCallback<CustomImage>): void
  • get(resourceGroupName: string, labName: string, name: string, options: CustomImagesGetOptionalParams, callback: msRest.ServiceCallback<CustomImage>): void

  • Get custom image.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the custom image.

    • Optional options: Models.CustomImagesGetOptionalParams

    Returns Promise<Models.CustomImagesGetResponse>

    Promise<Models.CustomImagesGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the custom image.

    • callback: msRest.ServiceCallback<CustomImage>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the custom image.

    • options: CustomImagesGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<CustomImage>

      The callback

    Returns void

list

  • list(resourceGroupName: string, labName: string, options?: Models.CustomImagesListOptionalParams): Promise<Models.CustomImagesListResponse>
  • list(resourceGroupName: string, labName: string, callback: msRest.ServiceCallback<CustomImageList>): void
  • list(resourceGroupName: string, labName: string, options: CustomImagesListOptionalParams, callback: msRest.ServiceCallback<CustomImageList>): void

  • List custom images in a given lab.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • Optional options: Models.CustomImagesListOptionalParams

    Returns Promise<Models.CustomImagesListResponse>

    Promise<Models.CustomImagesListResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • callback: msRest.ServiceCallback<CustomImageList>

      The callback

    Returns void

  • Parameters

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.CustomImagesListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<CustomImageList>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<CustomImageList>): void

  • List custom images in a given lab.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.CustomImagesListNextResponse>

    Promise<Models.CustomImagesListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<CustomImageList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<CustomImageList>

      The callback

    Returns void

update

  • update(resourceGroupName: string, labName: string, name: string, customImage: CustomImageFragment, options?: msRest.RequestOptionsBase): Promise<Models.CustomImagesUpdateResponse>
  • update(resourceGroupName: string, labName: string, name: string, customImage: CustomImageFragment, callback: msRest.ServiceCallback<CustomImage>): void
  • update(resourceGroupName: string, labName: string, name: string, customImage: CustomImageFragment, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<CustomImage>): void

  • Modify properties of custom images.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the custom image.

    • customImage: CustomImageFragment

      A custom image.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.CustomImagesUpdateResponse>

    Promise<Models.CustomImagesUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the custom image.

    • customImage: CustomImageFragment

      A custom image.

    • callback: msRest.ServiceCallback<CustomImage>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • labName: string

      The name of the lab.

    • name: string

      The name of the custom image.

    • customImage: CustomImageFragment

      A custom image.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<CustomImage>

      The callback

    Returns void

Generated using TypeDoc