Images interface
Interface representing a Images.
Methods
| create |
Updates an image resource via PUT. Creating new resources via PUT will not function. |
| get(string, string, string, Images |
Gets an image resource. |
| list |
Gets all images from galleries attached to a lab plan. |
| update(string, string, string, Image |
Updates an image resource. |
Method Details
createOrUpdate(string, string, string, Image_2, ImagesCreateOrUpdateOptionalParams)
Updates an image resource via PUT. Creating new resources via PUT will not function.
function createOrUpdate(resourceGroupName: string, labPlanName: string, imageName: string, body: Image_2, options?: ImagesCreateOrUpdateOptionalParams): Promise<Image_2>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- imageName
-
string
The image name.
- body
- Image
The request body.
The options parameters.
Returns
Promise<Image>
get(string, string, string, ImagesGetOptionalParams)
Gets an image resource.
function get(resourceGroupName: string, labPlanName: string, imageName: string, options?: ImagesGetOptionalParams): Promise<Image_2>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- imageName
-
string
The image name.
- options
- ImagesGetOptionalParams
The options parameters.
Returns
Promise<Image>
listByLabPlan(string, string, ImagesListByLabPlanOptionalParams)
Gets all images from galleries attached to a lab plan.
function listByLabPlan(resourceGroupName: string, labPlanName: string, options?: ImagesListByLabPlanOptionalParams): PagedAsyncIterableIterator<Image_2, Image_2[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
The options parameters.
Returns
update(string, string, string, ImageUpdate, ImagesUpdateOptionalParams)
Updates an image resource.
function update(resourceGroupName: string, labPlanName: string, imageName: string, body: ImageUpdate, options?: ImagesUpdateOptionalParams): Promise<Image_2>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- labPlanName
-
string
The name of the lab plan that uniquely identifies it within containing resource group. Used in resource URIs and in UI.
- imageName
-
string
The image name.
- body
- ImageUpdate
The request body.
- options
- ImagesUpdateOptionalParams
The options parameters.
Returns
Promise<Image>