你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
ManagedClusters interface
表示 ManagedClusters 的接口。
方法
方法详细信息
beginAbortLatestOperation(string, string, ManagedClustersAbortLatestOperationOptionalParams)
中止托管群集上当前正在运行的操作。 托管群集将移动到“取消”状态,并最终在取消完成后进入“已取消”状态。 如果在取消之前完成该操作,则会返回 409 错误代码。
function beginAbortLatestOperation(resourceGroupName: string, resourceName: string, options?: ManagedClustersAbortLatestOperationOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersAbortLatestOperationHeaders>, ManagedClustersAbortLatestOperationHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersAbortLatestOperationHeaders>, ManagedClustersAbortLatestOperationHeaders>>
beginAbortLatestOperationAndWait(string, string, ManagedClustersAbortLatestOperationOptionalParams)
中止托管群集上当前正在运行的操作。 托管群集将移动到“取消”状态,并最终在取消完成后进入“已取消”状态。 如果在取消之前完成该操作,则会返回 409 错误代码。
function beginAbortLatestOperationAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersAbortLatestOperationOptionalParams): Promise<ManagedClustersAbortLatestOperationHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
beginCreateOrUpdate(string, string, ManagedCluster, ManagedClustersCreateOrUpdateOptionalParams)
创建或更新托管群集。
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: ManagedCluster, options?: ManagedClustersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedCluster>, ManagedCluster>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- parameters
- ManagedCluster
要创建或更新的托管群集。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedCluster>, ManagedCluster>>
beginCreateOrUpdateAndWait(string, string, ManagedCluster, ManagedClustersCreateOrUpdateOptionalParams)
创建或更新托管群集。
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: ManagedCluster, options?: ManagedClustersCreateOrUpdateOptionalParams): Promise<ManagedCluster>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- parameters
- ManagedCluster
要创建或更新的托管群集。
选项参数。
返回
Promise<ManagedCluster>
beginDelete(string, string, ManagedClustersDeleteOptionalParams)
删除托管群集。
function beginDelete(resourceGroupName: string, resourceName: string, options?: ManagedClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersDeleteHeaders>, ManagedClustersDeleteHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersDeleteHeaders>, ManagedClustersDeleteHeaders>>
beginDeleteAndWait(string, string, ManagedClustersDeleteOptionalParams)
删除托管群集。
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersDeleteOptionalParams): Promise<ManagedClustersDeleteHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<ManagedClustersDeleteHeaders>
beginResetAADProfile(string, string, ManagedClusterAADProfile, ManagedClustersResetAADProfileOptionalParams)
警告:此 API 将弃用。 请参阅 AKS 托管的 Azure Active Directory 集成,以使用 AKS 托管的 Azure AD 更新群集。
function beginResetAADProfile(resourceGroupName: string, resourceName: string, parameters: ManagedClusterAADProfile, options?: ManagedClustersResetAADProfileOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- parameters
- ManagedClusterAADProfile
在托管群集上设置的 AAD 配置文件
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginResetAADProfileAndWait(string, string, ManagedClusterAADProfile, ManagedClustersResetAADProfileOptionalParams)
警告:此 API 将弃用。 请参阅 AKS 托管的 Azure Active Directory 集成,以使用 AKS 托管的 Azure AD 更新群集。
function beginResetAADProfileAndWait(resourceGroupName: string, resourceName: string, parameters: ManagedClusterAADProfile, options?: ManagedClustersResetAADProfileOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- parameters
- ManagedClusterAADProfile
在托管群集上设置的 AAD 配置文件
选项参数。
返回
Promise<void>
beginResetServicePrincipalProfile(string, string, ManagedClusterServicePrincipalProfile, ManagedClustersResetServicePrincipalProfileOptionalParams)
不能对未使用服务主体的群集执行此操作
function beginResetServicePrincipalProfile(resourceGroupName: string, resourceName: string, parameters: ManagedClusterServicePrincipalProfile, options?: ManagedClustersResetServicePrincipalProfileOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- parameters
- ManagedClusterServicePrincipalProfile
在托管群集上设置的服务主体配置文件。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginResetServicePrincipalProfileAndWait(string, string, ManagedClusterServicePrincipalProfile, ManagedClustersResetServicePrincipalProfileOptionalParams)
不能对未使用服务主体的群集执行此操作
function beginResetServicePrincipalProfileAndWait(resourceGroupName: string, resourceName: string, parameters: ManagedClusterServicePrincipalProfile, options?: ManagedClustersResetServicePrincipalProfileOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- parameters
- ManagedClusterServicePrincipalProfile
在托管群集上设置的服务主体配置文件。
返回
Promise<void>
beginRotateClusterCertificates(string, string, ManagedClustersRotateClusterCertificatesOptionalParams)
有关轮换托管群集证书的更多详细信息,请参阅 证书轮换。
function beginRotateClusterCertificates(resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateClusterCertificatesOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersRotateClusterCertificatesHeaders>, ManagedClustersRotateClusterCertificatesHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersRotateClusterCertificatesHeaders>, ManagedClustersRotateClusterCertificatesHeaders>>
beginRotateClusterCertificatesAndWait(string, string, ManagedClustersRotateClusterCertificatesOptionalParams)
有关轮换托管群集证书的更多详细信息,请参阅 证书轮换。
function beginRotateClusterCertificatesAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateClusterCertificatesOptionalParams): Promise<ManagedClustersRotateClusterCertificatesHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
beginRotateServiceAccountSigningKeys(string, string, ManagedClustersRotateServiceAccountSigningKeysOptionalParams)
轮换托管群集的服务帐户签名密钥。
function beginRotateServiceAccountSigningKeys(resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateServiceAccountSigningKeysOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersRotateServiceAccountSigningKeysHeaders>, ManagedClustersRotateServiceAccountSigningKeysHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersRotateServiceAccountSigningKeysHeaders>, ManagedClustersRotateServiceAccountSigningKeysHeaders>>
beginRotateServiceAccountSigningKeysAndWait(string, string, ManagedClustersRotateServiceAccountSigningKeysOptionalParams)
轮换托管群集的服务帐户签名密钥。
function beginRotateServiceAccountSigningKeysAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateServiceAccountSigningKeysOptionalParams): Promise<ManagedClustersRotateServiceAccountSigningKeysHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
返回
beginRunCommand(string, string, RunCommandRequest, ManagedClustersRunCommandOptionalParams)
AKS 将创建一个 Pod 来运行该命令。 这主要用于专用群集。 有关详细信息,请参阅 AKS 运行命令。
function beginRunCommand(resourceGroupName: string, resourceName: string, requestPayload: RunCommandRequest, options?: ManagedClustersRunCommandOptionalParams): Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- requestPayload
- RunCommandRequest
运行命令请求
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>
beginRunCommandAndWait(string, string, RunCommandRequest, ManagedClustersRunCommandOptionalParams)
AKS 将创建一个 Pod 来运行该命令。 这主要用于专用群集。 有关详细信息,请参阅 AKS 运行命令。
function beginRunCommandAndWait(resourceGroupName: string, resourceName: string, requestPayload: RunCommandRequest, options?: ManagedClustersRunCommandOptionalParams): Promise<RunCommandResult>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- requestPayload
- RunCommandRequest
运行命令请求
选项参数。
返回
Promise<RunCommandResult>
beginStart(string, string, ManagedClustersStartOptionalParams)
有关启动群集的更多详细信息,请参阅 启动群集。
function beginStart(resourceGroupName: string, resourceName: string, options?: ManagedClustersStartOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersStartHeaders>, ManagedClustersStartHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersStartHeaders>, ManagedClustersStartHeaders>>
beginStartAndWait(string, string, ManagedClustersStartOptionalParams)
有关启动群集的更多详细信息,请参阅 启动群集。
function beginStartAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersStartOptionalParams): Promise<ManagedClustersStartHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<ManagedClustersStartHeaders>
beginStop(string, string, ManagedClustersStopOptionalParams)
这只能在 Azure 虚拟机规模集支持的群集上执行。 停止群集会完全停止控制平面和代理节点,同时保持所有对象和群集状态。 群集在停止时不会产生费用。 有关停止群集的更多详细信息,请参阅 停止群集。
function beginStop(resourceGroupName: string, resourceName: string, options?: ManagedClustersStopOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersStopHeaders>, ManagedClustersStopHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersStopHeaders>, ManagedClustersStopHeaders>>
beginStopAndWait(string, string, ManagedClustersStopOptionalParams)
这只能在 Azure 虚拟机规模集支持的群集上执行。 停止群集会完全停止控制平面和代理节点,同时保持所有对象和群集状态。 群集在停止时不会产生费用。 有关停止群集的更多详细信息,请参阅 停止群集。
function beginStopAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersStopOptionalParams): Promise<ManagedClustersStopHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<ManagedClustersStopHeaders>
beginUpdateTags(string, string, TagsObject, ManagedClustersUpdateTagsOptionalParams)
更新托管群集上的标记。
function beginUpdateTags(resourceGroupName: string, resourceName: string, parameters: TagsObject, options?: ManagedClustersUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<ManagedCluster>, ManagedCluster>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- parameters
- TagsObject
提供给更新托管群集标记操作的参数。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedCluster>, ManagedCluster>>
beginUpdateTagsAndWait(string, string, TagsObject, ManagedClustersUpdateTagsOptionalParams)
更新托管群集上的标记。
function beginUpdateTagsAndWait(resourceGroupName: string, resourceName: string, parameters: TagsObject, options?: ManagedClustersUpdateTagsOptionalParams): Promise<ManagedCluster>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- parameters
- TagsObject
提供给更新托管群集标记操作的参数。
选项参数。
返回
Promise<ManagedCluster>
get(string, string, ManagedClustersGetOptionalParams)
获取托管群集。
function get(resourceGroupName: string, resourceName: string, options?: ManagedClustersGetOptionalParams): Promise<ManagedCluster>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- options
- ManagedClustersGetOptionalParams
选项参数。
返回
Promise<ManagedCluster>
getAccessProfile(string, string, string, ManagedClustersGetAccessProfileOptionalParams)
警告:此 API 将弃用。 请改用 ListClusterUserCredentials 或 ListClusterAdminCredentials。
function getAccessProfile(resourceGroupName: string, resourceName: string, roleName: string, options?: ManagedClustersGetAccessProfileOptionalParams): Promise<ManagedClusterAccessProfile>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- roleName
-
string
托管群集 accessProfile 资源的角色的名称。
选项参数。
返回
Promise<ManagedClusterAccessProfile>
getCommandResult(string, string, string, ManagedClustersGetCommandResultOptionalParams)
获取已在托管群集上运行的命令的结果。
function getCommandResult(resourceGroupName: string, resourceName: string, commandId: string, options?: ManagedClustersGetCommandResultOptionalParams): Promise<RunCommandResult>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- commandId
-
string
命令的 ID。
选项参数。
返回
Promise<RunCommandResult>
getMeshRevisionProfile(string, string, ManagedClustersGetMeshRevisionProfileOptionalParams)
包含有关修订的额外元数据,包括支持的修订、群集兼容性和可用升级
function getMeshRevisionProfile(location: string, mode: string, options?: ManagedClustersGetMeshRevisionProfileOptionalParams): Promise<MeshRevisionProfile>
参数
- location
-
string
Azure 区域的名称。
- mode
-
string
网格的模式。
选项参数。
返回
Promise<MeshRevisionProfile>
getMeshUpgradeProfile(string, string, string, ManagedClustersGetMeshUpgradeProfileOptionalParams)
获取群集中服务网格的可用升级。
function getMeshUpgradeProfile(resourceGroupName: string, resourceName: string, mode: string, options?: ManagedClustersGetMeshUpgradeProfileOptionalParams): Promise<MeshUpgradeProfile>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
- mode
-
string
网格的模式。
选项参数。
返回
Promise<MeshUpgradeProfile>
getUpgradeProfile(string, string, ManagedClustersGetUpgradeProfileOptionalParams)
获取托管群集的升级配置文件。
function getUpgradeProfile(resourceGroupName: string, resourceName: string, options?: ManagedClustersGetUpgradeProfileOptionalParams): Promise<ManagedClusterUpgradeProfile>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<ManagedClusterUpgradeProfile>
list(ManagedClustersListOptionalParams)
获取指定订阅中的托管群集的列表。
function list(options?: ManagedClustersListOptionalParams): PagedAsyncIterableIterator<ManagedCluster, ManagedCluster[], PageSettings>
参数
选项参数。
返回
listByResourceGroup(string, ManagedClustersListByResourceGroupOptionalParams)
列出指定订阅和资源组中的托管群集。
function listByResourceGroup(resourceGroupName: string, options?: ManagedClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedCluster, ManagedCluster[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
选项参数。
返回
listClusterAdminCredentials(string, string, ManagedClustersListClusterAdminCredentialsOptionalParams)
列出托管群集的管理员凭据。
function listClusterAdminCredentials(resourceGroupName: string, resourceName: string, options?: ManagedClustersListClusterAdminCredentialsOptionalParams): Promise<CredentialResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<CredentialResults>
listClusterMonitoringUserCredentials(string, string, ManagedClustersListClusterMonitoringUserCredentialsOptionalParams)
列出托管群集的群集监视用户凭据。
function listClusterMonitoringUserCredentials(resourceGroupName: string, resourceName: string, options?: ManagedClustersListClusterMonitoringUserCredentialsOptionalParams): Promise<CredentialResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
返回
Promise<CredentialResults>
listClusterUserCredentials(string, string, ManagedClustersListClusterUserCredentialsOptionalParams)
列出托管群集的用户凭据。
function listClusterUserCredentials(resourceGroupName: string, resourceName: string, options?: ManagedClustersListClusterUserCredentialsOptionalParams): Promise<CredentialResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
Promise<CredentialResults>
listKubernetesVersions(string, ManagedClustersListKubernetesVersionsOptionalParams)
包含有关版本的额外元数据,包括支持的修补程序版本、功能、可用升级以及有关版本预览状态的详细信息
function listKubernetesVersions(location: string, options?: ManagedClustersListKubernetesVersionsOptionalParams): Promise<KubernetesVersionListResult>
参数
- location
-
string
Azure 区域的名称。
选项参数。
返回
Promise<KubernetesVersionListResult>
listMeshRevisionProfiles(string, ManagedClustersListMeshRevisionProfilesOptionalParams)
包含每个修订的额外元数据,包括支持的修订、群集兼容性和可用升级
function listMeshRevisionProfiles(location: string, options?: ManagedClustersListMeshRevisionProfilesOptionalParams): PagedAsyncIterableIterator<MeshRevisionProfile, MeshRevisionProfile[], PageSettings>
参数
- location
-
string
Azure 区域的名称。
选项参数。
返回
listMeshUpgradeProfiles(string, string, ManagedClustersListMeshUpgradeProfilesOptionalParams)
列出特定群集中所有服务网格的可用升级。
function listMeshUpgradeProfiles(resourceGroupName: string, resourceName: string, options?: ManagedClustersListMeshUpgradeProfilesOptionalParams): PagedAsyncIterableIterator<MeshUpgradeProfile, MeshUpgradeProfile[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。
选项参数。
返回
listOutboundNetworkDependenciesEndpoints(string, string, ManagedClustersListOutboundNetworkDependenciesEndpointsOptionalParams)
获取指定托管群集中出口终结点(所有出站依赖项的网络终结点)的列表。 该操作返回每个出口终结点的属性。
function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, resourceName: string, options?: ManagedClustersListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- resourceName
-
string
托管群集资源的名称。