Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Images

Package version

Class representing a Images.

Hierarchy

  • Images

Index

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(resourceGroupName: string, imageName: string, parameters: Image, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>
  • 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: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, imageName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>
  • Deletes an Image.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • imageName: string

      The name of the image.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginUpdate

  • beginUpdate(resourceGroupName: string, imageName: string, parameters: ImageUpdate, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>
  • 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: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(resourceGroupName: string, imageName: string, parameters: Image, options?: msRest.RequestOptionsBase): Promise<Models.ImagesCreateOrUpdateResponse>
  • 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: msRest.RequestOptionsBase

    Returns Promise<Models.ImagesCreateOrUpdateResponse>

    Promise<Models.ImagesCreateOrUpdateResponse>

deleteMethod

  • deleteMethod(resourceGroupName: string, imageName: string, options?: msRest.RequestOptionsBase): Promise<Models.ImagesDeleteMethodResponse>
  • Deletes an Image.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • imageName: string

      The name of the image.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ImagesDeleteMethodResponse>

    Promise<Models.ImagesDeleteMethodResponse>

get

  • get(resourceGroupName: string, imageName: string, options?: Models.ImagesGetOptionalParams): Promise<Models.ImagesGetResponse>
  • get(resourceGroupName: string, imageName: string, callback: msRest.ServiceCallback<Image>): void
  • get(resourceGroupName: string, imageName: string, options: ImagesGetOptionalParams, callback: msRest.ServiceCallback<Image>): void
  • Gets an image.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • imageName: string

      The name of the image.

    • Optional options: Models.ImagesGetOptionalParams

    Returns Promise<Models.ImagesGetResponse>

    Promise<Models.ImagesGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • imageName: string

      The name of the image.

    • callback: msRest.ServiceCallback<Image>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • imageName: string

      The name of the image.

    • options: ImagesGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Image>

      The callback

    Returns void

list

  • list(options?: msRest.RequestOptionsBase): Promise<Models.ImagesListResponse>
  • list(callback: msRest.ServiceCallback<ImageListResult>): void
  • list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ImageListResult>): void
  • 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: msRest.RequestOptionsBase

    Returns Promise<Models.ImagesListResponse>

    Promise<Models.ImagesListResponse>

  • Parameters

    Returns void

  • Parameters

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ImageListResult>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.ImagesListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<ImageListResult>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ImageListResult>): void
  • Gets the list of images under a resource group.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ImagesListByResourceGroupResponse>

    Promise<Models.ImagesListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • callback: msRest.ServiceCallback<ImageListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ImageListResult>

      The callback

    Returns void

listByResourceGroupNext

  • listByResourceGroupNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ImagesListByResourceGroupNextResponse>
  • listByResourceGroupNext(nextPageLink: string, callback: msRest.ServiceCallback<ImageListResult>): void
  • listByResourceGroupNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ImageListResult>): void
  • Gets the list of images under a resource group.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ImagesListByResourceGroupNextResponse>

    Promise<Models.ImagesListByResourceGroupNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ImageListResult>

      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<ImageListResult>

      The callback

    Returns void

listNext

  • listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ImagesListNextResponse>
  • listNext(nextPageLink: string, callback: msRest.ServiceCallback<ImageListResult>): void
  • listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ImageListResult>): void
  • 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

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ImagesListNextResponse>

    Promise<Models.ImagesListNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<ImageListResult>

      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<ImageListResult>

      The callback

    Returns void

update

  • update(resourceGroupName: string, imageName: string, parameters: ImageUpdate, options?: msRest.RequestOptionsBase): Promise<Models.ImagesUpdateResponse>
  • 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: msRest.RequestOptionsBase

    Returns Promise<Models.ImagesUpdateResponse>

    Promise<Models.ImagesUpdateResponse>

Generated using TypeDoc