ContainerGroupProfiles interface

Package:

@azure/arm-containerinstance

Interface representing a ContainerGroupProfiles.

Methods

createOrUpdate(string, string, ContainerGroupProfile, ContainerGroupProfilesCreateOrUpdateOptionalParams)	Create or update container group profiles with specified configurations.
delete(string, string, ContainerGroupProfilesDeleteOptionalParams)	Delete the specified container group profile in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.
get(string, string, ContainerGroupProfilesGetOptionalParams)	Gets the properties of the specified container group profile in the specified subscription and resource group. The operation returns the properties of container group profile including containers, image registry credentials, restart policy, IP address type, OS type, volumes, current revision number, etc.
list(ContainerGroupProfilesListOptionalParams)	Get a list of container group profiles in the specified subscription. This operation returns properties of each container group profile including containers, image registry credentials, restart policy, IP address type, OS type,volumes,current revision number, etc.
listByResourceGroup(string, ContainerGroupProfilesListByResourceGroupOptionalParams)	Get a list of container group profiles in a specified subscription and resource group. This operation returns properties of each container group profile including containers, image registry credentials, restart policy, IP address type, OS type volumes, current revision number, etc.
patch(string, string, ContainerGroupProfilePatch, ContainerGroupProfilesPatchOptionalParams)	Patches container group profile with specified properties.

Method Details

createOrUpdate(string, string, ContainerGroupProfile, ContainerGroupProfilesCreateOrUpdateOptionalParams)

Create or update container group profiles with specified configurations.

function createOrUpdate(resourceGroupName: string, containerGroupProfileName: string, containerGroupProfile: ContainerGroupProfile, options?: ContainerGroupProfilesCreateOrUpdateOptionalParams): Promise<ContainerGroupProfile>

Parameters

resourceGroupName

string

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

containerGroupProfileName

string

The name of the container group profile.

containerGroupProfile

ContainerGroupProfile

The properties of the container group profile to be created or updated.

options

ContainerGroupProfilesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ContainerGroupProfile>

delete(string, string, ContainerGroupProfilesDeleteOptionalParams)

Delete the specified container group profile in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.

function delete(resourceGroupName: string, containerGroupProfileName: string, options?: ContainerGroupProfilesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

containerGroupProfileName

string

The name of the container group profile.

options

ContainerGroupProfilesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ContainerGroupProfilesGetOptionalParams)

Gets the properties of the specified container group profile in the specified subscription and resource group. The operation returns the properties of container group profile including containers, image registry credentials, restart policy, IP address type, OS type, volumes, current revision number, etc.

function get(resourceGroupName: string, containerGroupProfileName: string, options?: ContainerGroupProfilesGetOptionalParams): Promise<ContainerGroupProfile>

Parameters

resourceGroupName

string

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

containerGroupProfileName

string

The name of the container group profile.

options

ContainerGroupProfilesGetOptionalParams

The options parameters.

Returns

Promise<ContainerGroupProfile>

list(ContainerGroupProfilesListOptionalParams)

Get a list of container group profiles in the specified subscription. This operation returns properties of each container group profile including containers, image registry credentials, restart policy, IP address type, OS type,volumes,current revision number, etc.

function list(options?: ContainerGroupProfilesListOptionalParams): PagedAsyncIterableIterator<ContainerGroupProfile, ContainerGroupProfile[], PageSettings>

Parameters

options

ContainerGroupProfilesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ContainerGroupProfile, ContainerGroupProfile[], PageSettings>

listByResourceGroup(string, ContainerGroupProfilesListByResourceGroupOptionalParams)

Get a list of container group profiles in a specified subscription and resource group. This operation returns properties of each container group profile including containers, image registry credentials, restart policy, IP address type, OS type volumes, current revision number, etc.

function listByResourceGroup(resourceGroupName: string, options?: ContainerGroupProfilesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ContainerGroupProfile, ContainerGroupProfile[], PageSettings>

Parameters

resourceGroupName

string

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

options

ContainerGroupProfilesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ContainerGroupProfile, ContainerGroupProfile[], PageSettings>

patch(string, string, ContainerGroupProfilePatch, ContainerGroupProfilesPatchOptionalParams)

Patches container group profile with specified properties.

function patch(resourceGroupName: string, containerGroupProfileName: string, properties: ContainerGroupProfilePatch, options?: ContainerGroupProfilesPatchOptionalParams): Promise<ContainerGroupProfile>

Parameters

resourceGroupName

string

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

containerGroupProfileName

string

The name of the container group profile.

properties

ContainerGroupProfilePatch

The container group profile properties that need to be updated.

options

ContainerGroupProfilesPatchOptionalParams

The options parameters.

Returns

Promise<ContainerGroupProfile>