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)
WARNING:此 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)
WARNING:此 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)
WARNING:此 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
命令的識別碼。
選項參數。
傳回
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
受控叢集資源的名稱。