Share via

Images interface

  • Reference
Package:
@azure/arm-sphere

Interface representing a Images.

Methods

beginCreateOrUpdate(string, string, string, Image_2, ImagesCreateOrUpdateOptionalParams)

Create a Image
beginCreateOrUpdateAndWait(string, string, string, Image_2, ImagesCreateOrUpdateOptionalParams)

Create a Image
beginDelete(string, string, string, ImagesDeleteOptionalParams)

Delete a Image
beginDeleteAndWait(string, string, string, ImagesDeleteOptionalParams)

Delete a Image
get(string, string, string, ImagesGetOptionalParams)

Get a Image
listByCatalog(string, string, ImagesListByCatalogOptionalParams)

List Image resources by Catalog

Method Details

beginCreateOrUpdate(string, string, string, Image_2, ImagesCreateOrUpdateOptionalParams)

Create a Image

function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, imageName: string, resource: Image_2, options?: ImagesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Image_2>, Image_2>>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

imageName

string

Image name. Use an image GUID for GA versions of the API.

resource
Image

Resource create parameters.

options
ImagesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Image>, Image>>

beginCreateOrUpdateAndWait(string, string, string, Image_2, ImagesCreateOrUpdateOptionalParams)

Create a Image

function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, imageName: string, resource: Image_2, options?: ImagesCreateOrUpdateOptionalParams): Promise<Image_2>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

imageName

string

Image name. Use an image GUID for GA versions of the API.

resource
Image

Resource create parameters.

options
ImagesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Image>

beginDelete(string, string, string, ImagesDeleteOptionalParams)

Delete a Image

function beginDelete(resourceGroupName: string, catalogName: string, imageName: string, options?: ImagesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

imageName

string

Image name. Use an image GUID for GA versions of the API.

options
ImagesDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, ImagesDeleteOptionalParams)

Delete a Image

function beginDeleteAndWait(resourceGroupName: string, catalogName: string, imageName: string, options?: ImagesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

imageName

string

Image name. Use an image GUID for GA versions of the API.

options
ImagesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ImagesGetOptionalParams)

Get a Image

function get(resourceGroupName: string, catalogName: string, imageName: string, options?: ImagesGetOptionalParams): Promise<Image_2>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

imageName

string

Image name. Use an image GUID for GA versions of the API.

options
ImagesGetOptionalParams

The options parameters.

Returns

Promise<Image>

listByCatalog(string, string, ImagesListByCatalogOptionalParams)

List Image resources by Catalog

function listByCatalog(resourceGroupName: string, catalogName: string, options?: ImagesListByCatalogOptionalParams): PagedAsyncIterableIterator<Image_2, Image_2[], PageSettings>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

options
ImagesListByCatalogOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Image, Image[], PageSettings>