ContainerServiceManagedClusterResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
- Implements
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.
|
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.
|
AddTag(String, String, CancellationToken) |
Add a tag to the current resource.
|
AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
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.
|
GetAccessProfile(String, CancellationToken) |
WARNING: This API will be deprecated. Instead use ListClusterUserCredentials or ListClusterAdminCredentials .
|
GetAccessProfileAsync(String, CancellationToken) |
WARNING: This API will be deprecated. Instead use ListClusterUserCredentials or ListClusterAdminCredentials .
|
GetAsync(CancellationToken) |
Gets a managed cluster.
|
GetAvailableAgentPoolVersions(CancellationToken) |
See supported Kubernetes versions for more details about the version lifecycle.
|
GetAvailableAgentPoolVersionsAsync(CancellationToken) |
See supported Kubernetes versions for more details about the version lifecycle.
|
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.
|
GetClusterAdminCredentialsAsync(String, CancellationToken) |
Lists the admin credentials of a managed cluster.
|
GetClusterMonitoringUserCredentials(String, CancellationToken) |
Lists the cluster monitoring user credentials of a managed cluster.
|
GetClusterMonitoringUserCredentialsAsync(String, CancellationToken) |
Lists the cluster monitoring user credentials of a managed cluster.
|
GetClusterUserCredentials(String, Nullable<KubeConfigFormat>, CancellationToken) |
Lists the user credentials of a managed cluster.
|
GetClusterUserCredentialsAsync(String, Nullable<KubeConfigFormat>, CancellationToken) |
Lists the user credentials of a managed cluster.
|
GetCommandResult(String, CancellationToken) |
Gets the results of a command which has been run on the Managed Cluster.
|
GetCommandResultAsync(String, CancellationToken) |
Gets the results of a command which has been run on the Managed Cluster.
|
GetContainerServiceAgentPool(String, CancellationToken) |
Gets the specified managed cluster agent pool.
|
GetContainerServiceAgentPoolAsync(String, CancellationToken) |
Gets the specified managed cluster agent pool.
|
GetContainerServiceAgentPools() |
Gets a collection of ContainerServiceAgentPoolResources in the ContainerServiceManagedCluster. |
GetContainerServiceMaintenanceConfiguration(String, CancellationToken) |
Gets the specified maintenance configuration of a managed cluster.
|
GetContainerServiceMaintenanceConfigurationAsync(String, CancellationToken) |
Gets the specified maintenance configuration of a managed cluster.
|
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
|
GetContainerServicePrivateEndpointConnectionAsync(String, CancellationToken) |
To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
|
GetContainerServicePrivateEndpointConnections() |
Gets a collection of ContainerServicePrivateEndpointConnectionResources in the ContainerServiceManagedCluster. |
GetContainerServiceTrustedAccessRoleBinding(String, CancellationToken) |
Get a trusted access role binding.
|
GetContainerServiceTrustedAccessRoleBindingAsync(String, CancellationToken) |
Get a trusted access role binding.
|
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.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
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.
|
GetMeshUpgradeProfileAsync(String, CancellationToken) |
Gets available upgrades for a service mesh in a cluster.
|
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.
|
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.
|
GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
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
|
GetPrivateLinkResourcesAsync(CancellationToken) |
To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters
|
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.
|
RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
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.
|
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.
|
ResetServicePrincipalProfile(WaitUntil, ManagedClusterServicePrincipalProfile, CancellationToken) |
This action cannot be performed on a cluster that is not using a service principal
|
ResetServicePrincipalProfileAsync(WaitUntil, ManagedClusterServicePrincipalProfile, CancellationToken) |
This action cannot be performed on a cluster that is not using a service principal
|
ResolvePrivateLinkServiceId(ContainerServicePrivateLinkResourceData, CancellationToken) |
Gets the private link service ID for the specified managed cluster.
|
ResolvePrivateLinkServiceIdAsync(ContainerServicePrivateLinkResourceData, CancellationToken) |
Gets the private link service ID for the specified managed cluster.
|
RotateClusterCertificates(WaitUntil, CancellationToken) |
See Certificate rotation for more details about rotating managed cluster certificates.
|
RotateClusterCertificatesAsync(WaitUntil, CancellationToken) |
See Certificate rotation for more details about rotating managed cluster certificates.
|
RotateServiceAccountSigningKeys(WaitUntil, CancellationToken) |
Rotates the service account signing keys of a managed cluster.
|
RotateServiceAccountSigningKeysAsync(WaitUntil, CancellationToken) |
Rotates the service account signing keys of a managed cluster.
|
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.
|
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.
|
SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
Start(WaitUntil, CancellationToken) |
See starting a cluster for more details about starting a cluster.
|
StartAsync(WaitUntil, CancellationToken) |
See starting a cluster for more details about starting a cluster.
|
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.
|
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.
|
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.
|
UpdateAsync(WaitUntil, ContainerServiceTagsObject, CancellationToken) |
Updates tags on a managed cluster.
|
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).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
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.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
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.
|
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
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
|
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
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.
|
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
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
|
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
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.
|
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
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
|
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
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
|
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.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |