ContainerServiceManagedClusterResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.ContainerService
Assembly:
Azure.ResourceManager.ContainerService.dll
Package:
Azure.ResourceManager.ContainerService v1.2.1
Package:
Azure.ResourceManager.ContainerService v1.2.0-beta.3
Source:
ContainerServiceManagedClusterResource.cs
Source:
ContainerServiceManagedClusterResource.cs

A Class representing a ContainerServiceManagedCluster along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a ContainerServiceManagedClusterResource from an instance of ArmClient using the GetContainerServiceManagedClusterResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetContainerServiceManagedCluster method.

public class ContainerServiceManagedClusterResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ContainerService.ContainerServiceManagedClusterData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ContainerService.ContainerServiceManagedClusterData>
public class ContainerServiceManagedClusterResource : Azure.ResourceManager.ArmResource
type ContainerServiceManagedClusterResource = class
    inherit ArmResource
    interface IJsonModel<ContainerServiceManagedClusterData>
    interface IPersistableModel<ContainerServiceManagedClusterData>
type ContainerServiceManagedClusterResource = class
    inherit ArmResource
Public Class ContainerServiceManagedClusterResource
Inherits ArmResource
Implements IJsonModel(Of ContainerServiceManagedClusterData), IPersistableModel(Of ContainerServiceManagedClusterData)
Public Class ContainerServiceManagedClusterResource
Inherits ArmResource
Inheritance
Object
ArmResource
ContainerServiceManagedClusterResource
Implements
IJsonModel<ContainerServiceManagedClusterData> IPersistableModel<ContainerServiceManagedClusterData> IPersistableModel<T>

Constructors

ContainerServiceManagedClusterResource()

Initializes a new instance of the ContainerServiceManagedClusterResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.
Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

AbortLatestOperation(WaitUntil, CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort
  • Operation Id: ManagedClusters_AbortLatestOperation
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
AbortLatestOperationAsync(WaitUntil, CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort
  • Operation Id: ManagedClusters_AbortLatestOperation
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
  • Operation Id: ManagedClusters_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
  • Operation Id: ManagedClusters_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)

Generate the resource identifier of a ContainerServiceManagedClusterResource instance.
Get(CancellationToken)

Gets a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
  • Operation Id: ManagedClusters_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
GetAccessProfile(String, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential
  • Operation Id: ManagedClusters_GetAccessProfile
  • Default Api Version: 2023-10-01
GetAccessProfileAsync(String, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential
  • Operation Id: ManagedClusters_GetAccessProfile
  • Default Api Version: 2023-10-01
GetAsync(CancellationToken)

Gets a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
  • Operation Id: ManagedClusters_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
GetAvailableAgentPoolVersions(CancellationToken)

See supported Kubernetes versions for more details about the version lifecycle.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions
  • Operation Id: AgentPools_GetAvailableAgentPoolVersions
  • Default Api Version: 2023-10-01
GetAvailableAgentPoolVersionsAsync(CancellationToken)

See supported Kubernetes versions for more details about the version lifecycle.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions
  • Operation Id: AgentPools_GetAvailableAgentPoolVersions
  • Default Api Version: 2023-10-01
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetClusterAdminCredentials(String, CancellationToken)

Lists the admin credentials of a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential
  • Operation Id: ManagedClusters_ListClusterAdminCredentials
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
GetClusterAdminCredentialsAsync(String, CancellationToken)

Lists the admin credentials of a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential
  • Operation Id: ManagedClusters_ListClusterAdminCredentials
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
GetClusterMonitoringUserCredentials(String, CancellationToken)

Lists the cluster monitoring user credentials of a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential
  • Operation Id: ManagedClusters_ListClusterMonitoringUserCredentials
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
GetClusterMonitoringUserCredentialsAsync(String, CancellationToken)

Lists the cluster monitoring user credentials of a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential
  • Operation Id: ManagedClusters_ListClusterMonitoringUserCredentials
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
GetClusterUserCredentials(String, Nullable<KubeConfigFormat>, CancellationToken)

Lists the user credentials of a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential
  • Operation Id: ManagedClusters_ListClusterUserCredentials
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
GetClusterUserCredentialsAsync(String, Nullable<KubeConfigFormat>, CancellationToken)

Lists the user credentials of a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential
  • Operation Id: ManagedClusters_ListClusterUserCredentials
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
GetCommandResult(String, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}
  • Operation Id: ManagedClusters_GetCommandResult
  • Default Api Version: 2023-10-01
GetCommandResultAsync(String, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}
  • Operation Id: ManagedClusters_GetCommandResult
  • Default Api Version: 2023-10-01
GetContainerServiceAgentPool(String, CancellationToken)

Gets the specified managed cluster agent pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
  • Operation Id: AgentPools_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceAgentPoolResource
GetContainerServiceAgentPoolAsync(String, CancellationToken)

Gets the specified managed cluster agent pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
  • Operation Id: AgentPools_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceAgentPoolResource
GetContainerServiceAgentPools()

Gets a collection of ContainerServiceAgentPoolResources in the ContainerServiceManagedCluster.
GetContainerServiceMaintenanceConfiguration(String, CancellationToken)

Gets the specified maintenance configuration of a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}
  • Operation Id: MaintenanceConfigurations_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceMaintenanceConfigurationResource
GetContainerServiceMaintenanceConfigurationAsync(String, CancellationToken)

Gets the specified maintenance configuration of a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}
  • Operation Id: MaintenanceConfigurations_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceMaintenanceConfigurationResource
GetContainerServiceMaintenanceConfigurations()

Gets a collection of ContainerServiceMaintenanceConfigurationResources in the ContainerServiceManagedCluster.
GetContainerServicePrivateEndpointConnection(String, CancellationToken)

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServicePrivateEndpointConnectionResource
GetContainerServicePrivateEndpointConnectionAsync(String, CancellationToken)

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServicePrivateEndpointConnectionResource
GetContainerServicePrivateEndpointConnections()

Gets a collection of ContainerServicePrivateEndpointConnectionResources in the ContainerServiceManagedCluster.
GetContainerServiceTrustedAccessRoleBinding(String, CancellationToken)

Get a trusted access role binding.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}
  • Operation Id: TrustedAccessRoleBindings_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceTrustedAccessRoleBindingResource
