/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import { PagedAsyncIterableIterator } from "@azure/core-paging";
import { SimplePollerLike, OperationState } from "@azure/core-lro";
import {
ContainerGroup,
ContainerGroupsListOptionalParams,
ContainerGroupsListByResourceGroupOptionalParams,
ContainerGroupsGetOptionalParams,
ContainerGroupsGetResponse,
ContainerGroupsCreateOrUpdateOptionalParams,
ContainerGroupsCreateOrUpdateResponse,
Resource,
ContainerGroupsUpdateOptionalParams,
ContainerGroupsUpdateResponse,
ContainerGroupsDeleteOptionalParams,
ContainerGroupsDeleteResponse,
ContainerGroupsRestartOptionalParams,
ContainerGroupsStopOptionalParams,
ContainerGroupsStartOptionalParams,
ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams,
ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse
} from "../models";
///
/** Interface representing a ContainerGroups. */
export interface ContainerGroups {
/**
* Get a list of container groups in the specified subscription. This operation returns properties of
* each container group including containers, image registry credentials, restart policy, IP address
* type, OS type, state, and volumes.
* @param options The options parameters.
*/
list(
options?: ContainerGroupsListOptionalParams
): PagedAsyncIterableIterator;
/**
* Get a list of container groups in a specified subscription and resource group. This operation
* returns properties of each container group including containers, image registry credentials, restart
* policy, IP address type, OS type, state, and volumes.
* @param resourceGroupName The name of the resource group.
* @param options The options parameters.
*/
listByResourceGroup(
resourceGroupName: string,
options?: ContainerGroupsListByResourceGroupOptionalParams
): PagedAsyncIterableIterator;
/**
* Gets the properties of the specified container group in the specified subscription and resource
* group. The operation returns the properties of each container group including containers, image
* registry credentials, restart policy, IP address type, OS type, state, and volumes.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param options The options parameters.
*/
get(
resourceGroupName: string,
containerGroupName: string,
options?: ContainerGroupsGetOptionalParams
): Promise;
/**
* Create or update container groups with specified configurations.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param containerGroup The properties of the container group to be created or updated.
* @param options The options parameters.
*/
beginCreateOrUpdate(
resourceGroupName: string,
containerGroupName: string,
containerGroup: ContainerGroup,
options?: ContainerGroupsCreateOrUpdateOptionalParams
): Promise<
SimplePollerLike<
OperationState,
ContainerGroupsCreateOrUpdateResponse
>
>;
/**
* Create or update container groups with specified configurations.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param containerGroup The properties of the container group to be created or updated.
* @param options The options parameters.
*/
beginCreateOrUpdateAndWait(
resourceGroupName: string,
containerGroupName: string,
containerGroup: ContainerGroup,
options?: ContainerGroupsCreateOrUpdateOptionalParams
): Promise;
/**
* Updates container group tags with specified values.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param resource The container group resource with just the tags to be updated.
* @param options The options parameters.
*/
update(
resourceGroupName: string,
containerGroupName: string,
resource: Resource,
options?: ContainerGroupsUpdateOptionalParams
): Promise;
/**
* Delete the specified container group in the specified subscription and resource group. The operation
* does not delete other resources provided by the user, such as volumes.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param options The options parameters.
*/
beginDelete(
resourceGroupName: string,
containerGroupName: string,
options?: ContainerGroupsDeleteOptionalParams
): Promise<
SimplePollerLike<
OperationState,
ContainerGroupsDeleteResponse
>
>;
/**
* Delete the specified container group in the specified subscription and resource group. The operation
* does not delete other resources provided by the user, such as volumes.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param options The options parameters.
*/
beginDeleteAndWait(
resourceGroupName: string,
containerGroupName: string,
options?: ContainerGroupsDeleteOptionalParams
): Promise;
/**
* Restarts all containers in a container group in place. If container image has updates, new image
* will be downloaded.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param options The options parameters.
*/
beginRestart(
resourceGroupName: string,
containerGroupName: string,
options?: ContainerGroupsRestartOptionalParams
): Promise, void>>;
/**
* Restarts all containers in a container group in place. If container image has updates, new image
* will be downloaded.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param options The options parameters.
*/
beginRestartAndWait(
resourceGroupName: string,
containerGroupName: string,
options?: ContainerGroupsRestartOptionalParams
): Promise;
/**
* Stops all containers in a container group. Compute resources will be deallocated and billing will
* stop.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param options The options parameters.
*/
stop(
resourceGroupName: string,
containerGroupName: string,
options?: ContainerGroupsStopOptionalParams
): Promise;
/**
* Starts all containers in a container group. Compute resources will be allocated and billing will
* start.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param options The options parameters.
*/
beginStart(
resourceGroupName: string,
containerGroupName: string,
options?: ContainerGroupsStartOptionalParams
): Promise, void>>;
/**
* Starts all containers in a container group. Compute resources will be allocated and billing will
* start.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param options The options parameters.
*/
beginStartAndWait(
resourceGroupName: string,
containerGroupName: string,
options?: ContainerGroupsStartOptionalParams
): Promise;
/**
* Gets all the network dependencies for this container group to allow complete control of network
* setting and configuration. For container groups, this will always be an empty list.
* @param resourceGroupName The name of the resource group.
* @param containerGroupName The name of the container group.
* @param options The options parameters.
*/
getOutboundNetworkDependenciesEndpoints(
resourceGroupName: string,
containerGroupName: string,
options?: ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams
): Promise;
}