ManagedClusters | @azure/arm-containerservice

Interface representing a ManagedClusters.

Hierarchy

ManagedClusters

Implemented by

ManagedClustersImpl

Index

Methods

abortLatestOperation

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

- Defined in operationsInterfaces/managedClusters.ts:311
Aborting last running operation on managed cluster. We return a 204 no content code here to indicate that the operation has been accepted and an abort will be attempted but is not guaranteed to complete successfully. Please look up the provisioning state of the managed cluster to keep track of whether it changes to Canceled. A canceled provisioning state indicates that the abort was successful

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersAbortLatestOperationOptionalParams
  
  The options parameters.
Returns Promise<void>

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: ManagedCluster, options?: ManagedClustersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ManagedClustersCreateOrUpdateResponse>, ManagedClustersCreateOrUpdateResponse>>

- Defined in operationsInterfaces/managedClusters.ts:172
Creates or updates a managed cluster.

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.
- Optional options: ManagedClustersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ManagedClustersCreateOrUpdateResponse>, ManagedClustersCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/managedClusters.ts:190
Creates or updates a managed cluster.

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.
- Optional options: ManagedClustersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, resourceName: string, options?: ManagedClustersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/managedClusters.ts:233
Deletes a managed cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/managedClusters.ts:244
Deletes a managed cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginResetAADProfile

