ManagedClustersOperations interface

Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.

abortLatestOperation: (resourceGroupName: string, resourceName: string, options?: ManagedClustersAbortLatestOperationOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

beginAbortLatestOperation: (resourceGroupName: string, resourceName: string, options?: ManagedClustersAbortLatestOperationOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginAbortLatestOperationAndWait: (resourceGroupName: string, resourceName: string, options?: ManagedClustersAbortLatestOperationOptionalParams) => Promise<void>

Property Value

beginCreateOrUpdate: (resourceGroupName: string, resourceName: string, parameters: ManagedCluster, options?: ManagedClustersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ManagedCluster>, ManagedCluster>>

Property Value

beginCreateOrUpdateAndWait: (resourceGroupName: string, resourceName: string, parameters: ManagedCluster, options?: ManagedClustersCreateOrUpdateOptionalParams) => Promise<ManagedCluster>

Property Value

beginDelete: (resourceGroupName: string, resourceName: string, options?: ManagedClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginDeleteAndWait: (resourceGroupName: string, resourceName: string, options?: ManagedClustersDeleteOptionalParams) => Promise<void>

Property Value

beginRebalanceLoadBalancers: (resourceGroupName: string, resourceName: string, parameters: RebalanceLoadBalancersRequestBody, options?: ManagedClustersRebalanceLoadBalancersOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginRebalanceLoadBalancersAndWait: (resourceGroupName: string, resourceName: string, parameters: RebalanceLoadBalancersRequestBody, options?: ManagedClustersRebalanceLoadBalancersOptionalParams) => Promise<void>

Property Value

beginResetAADProfile: (resourceGroupName: string, resourceName: string, parameters: ManagedClusterAADProfile, options?: ManagedClustersResetAADProfileOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginResetAADProfileAndWait: (resourceGroupName: string, resourceName: string, parameters: ManagedClusterAADProfile, options?: ManagedClustersResetAADProfileOptionalParams) => Promise<void>

Property Value

beginResetServicePrincipalProfile: (resourceGroupName: string, resourceName: string, parameters: ManagedClusterServicePrincipalProfile, options?: ManagedClustersResetServicePrincipalProfileOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginResetServicePrincipalProfileAndWait: (resourceGroupName: string, resourceName: string, parameters: ManagedClusterServicePrincipalProfile, options?: ManagedClustersResetServicePrincipalProfileOptionalParams) => Promise<void>

Property Value

beginRotateClusterCertificates: (resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateClusterCertificatesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginRotateClusterCertificatesAndWait: (resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateClusterCertificatesOptionalParams) => Promise<void>

Property Value

beginRotateServiceAccountSigningKeys: (resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateServiceAccountSigningKeysOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginRotateServiceAccountSigningKeysAndWait: (resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateServiceAccountSigningKeysOptionalParams) => Promise<void>

Property Value

beginRunCommand: (resourceGroupName: string, resourceName: string, requestPayload: RunCommandRequest, options?: ManagedClustersRunCommandOptionalParams) => Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>

Property Value

beginRunCommandAndWait: (resourceGroupName: string, resourceName: string, requestPayload: RunCommandRequest, options?: ManagedClustersRunCommandOptionalParams) => Promise<RunCommandResult>

Property Value

beginStart: (resourceGroupName: string, resourceName: string, options?: ManagedClustersStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginStartAndWait: (resourceGroupName: string, resourceName: string, options?: ManagedClustersStartOptionalParams) => Promise<void>

Property Value

beginStop: (resourceGroupName: string, resourceName: string, options?: ManagedClustersStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

beginStopAndWait: (resourceGroupName: string, resourceName: string, options?: ManagedClustersStopOptionalParams) => Promise<void>

Property Value

beginUpdateTags: (resourceGroupName: string, resourceName: string, parameters: TagsObject, options?: ManagedClustersUpdateTagsOptionalParams) => Promise<SimplePollerLike<OperationState<ManagedCluster>, ManagedCluster>>

Property Value

beginUpdateTagsAndWait: (resourceGroupName: string, resourceName: string, parameters: TagsObject, options?: ManagedClustersUpdateTagsOptionalParams) => Promise<ManagedCluster>

Property Value

Creates or updates a managed cluster.

createOrUpdate: (resourceGroupName: string, resourceName: string, parameters: ManagedCluster, options?: ManagedClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<ManagedCluster>, ManagedCluster>

Property Value

delete: (resourceGroupName: string, resourceName: string, options?: ManagedClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

Gets a managed cluster.

get: (resourceGroupName: string, resourceName: string, options?: ManagedClustersGetOptionalParams) => Promise<ManagedCluster>

Property Value

WARNING: This API will be deprecated. Instead use ListClusterUserCredentials or ListClusterAdminCredentials .

getAccessProfile: (resourceGroupName: string, resourceName: string, roleName: string, options?: ManagedClustersGetAccessProfileOptionalParams) => Promise<ManagedClusterAccessProfile>

Property Value

Gets the results of a command which has been run on the Managed Cluster.

getCommandResult: (resourceGroupName: string, resourceName: string, commandId: string, options?: ManagedClustersGetCommandResultOptionalParams) => Promise<RunCommandResult>

Property Value

Contains Guardrails version along with its support info and whether it is a default version.

getGuardrailsVersions: (location: string, version: string, options?: ManagedClustersGetGuardrailsVersionsOptionalParams) => Promise<GuardrailsAvailableVersion>

Property Value

Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades

getMeshRevisionProfile: (location: string, mode: string, options?: ManagedClustersGetMeshRevisionProfileOptionalParams) => Promise<MeshRevisionProfile>

Property Value

Gets available upgrades for a service mesh in a cluster.

getMeshUpgradeProfile: (resourceGroupName: string, resourceName: string, mode: string, options?: ManagedClustersGetMeshUpgradeProfileOptionalParams) => Promise<MeshUpgradeProfile>

Property Value

Contains Safeguards version along with its support info and whether it is a default version.

getSafeguardsVersions: (location: string, version: string, options?: ManagedClustersGetSafeguardsVersionsOptionalParams) => Promise<SafeguardsAvailableVersion>

Property Value

Gets the upgrade profile of a managed cluster.

getUpgradeProfile: (resourceGroupName: string, resourceName: string, options?: ManagedClustersGetUpgradeProfileOptionalParams) => Promise<ManagedClusterUpgradeProfile>

Property Value

Gets a list of managed clusters in the specified subscription.

list: (options?: ManagedClustersListOptionalParams) => PagedAsyncIterableIterator<ManagedCluster, ManagedCluster[], PageSettings>

Property Value

Lists managed clusters in the specified subscription and resource group.

listByResourceGroup: (resourceGroupName: string, options?: ManagedClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ManagedCluster, ManagedCluster[], PageSettings>

Property Value

Lists the admin credentials of a managed cluster.

listClusterAdminCredentials: (resourceGroupName: string, resourceName: string, options?: ManagedClustersListClusterAdminCredentialsOptionalParams) => Promise<CredentialResults>

Property Value

Lists the cluster monitoring user credentials of a managed cluster.

listClusterMonitoringUserCredentials: (resourceGroupName: string, resourceName: string, options?: ManagedClustersListClusterMonitoringUserCredentialsOptionalParams) => Promise<CredentialResults>

Property Value

Lists the user credentials of a managed cluster.

listClusterUserCredentials: (resourceGroupName: string, resourceName: string, options?: ManagedClustersListClusterUserCredentialsOptionalParams) => Promise<CredentialResults>

Property Value

Contains list of Guardrails version along with its support info and whether it is a default version.

listGuardrailsVersions: (location: string, options?: ManagedClustersListGuardrailsVersionsOptionalParams) => PagedAsyncIterableIterator<GuardrailsAvailableVersion, GuardrailsAvailableVersion[], PageSettings>

Property Value

Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version

listKubernetesVersions: (location: string, options?: ManagedClustersListKubernetesVersionsOptionalParams) => Promise<KubernetesVersionListResult>

Property Value

Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades

listMeshRevisionProfiles: (location: string, options?: ManagedClustersListMeshRevisionProfilesOptionalParams) => PagedAsyncIterableIterator<MeshRevisionProfile, MeshRevisionProfile[], PageSettings>

Property Value

Lists available upgrades for all service meshes in a specific cluster.

listMeshUpgradeProfiles: (resourceGroupName: string, resourceName: string, options?: ManagedClustersListMeshUpgradeProfilesOptionalParams) => PagedAsyncIterableIterator<MeshUpgradeProfile, MeshUpgradeProfile[], PageSettings>

Property Value

Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.

listOutboundNetworkDependenciesEndpoints: (resourceGroupName: string, resourceName: string, options?: ManagedClustersListOutboundNetworkDependenciesEndpointsOptionalParams) => PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>

Property Value

Contains list of Safeguards version along with its support info and whether it is a default version.

listSafeguardsVersions: (location: string, options?: ManagedClustersListSafeguardsVersionsOptionalParams) => PagedAsyncIterableIterator<SafeguardsAvailableVersion, SafeguardsAvailableVersion[], PageSettings>

Property Value

Rebalance nodes across specific load balancers.

rebalanceLoadBalancers: (resourceGroupName: string, resourceName: string, parameters: RebalanceLoadBalancersRequestBody, options?: ManagedClustersRebalanceLoadBalancersOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

WARNING: This API will be deprecated. Please see AKS-managed Azure Active Directory integration to update your cluster with AKS-managed Azure AD.

resetAADProfile: (resourceGroupName: string, resourceName: string, parameters: ManagedClusterAADProfile, options?: ManagedClustersResetAADProfileOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

This action cannot be performed on a cluster that is not using a service principal

resetServicePrincipalProfile: (resourceGroupName: string, resourceName: string, parameters: ManagedClusterServicePrincipalProfile, options?: ManagedClustersResetServicePrincipalProfileOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

See Certificate rotation for more details about rotating managed cluster certificates.

rotateClusterCertificates: (resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateClusterCertificatesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

Rotates the service account signing keys of a managed cluster.

rotateServiceAccountSigningKeys: (resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateServiceAccountSigningKeysOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.

runCommand: (resourceGroupName: string, resourceName: string, requestPayload: RunCommandRequest, options?: ManagedClustersRunCommandOptionalParams) => PollerLike<OperationState<RunCommandResult>, RunCommandResult>

Property Value

See starting a cluster for more details about starting a cluster.

start: (resourceGroupName: string, resourceName: string, options?: ManagedClustersStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See stopping a cluster for more details about stopping a cluster.

stop: (resourceGroupName: string, resourceName: string, options?: ManagedClustersStopOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

Updates tags on a managed cluster.

updateTags: (resourceGroupName: string, resourceName: string, parameters: TagsObject, options?: ManagedClustersUpdateTagsOptionalParams) => PollerLike<OperationState<ManagedCluster>, ManagedCluster>

Property Value