你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ContainerGroups interface

参考

包:: @azure/arm-containerinstance

表示 ContainerGroups 的接口。

方法

beginCreateOrUpdate(string, string, ContainerGroup, ContainerGroupsCreateOrUpdateOptionalParams)	创建或更新具有指定配置的容器组。
beginCreateOrUpdateAndWait(string, string, ContainerGroup, ContainerGroupsCreateOrUpdateOptionalParams)	创建或更新具有指定配置的容器组。
beginDelete(string, string, ContainerGroupsDeleteOptionalParams)	删除指定订阅和资源组中的指定容器组。该作不会删除用户提供的其他资源，例如卷。
beginDeleteAndWait(string, string, ContainerGroupsDeleteOptionalParams)	删除指定订阅和资源组中的指定容器组。该作不会删除用户提供的其他资源，例如卷。
beginRestart(string, string, ContainerGroupsRestartOptionalParams)	重启容器组中的所有容器。如果容器映像有更新，则会下载新映像。
beginRestartAndWait(string, string, ContainerGroupsRestartOptionalParams)	重启容器组中的所有容器。如果容器映像有更新，则会下载新映像。
beginStart(string, string, ContainerGroupsStartOptionalParams)	启动容器组中的所有容器。将分配计算资源，并启动计费。
beginStartAndWait(string, string, ContainerGroupsStartOptionalParams)	启动容器组中的所有容器。将分配计算资源，并启动计费。
get(string, string, ContainerGroupsGetOptionalParams)	获取指定订阅和资源组中指定容器组的属性。该作返回每个容器组的属性，包括容器、映像注册表凭据、重启策略、IP 地址类型、OS 类型、状态和卷。
getOutboundNetworkDependenciesEndpoints(string, string, ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams)	获取此容器组的所有网络依赖项，以允许完全控制网络设置和配置。对于容器组，这始终为空列表。
list(ContainerGroupsListOptionalParams)	获取指定订阅中的容器组的列表。此作返回每个容器组的属性，包括容器、映像注册表凭据、重启策略、IP 地址类型、OS 类型、状态和卷。
listByResourceGroup(string, ContainerGroupsListByResourceGroupOptionalParams)	获取指定订阅和资源组中的容器组的列表。此作返回每个容器组的属性，包括容器、映像注册表凭据、重启策略、IP 地址类型、OS 类型、状态和卷。
stop(string, string, ContainerGroupsStopOptionalParams)	停止容器组中的所有容器。计算资源将被解除分配，计费将停止。
update(string, string, Resource, ContainerGroupsUpdateOptionalParams)	使用指定值更新容器组标记。

方法详细信息

beginCreateOrUpdate(string, string, ContainerGroup, ContainerGroupsCreateOrUpdateOptionalParams)

创建或更新具有指定配置的容器组。

function beginCreateOrUpdate(resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ContainerGroup>, ContainerGroup>>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

containerGroup: ContainerGroup

要创建或更新的容器组的属性。

options: ContainerGroupsCreateOrUpdateOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<ContainerGroup>, ContainerGroup>>

beginCreateOrUpdateAndWait(string, string, ContainerGroup, ContainerGroupsCreateOrUpdateOptionalParams)

创建或更新具有指定配置的容器组。

function beginCreateOrUpdateAndWait(resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams): Promise<ContainerGroup>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

containerGroup: ContainerGroup

要创建或更新的容器组的属性。

options: ContainerGroupsCreateOrUpdateOptionalParams

选项参数。

Promise<ContainerGroup>

beginDelete(string, string, ContainerGroupsDeleteOptionalParams)

删除指定订阅和资源组中的指定容器组。该作不会删除用户提供的其他资源，例如卷。

function beginDelete(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ContainerGroup>, ContainerGroup>>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

options: ContainerGroupsDeleteOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<ContainerGroup>, ContainerGroup>>

beginDeleteAndWait(string, string, ContainerGroupsDeleteOptionalParams)

删除指定订阅和资源组中的指定容器组。该作不会删除用户提供的其他资源，例如卷。

function beginDeleteAndWait(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams): Promise<ContainerGroup>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

options: ContainerGroupsDeleteOptionalParams

选项参数。

Promise<ContainerGroup>

beginRestart(string, string, ContainerGroupsRestartOptionalParams)

重启容器组中的所有容器。如果容器映像有更新，则会下载新映像。

function beginRestart(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

options: ContainerGroupsRestartOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait(string, string, ContainerGroupsRestartOptionalParams)

重启容器组中的所有容器。如果容器映像有更新，则会下载新映像。

function beginRestartAndWait(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

options: ContainerGroupsRestartOptionalParams

选项参数。

Promise<void>

beginStart(string, string, ContainerGroupsStartOptionalParams)

启动容器组中的所有容器。将分配计算资源，并启动计费。

function beginStart(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

options: ContainerGroupsStartOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, ContainerGroupsStartOptionalParams)

启动容器组中的所有容器。将分配计算资源，并启动计费。

function beginStartAndWait(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

options: ContainerGroupsStartOptionalParams

选项参数。

Promise<void>

get(string, string, ContainerGroupsGetOptionalParams)

获取指定订阅和资源组中指定容器组的属性。该作返回每个容器组的属性，包括容器、映像注册表凭据、重启策略、IP 地址类型、OS 类型、状态和卷。

function get(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsGetOptionalParams): Promise<ContainerGroup>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

options: ContainerGroupsGetOptionalParams

选项参数。

Promise<ContainerGroup>

getOutboundNetworkDependenciesEndpoints(string, string, ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams)

获取此容器组的所有网络依赖项，以允许完全控制网络设置和配置。对于容器组，这始终为空列表。

function getOutboundNetworkDependenciesEndpoints(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams): Promise<ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

options: ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams

选项参数。

Promise<ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse>

list(ContainerGroupsListOptionalParams)

获取指定订阅中的容器组的列表。此作返回每个容器组的属性，包括容器、映像注册表凭据、重启策略、IP 地址类型、OS 类型、状态和卷。

function list(options?: ContainerGroupsListOptionalParams): PagedAsyncIterableIterator<ContainerGroup, ContainerGroup[], PageSettings>

参数

options: ContainerGroupsListOptionalParams

选项参数。

PagedAsyncIterableIterator<ContainerGroup, ContainerGroup[], PageSettings>

listByResourceGroup(string, ContainerGroupsListByResourceGroupOptionalParams)

获取指定订阅和资源组中的容器组的列表。此作返回每个容器组的属性，包括容器、映像注册表凭据、重启策略、IP 地址类型、OS 类型、状态和卷。

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

参数

resourceGroupName: string

资源组的名称。

options: ContainerGroupsListByResourceGroupOptionalParams

选项参数。

PagedAsyncIterableIterator<ContainerGroup, ContainerGroup[], PageSettings>

stop(string, string, ContainerGroupsStopOptionalParams)

停止容器组中的所有容器。计算资源将被解除分配，计费将停止。

function stop(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStopOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

options: ContainerGroupsStopOptionalParams

选项参数。

Promise<void>

update(string, string, Resource, ContainerGroupsUpdateOptionalParams)

使用指定值更新容器组标记。

function update(resourceGroupName: string, containerGroupName: string, resource: Resource, options?: ContainerGroupsUpdateOptionalParams): Promise<ContainerGroup>

参数

resourceGroupName: string

资源组的名称。

containerGroupName: string

容器组的名称。

resource: Resource

仅包含要更新的标记的容器组资源。

options: ContainerGroupsUpdateOptionalParams

选项参数。

Promise<ContainerGroup>

通过

ContainerGroups interface

方法

方法详细信息

beginCreateOrUpdate(string, string, ContainerGroup, ContainerGroupsCreateOrUpdateOptionalParams)

参数

返回

beginCreateOrUpdateAndWait(string, string, ContainerGroup, ContainerGroupsCreateOrUpdateOptionalParams)

参数

返回

beginDelete(string, string, ContainerGroupsDeleteOptionalParams)

参数

返回

beginDeleteAndWait(string, string, ContainerGroupsDeleteOptionalParams)

参数

返回

beginRestart(string, string, ContainerGroupsRestartOptionalParams)

参数

返回

beginRestartAndWait(string, string, ContainerGroupsRestartOptionalParams)

参数

返回

beginStart(string, string, ContainerGroupsStartOptionalParams)

参数

返回

beginStartAndWait(string, string, ContainerGroupsStartOptionalParams)

参数

返回

get(string, string, ContainerGroupsGetOptionalParams)

参数

返回

getOutboundNetworkDependenciesEndpoints(string, string, ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams)

参数

返回

list(ContainerGroupsListOptionalParams)

参数

返回

listByResourceGroup(string, ContainerGroupsListByResourceGroupOptionalParams)

参数

返回

stop(string, string, ContainerGroupsStopOptionalParams)

参数

返回

update(string, string, Resource, ContainerGroupsUpdateOptionalParams)

参数

返回