ManagedClusters interface
Interface representing a ManagedClusters.
Methods
Method Details
beginAbortLatestOperation(string, string, ManagedClustersAbortLatestOperationOptionalParams)
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.
function beginAbortLatestOperation(resourceGroupName: string, resourceName: string, options?: ManagedClustersAbortLatestOperationOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersAbortLatestOperationHeaders>, ManagedClustersAbortLatestOperationHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersAbortLatestOperationHeaders>, ManagedClustersAbortLatestOperationHeaders>>
beginAbortLatestOperationAndWait(string, string, ManagedClustersAbortLatestOperationOptionalParams)
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.
function beginAbortLatestOperationAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersAbortLatestOperationOptionalParams): Promise<ManagedClustersAbortLatestOperationHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
beginCreateOrUpdate(string, string, ManagedCluster, ManagedClustersCreateOrUpdateOptionalParams)
Creates or updates a managed cluster.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: ManagedCluster, options?: ManagedClustersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedCluster>, ManagedCluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- parameters
- ManagedCluster
The managed cluster to create or update.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedCluster>, ManagedCluster>>
beginCreateOrUpdateAndWait(string, string, ManagedCluster, ManagedClustersCreateOrUpdateOptionalParams)
Creates or updates a managed cluster.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: ManagedCluster, options?: ManagedClustersCreateOrUpdateOptionalParams): Promise<ManagedCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- parameters
- ManagedCluster
The managed cluster to create or update.
The options parameters.
Returns
Promise<ManagedCluster>
beginDelete(string, string, ManagedClustersDeleteOptionalParams)
Deletes a managed cluster.
function beginDelete(resourceGroupName: string, resourceName: string, options?: ManagedClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersDeleteHeaders>, ManagedClustersDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersDeleteHeaders>, ManagedClustersDeleteHeaders>>
beginDeleteAndWait(string, string, ManagedClustersDeleteOptionalParams)
Deletes a managed cluster.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersDeleteOptionalParams): Promise<ManagedClustersDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<ManagedClustersDeleteHeaders>
beginResetAADProfile(string, string, ManagedClusterAADProfile, ManagedClustersResetAADProfileOptionalParams)
WARNING: This API will be deprecated. Please see AKS-managed Azure Active Directory integration to update your cluster with AKS-managed Azure AD.
function beginResetAADProfile(resourceGroupName: string, resourceName: string, parameters: ManagedClusterAADProfile, options?: ManagedClustersResetAADProfileOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- parameters
- ManagedClusterAADProfile
The AAD profile to set on the Managed Cluster
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginResetAADProfileAndWait(string, string, ManagedClusterAADProfile, ManagedClustersResetAADProfileOptionalParams)
WARNING: This API will be deprecated. Please see AKS-managed Azure Active Directory integration to update your cluster with AKS-managed Azure AD.
function beginResetAADProfileAndWait(resourceGroupName: string, resourceName: string, parameters: ManagedClusterAADProfile, options?: ManagedClustersResetAADProfileOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- parameters
- ManagedClusterAADProfile
The AAD profile to set on the Managed Cluster
The options parameters.
Returns
Promise<void>
beginResetServicePrincipalProfile(string, string, ManagedClusterServicePrincipalProfile, ManagedClustersResetServicePrincipalProfileOptionalParams)
This action cannot be performed on a cluster that is not using a service principal
function beginResetServicePrincipalProfile(resourceGroupName: string, resourceName: string, parameters: ManagedClusterServicePrincipalProfile, options?: ManagedClustersResetServicePrincipalProfileOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- parameters
- ManagedClusterServicePrincipalProfile
The service principal profile to set on the managed cluster.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginResetServicePrincipalProfileAndWait(string, string, ManagedClusterServicePrincipalProfile, ManagedClustersResetServicePrincipalProfileOptionalParams)
This action cannot be performed on a cluster that is not using a service principal
function beginResetServicePrincipalProfileAndWait(resourceGroupName: string, resourceName: string, parameters: ManagedClusterServicePrincipalProfile, options?: ManagedClustersResetServicePrincipalProfileOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- parameters
- ManagedClusterServicePrincipalProfile
The service principal profile to set on the managed cluster.
The options parameters.
Returns
Promise<void>
beginRotateClusterCertificates(string, string, ManagedClustersRotateClusterCertificatesOptionalParams)
See Certificate rotation for more details about rotating managed cluster certificates.
function beginRotateClusterCertificates(resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateClusterCertificatesOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersRotateClusterCertificatesHeaders>, ManagedClustersRotateClusterCertificatesHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersRotateClusterCertificatesHeaders>, ManagedClustersRotateClusterCertificatesHeaders>>
beginRotateClusterCertificatesAndWait(string, string, ManagedClustersRotateClusterCertificatesOptionalParams)
See Certificate rotation for more details about rotating managed cluster certificates.
function beginRotateClusterCertificatesAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateClusterCertificatesOptionalParams): Promise<ManagedClustersRotateClusterCertificatesHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
beginRotateServiceAccountSigningKeys(string, string, ManagedClustersRotateServiceAccountSigningKeysOptionalParams)
Rotates the service account signing keys of a managed cluster.
function beginRotateServiceAccountSigningKeys(resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateServiceAccountSigningKeysOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersRotateServiceAccountSigningKeysHeaders>, ManagedClustersRotateServiceAccountSigningKeysHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersRotateServiceAccountSigningKeysHeaders>, ManagedClustersRotateServiceAccountSigningKeysHeaders>>
beginRotateServiceAccountSigningKeysAndWait(string, string, ManagedClustersRotateServiceAccountSigningKeysOptionalParams)
Rotates the service account signing keys of a managed cluster.
function beginRotateServiceAccountSigningKeysAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateServiceAccountSigningKeysOptionalParams): Promise<ManagedClustersRotateServiceAccountSigningKeysHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
beginRunCommand(string, string, RunCommandRequest, ManagedClustersRunCommandOptionalParams)
AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.
function beginRunCommand(resourceGroupName: string, resourceName: string, requestPayload: RunCommandRequest, options?: ManagedClustersRunCommandOptionalParams): Promise<SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- requestPayload
- RunCommandRequest
The run command request
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RunCommandResult>, RunCommandResult>>
beginRunCommandAndWait(string, string, RunCommandRequest, ManagedClustersRunCommandOptionalParams)
AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.
function beginRunCommandAndWait(resourceGroupName: string, resourceName: string, requestPayload: RunCommandRequest, options?: ManagedClustersRunCommandOptionalParams): Promise<RunCommandResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- requestPayload
- RunCommandRequest
The run command request
The options parameters.
Returns
Promise<RunCommandResult>
beginStart(string, string, ManagedClustersStartOptionalParams)
See starting a cluster for more details about starting a cluster.
function beginStart(resourceGroupName: string, resourceName: string, options?: ManagedClustersStartOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersStartHeaders>, ManagedClustersStartHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersStartHeaders>, ManagedClustersStartHeaders>>
beginStartAndWait(string, string, ManagedClustersStartOptionalParams)
See starting a cluster for more details about starting a cluster.
function beginStartAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersStartOptionalParams): Promise<ManagedClustersStartHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<ManagedClustersStartHeaders>
beginStop(string, string, ManagedClustersStopOptionalParams)
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.
function beginStop(resourceGroupName: string, resourceName: string, options?: ManagedClustersStopOptionalParams): Promise<SimplePollerLike<OperationState<ManagedClustersStopHeaders>, ManagedClustersStopHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedClustersStopHeaders>, ManagedClustersStopHeaders>>
beginStopAndWait(string, string, ManagedClustersStopOptionalParams)
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.
function beginStopAndWait(resourceGroupName: string, resourceName: string, options?: ManagedClustersStopOptionalParams): Promise<ManagedClustersStopHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<ManagedClustersStopHeaders>
beginUpdateTags(string, string, TagsObject, ManagedClustersUpdateTagsOptionalParams)
Updates tags on a managed cluster.
function beginUpdateTags(resourceGroupName: string, resourceName: string, parameters: TagsObject, options?: ManagedClustersUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<ManagedCluster>, ManagedCluster>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- parameters
- TagsObject
Parameters supplied to the Update Managed Cluster Tags operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedCluster>, ManagedCluster>>
beginUpdateTagsAndWait(string, string, TagsObject, ManagedClustersUpdateTagsOptionalParams)
Updates tags on a managed cluster.
function beginUpdateTagsAndWait(resourceGroupName: string, resourceName: string, parameters: TagsObject, options?: ManagedClustersUpdateTagsOptionalParams): Promise<ManagedCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- parameters
- TagsObject
Parameters supplied to the Update Managed Cluster Tags operation.
The options parameters.
Returns
Promise<ManagedCluster>
get(string, string, ManagedClustersGetOptionalParams)
Gets a managed cluster.
function get(resourceGroupName: string, resourceName: string, options?: ManagedClustersGetOptionalParams): Promise<ManagedCluster>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- options
- ManagedClustersGetOptionalParams
The options parameters.
Returns
Promise<ManagedCluster>
getAccessProfile(string, string, string, ManagedClustersGetAccessProfileOptionalParams)
WARNING: This API will be deprecated. Instead use ListClusterUserCredentials or ListClusterAdminCredentials .
function getAccessProfile(resourceGroupName: string, resourceName: string, roleName: string, options?: ManagedClustersGetAccessProfileOptionalParams): Promise<ManagedClusterAccessProfile>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- roleName
-
string
The name of the role for managed cluster accessProfile resource.
The options parameters.
Returns
Promise<ManagedClusterAccessProfile>
getCommandResult(string, string, string, ManagedClustersGetCommandResultOptionalParams)
Gets the results of a command which has been run on the Managed Cluster.
function getCommandResult(resourceGroupName: string, resourceName: string, commandId: string, options?: ManagedClustersGetCommandResultOptionalParams): Promise<RunCommandResult>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- commandId
-
string
Id of the command.
The options parameters.
Returns
Promise<RunCommandResult>
getMeshRevisionProfile(string, string, ManagedClustersGetMeshRevisionProfileOptionalParams)
Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades
function getMeshRevisionProfile(location: string, mode: string, options?: ManagedClustersGetMeshRevisionProfileOptionalParams): Promise<MeshRevisionProfile>Parameters
- location
-
string
The name of the Azure region.
- mode
-
string
The mode of the mesh.
The options parameters.
Returns
Promise<MeshRevisionProfile>
getMeshUpgradeProfile(string, string, string, ManagedClustersGetMeshUpgradeProfileOptionalParams)
Gets available upgrades for a service mesh in a cluster.
function getMeshUpgradeProfile(resourceGroupName: string, resourceName: string, mode: string, options?: ManagedClustersGetMeshUpgradeProfileOptionalParams): Promise<MeshUpgradeProfile>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- mode
-
string
The mode of the mesh.
The options parameters.
Returns
Promise<MeshUpgradeProfile>
getUpgradeProfile(string, string, ManagedClustersGetUpgradeProfileOptionalParams)
Gets the upgrade profile of a managed cluster.
function getUpgradeProfile(resourceGroupName: string, resourceName: string, options?: ManagedClustersGetUpgradeProfileOptionalParams): Promise<ManagedClusterUpgradeProfile>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<ManagedClusterUpgradeProfile>
list(ManagedClustersListOptionalParams)
Gets a list of managed clusters in the specified subscription.
function list(options?: ManagedClustersListOptionalParams): PagedAsyncIterableIterator<ManagedCluster, ManagedCluster[], PageSettings>Parameters
The options parameters.
Returns
listByResourceGroup(string, ManagedClustersListByResourceGroupOptionalParams)
Lists managed clusters in the specified subscription and resource group.
function listByResourceGroup(resourceGroupName: string, options?: ManagedClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedCluster, ManagedCluster[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listClusterAdminCredentials(string, string, ManagedClustersListClusterAdminCredentialsOptionalParams)
Lists the admin credentials of a managed cluster.
function listClusterAdminCredentials(resourceGroupName: string, resourceName: string, options?: ManagedClustersListClusterAdminCredentialsOptionalParams): Promise<CredentialResults>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<CredentialResults>
listClusterMonitoringUserCredentials(string, string, ManagedClustersListClusterMonitoringUserCredentialsOptionalParams)
Lists the cluster monitoring user credentials of a managed cluster.
function listClusterMonitoringUserCredentials(resourceGroupName: string, resourceName: string, options?: ManagedClustersListClusterMonitoringUserCredentialsOptionalParams): Promise<CredentialResults>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<CredentialResults>
listClusterUserCredentials(string, string, ManagedClustersListClusterUserCredentialsOptionalParams)
Lists the user credentials of a managed cluster.
function listClusterUserCredentials(resourceGroupName: string, resourceName: string, options?: ManagedClustersListClusterUserCredentialsOptionalParams): Promise<CredentialResults>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<CredentialResults>
listKubernetesVersions(string, ManagedClustersListKubernetesVersionsOptionalParams)
Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version
function listKubernetesVersions(location: string, options?: ManagedClustersListKubernetesVersionsOptionalParams): Promise<KubernetesVersionListResult>Parameters
- location
-
string
The name of the Azure region.
The options parameters.
Returns
Promise<KubernetesVersionListResult>
listMeshRevisionProfiles(string, ManagedClustersListMeshRevisionProfilesOptionalParams)
Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades
function listMeshRevisionProfiles(location: string, options?: ManagedClustersListMeshRevisionProfilesOptionalParams): PagedAsyncIterableIterator<MeshRevisionProfile, MeshRevisionProfile[], PageSettings>Parameters
- location
-
string
The name of the Azure region.
The options parameters.
Returns
listMeshUpgradeProfiles(string, string, ManagedClustersListMeshUpgradeProfilesOptionalParams)
Lists available upgrades for all service meshes in a specific cluster.
function listMeshUpgradeProfiles(resourceGroupName: string, resourceName: string, options?: ManagedClustersListMeshUpgradeProfilesOptionalParams): PagedAsyncIterableIterator<MeshUpgradeProfile, MeshUpgradeProfile[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
listOutboundNetworkDependenciesEndpoints(string, string, ManagedClustersListOutboundNetworkDependenciesEndpointsOptionalParams)
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.
function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, resourceName: string, options?: ManagedClustersListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.