GetContainerServiceTrustedAccessRoleBindingAsync(String, CancellationToken)

Get a trusted access role binding.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}
  • Operation Id: TrustedAccessRoleBindings_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceTrustedAccessRoleBindingResource
GetContainerServiceTrustedAccessRoleBindings()

Gets a collection of ContainerServiceTrustedAccessRoleBindingResources in the ContainerServiceManagedCluster.
GetManagedClusterUpgradeProfile()

Gets an object representing a ManagedClusterUpgradeProfileResource along with the instance operations that can be performed on it in the ContainerServiceManagedCluster.
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetMeshUpgradeProfile(String, CancellationToken)

Gets available upgrades for a service mesh in a cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}
  • Operation Id: ManagedClusters_GetMeshUpgradeProfile
  • Default Api Version: 2023-10-01
  • Resource: MeshUpgradeProfileResource
GetMeshUpgradeProfileAsync(String, CancellationToken)

Gets available upgrades for a service mesh in a cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}
  • Operation Id: ManagedClusters_GetMeshUpgradeProfile
  • Default Api Version: 2023-10-01
  • Resource: MeshUpgradeProfileResource
GetMeshUpgradeProfiles()

Gets a collection of MeshUpgradeProfileResources in the ContainerServiceManagedCluster.
GetOutboundNetworkDependenciesEndpoints(CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints
  • Operation Id: ManagedClusters_ListOutboundNetworkDependenciesEndpoints
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
GetOutboundNetworkDependenciesEndpointsAsync(CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints
  • Operation Id: ManagedClusters_ListOutboundNetworkDependenciesEndpoints
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetPrivateLinkResources(CancellationToken)

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources
  • Operation Id: PrivateLinkResources_List
  • Default Api Version: 2023-10-01
GetPrivateLinkResourcesAsync(CancellationToken)

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources
  • Operation Id: PrivateLinkResources_List
  • Default Api Version: 2023-10-01
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
  • Operation Id: ManagedClusters_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
  • Operation Id: ManagedClusters_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
ResetAadProfile(WaitUntil, ManagedClusterAadProfile, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile
  • Operation Id: ManagedClusters_ResetAADProfile
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
ResetAadProfileAsync(WaitUntil, ManagedClusterAadProfile, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile
  • Operation Id: ManagedClusters_ResetAADProfile
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
ResetServicePrincipalProfile(WaitUntil, ManagedClusterServicePrincipalProfile, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile
  • Operation Id: ManagedClusters_ResetServicePrincipalProfile
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
ResetServicePrincipalProfileAsync(WaitUntil, ManagedClusterServicePrincipalProfile, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile
  • Operation Id: ManagedClusters_ResetServicePrincipalProfile
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
ResolvePrivateLinkServiceId(ContainerServicePrivateLinkResourceData, CancellationToken)

Gets the private link service ID for the specified managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId
  • Operation Id: ResolvePrivateLinkServiceId_POST
  • Default Api Version: 2023-10-01
ResolvePrivateLinkServiceIdAsync(ContainerServicePrivateLinkResourceData, CancellationToken)

Gets the private link service ID for the specified managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId
  • Operation Id: ResolvePrivateLinkServiceId_POST
  • Default Api Version: 2023-10-01
RotateClusterCertificates(WaitUntil, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates
  • Operation Id: ManagedClusters_RotateClusterCertificates
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
RotateClusterCertificatesAsync(WaitUntil, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates
  • Operation Id: ManagedClusters_RotateClusterCertificates
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
RotateServiceAccountSigningKeys(WaitUntil, CancellationToken)

Rotates the service account signing keys of a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys
  • Operation Id: ManagedClusters_RotateServiceAccountSigningKeys
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
RotateServiceAccountSigningKeysAsync(WaitUntil, CancellationToken)

Rotates the service account signing keys of a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys
  • Operation Id: ManagedClusters_RotateServiceAccountSigningKeys
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
RunCommand(WaitUntil, ManagedClusterRunCommandContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand
  • Operation Id: ManagedClusters_RunCommand
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
RunCommandAsync(WaitUntil, ManagedClusterRunCommandContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand
  • Operation Id: ManagedClusters_RunCommand
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
  • Operation Id: ManagedClusters_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
  • Operation Id: ManagedClusters_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
Start(WaitUntil, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start
  • Operation Id: ManagedClusters_Start
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
StartAsync(WaitUntil, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start
  • Operation Id: ManagedClusters_Start
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
Stop(WaitUntil, CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop
  • Operation Id: ManagedClusters_Stop
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
StopAsync(WaitUntil, CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop
  • Operation Id: ManagedClusters_Stop
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, ContainerServiceTagsObject, CancellationToken)

Updates tags on a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
  • Operation Id: ManagedClusters_UpdateTags
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource
UpdateAsync(WaitUntil, ContainerServiceTagsObject, CancellationToken)

Updates tags on a managed cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}
  • Operation Id: ManagedClusters_UpdateTags
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceManagedClusterResource

Explicit Interface Implementations

IJsonModel<ContainerServiceManagedClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ContainerServiceManagedClusterData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ContainerServiceManagedClusterData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<ContainerServiceManagedClusterData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ContainerServiceManagedClusterData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to