beginResetAADProfile(resourceGroupName: string, resourceName: string, parameters: ManagedClusterAADProfile, options?: ManagedClustersResetAADProfileOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/managedClusters.ts:282
Reset the AAD Profile of a managed cluster.

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
- Optional options: ManagedClustersResetAADProfileOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginResetAADProfileAndWait

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

- Defined in operationsInterfaces/managedClusters.ts:295
Reset the AAD Profile of a managed cluster.

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
- Optional options: ManagedClustersResetAADProfileOptionalParams
  
  The options parameters.
Returns Promise<void>

beginResetServicePrincipalProfile

beginResetServicePrincipalProfile(resourceGroupName: string, resourceName: string, parameters: ManagedClusterServicePrincipalProfile, options?: ManagedClustersResetServicePrincipalProfileOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/managedClusters.ts:256
This action cannot be performed on a cluster that is not using a service principal

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.
- Optional options: ManagedClustersResetServicePrincipalProfileOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginResetServicePrincipalProfileAndWait

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

- Defined in operationsInterfaces/managedClusters.ts:269
This action cannot be performed on a cluster that is not using a service principal

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.
- Optional options: ManagedClustersResetServicePrincipalProfileOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRotateClusterCertificates

beginRotateClusterCertificates(resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateClusterCertificatesOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/managedClusters.ts:323
See Certificate rotation for more details about rotating managed cluster certificates.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersRotateClusterCertificatesOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRotateClusterCertificatesAndWait

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

- Defined in operationsInterfaces/managedClusters.ts:335
See Certificate rotation for more details about rotating managed cluster certificates.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersRotateClusterCertificatesOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRotateServiceAccountSigningKeys

beginRotateServiceAccountSigningKeys(resourceGroupName: string, resourceName: string, options?: ManagedClustersRotateServiceAccountSigningKeysOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/managedClusters.ts:346
Rotates the service account signing keys of a managed cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersRotateServiceAccountSigningKeysOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRotateServiceAccountSigningKeysAndWait

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

- Defined in operationsInterfaces/managedClusters.ts:357
Rotates the service account signing keys of a managed cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersRotateServiceAccountSigningKeysOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRunCommand

beginRunCommand(resourceGroupName: string, resourceName: string, requestPayload: RunCommandRequest, options?: ManagedClustersRunCommandOptionalParams): Promise<PollerLike<PollOperationState<ManagedClustersRunCommandResponse>, ManagedClustersRunCommandResponse>>

- Defined in operationsInterfaces/managedClusters.ts:425
AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.

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
- Optional options: ManagedClustersRunCommandOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ManagedClustersRunCommandResponse>, ManagedClustersRunCommandResponse>>

beginRunCommandAndWait

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

- Defined in operationsInterfaces/managedClusters.ts:445
AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see AKS Run Command.

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
- Optional options: ManagedClustersRunCommandOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersRunCommandResponse>

beginStart

beginStart(resourceGroupName: string, resourceName: string, options?: ManagedClustersStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/managedClusters.ts:399
See starting a cluster for more details about starting a cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersStartOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStartAndWait

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

- Defined in operationsInterfaces/managedClusters.ts:411
See starting a cluster for more details about starting a cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersStartOptionalParams
  
  The options parameters.
Returns Promise<void>

beginStop

beginStop(resourceGroupName: string, resourceName: string, options?: ManagedClustersStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/managedClusters.ts:372
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersStopOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginStopAndWait

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

- Defined in operationsInterfaces/managedClusters.ts:387
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersStopOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdateTags

beginUpdateTags(resourceGroupName: string, resourceName: string, parameters: TagsObject, options?: ManagedClustersUpdateTagsOptionalParams): Promise<PollerLike<PollOperationState<ManagedClustersUpdateTagsResponse>, ManagedClustersUpdateTagsResponse>>

- Defined in operationsInterfaces/managedClusters.ts:203
Updates tags on a managed cluster.

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.
- Optional options: ManagedClustersUpdateTagsOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ManagedClustersUpdateTagsResponse>, ManagedClustersUpdateTagsResponse>>

beginUpdateTagsAndWait

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

- Defined in operationsInterfaces/managedClusters.ts:221
Updates tags on a managed cluster.

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.
- Optional options: ManagedClustersUpdateTagsOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersUpdateTagsResponse>

get

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

- Defined in operationsInterfaces/managedClusters.ts:160
Gets a managed cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersGetOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersGetResponse>

getAccessProfile

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

- Defined in operationsInterfaces/managedClusters.ts:115
WARNING: This API will be deprecated. Instead use ListClusterUserCredentials or ListClusterAdminCredentials .

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.
- Optional options: ManagedClustersGetAccessProfileOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersGetAccessProfileResponse>

getCommandResult

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

- Defined in operationsInterfaces/managedClusters.ts:458
Gets the results of a command which has been run on the Managed Cluster.

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.
- Optional options: ManagedClustersGetCommandResultOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersGetCommandResultResponse>

getOSOptions

getOSOptions(location: string, options?: ManagedClustersGetOSOptionsOptionalParams): Promise<ManagedClustersGetOSOptionsResponse>

- Defined in operationsInterfaces/managedClusters.ts:89
Gets supported OS options in the specified subscription.

Parameters
- location: string
  
  The name of Azure region.
- Optional options: ManagedClustersGetOSOptionsOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersGetOSOptionsResponse>

getUpgradeProfile

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

- Defined in operationsInterfaces/managedClusters.ts:99
Gets the upgrade profile of a managed cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersGetUpgradeProfileOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersGetUpgradeProfileResponse>

list

list(options?: ManagedClustersListOptionalParams): PagedAsyncIterableIterator<ManagedCluster>

- Defined in operationsInterfaces/managedClusters.ts:60
Gets a list of managed clusters in the specified subscription.

Parameters
- Optional options: ManagedClustersListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedCluster>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ManagedClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedCluster>

- Defined in operationsInterfaces/managedClusters.ts:68
Lists managed clusters in the specified subscription and resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: ManagedClustersListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedCluster>

listClusterAdminCredentials

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

- Defined in operationsInterfaces/managedClusters.ts:127
Lists the admin credentials of a managed cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersListClusterAdminCredentialsOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersListClusterAdminCredentialsResponse>

listClusterMonitoringUserCredentials

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

- Defined in operationsInterfaces/managedClusters.ts:149
Lists the cluster monitoring user credentials of a managed cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersListClusterMonitoringUserCredentialsOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersListClusterMonitoringUserCredentialsResponse>

listClusterUserCredentials

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

- Defined in operationsInterfaces/managedClusters.ts:138
Lists the user credentials of a managed cluster.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersListClusterUserCredentialsOptionalParams
  
  The options parameters.
Returns Promise<ManagedClustersListClusterUserCredentialsResponse>

listOutboundNetworkDependenciesEndpoints

listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, resourceName: string, options?: ManagedClustersListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint>

- Defined in operationsInterfaces/managedClusters.ts:79
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.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- resourceName: string
  
  The name of the managed cluster resource.
- Optional options: ManagedClustersListOutboundNetworkDependenciesEndpointsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<OutboundEnvironmentEndpoint>

Hierarchy

Implemented by

Index

Methods

Methods

abortLatestOperation

Parameters

resourceGroupName: string

resourceName: string

Optional options: ManagedClustersAbortLatestOperationOptionalParams

Returns Promise<void>

beginCreateOrUpdate

Parameters

resourceGroupName: string

resourceName: string

parameters: ManagedCluster

Optional options: ManagedClustersCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ManagedClustersCreateOrUpdateResponse>, ManagedClustersCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: ManagedCluster

Optional options: ManagedClustersCreateOrUpdateOptionalParams

Returns Promise<ManagedClustersCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

resourceName: string

Optional options: ManagedClustersDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

resourceName: string

Optional options: ManagedClustersDeleteOptionalParams

Returns Promise<void>

beginResetAADProfile

Parameters

resourceGroupName: string

resourceName: string

parameters: ManagedClusterAADProfile

Optional options: ManagedClustersResetAADProfileOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginResetAADProfileAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: ManagedClusterAADProfile

Optional options: ManagedClustersResetAADProfileOptionalParams

Returns Promise<void>

beginResetServicePrincipalProfile

Parameters

resourceGroupName: string

resourceName: string

parameters: ManagedClusterServicePrincipalProfile

Optional options: ManagedClustersResetServicePrincipalProfileOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginResetServicePrincipalProfileAndWait

Parameters

resourceGroupName: string

resourceName: string

parameters: ManagedClusterServicePrincipalProfile

Optional options: ManagedClustersResetServicePrincipalProfileOptionalParams

Returns Promise<void>

beginRotateClusterCertificates

Parameters

resourceGroupName: string

resourceName: string

Optional options: ManagedClustersRotateClusterCertificatesOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginRotateClusterCertificatesAndWait

Parameters

resourceGroupName: string

resourceName: string

Optional options: ManagedClustersRotateClusterCertificatesOptionalParams

Returns Promise<void>

beginRotateServiceAccountSigningKeys

Parameters

resourceGroupName: string