ContainerServiceAgentPoolResource 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 ContainerServiceAgentPool along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a ContainerServiceAgentPoolResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ContainerServiceManagedClusterResource using the GetContainerServiceAgentPools method.
public class ContainerServiceAgentPoolResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolData>type ContainerServiceAgentPoolResource = class
inherit ArmResource
interface IJsonModel<ContainerServiceAgentPoolData>
interface IPersistableModel<ContainerServiceAgentPoolData>Public Class ContainerServiceAgentPoolResource
Inherits ArmResource
Implements IJsonModel(Of ContainerServiceAgentPoolData), IPersistableModel(Of ContainerServiceAgentPoolData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| ContainerServiceAgentPoolResource() |
Initializes a new instance of ContainerServiceAgentPoolResource for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| AbortLatestOperation(WaitUntil, CancellationToken) |
Aborts the currently running operation on the agent pool. The Agent Pool 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 agent pool. The Agent Pool 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.
|
| 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) |
| CompleteUpgrade(WaitUntil, CancellationToken) |
Completes the upgrade operation for the specified agent pool.
|
| CompleteUpgradeAsync(WaitUntil, CancellationToken) |
Completes the upgrade operation for the specified agent pool.
|
| CreateResourceIdentifier(String, String, String, String) |
Generate the resource identifier for this resource. |
| Delete(WaitUntil, CancellationToken) |
Deletes an agent pool in the specified managed cluster.
|
| Delete(WaitUntil, Nullable<Boolean>, Nullable<ETag>, CancellationToken) |
Deletes an agent pool in the specified managed cluster.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes an agent pool in the specified managed cluster.
|
| DeleteAsync(WaitUntil, Nullable<Boolean>, Nullable<ETag>, CancellationToken) |
Deletes an agent pool in the specified managed cluster.
|
| DeleteMachines(WaitUntil, AgentPoolDeleteMachinesContent, CancellationToken) |
Deletes specific machines in an agent pool.
|
| DeleteMachinesAsync(WaitUntil, AgentPoolDeleteMachinesContent, CancellationToken) |
Deletes specific machines in an agent pool.
|
| Get(CancellationToken) |
Gets the specified managed cluster agent pool.
|
| GetAgentPoolUpgradeProfile() |
Gets an object representing a AgentPoolUpgradeProfileResource along with the instance operations that can be performed on it in the ContainerServiceAgentPoolResource. |
| GetAsync(CancellationToken) |
Gets the specified managed cluster agent pool.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetContainerServiceMachine(String, CancellationToken) |
Get a specific machine in the specified agent pool. |
| GetContainerServiceMachineAsync(String, CancellationToken) |
Get a specific machine in the specified agent pool. |
| GetContainerServiceMachines() |
Gets a collection of ContainerServiceMachines in the ContainerServiceAgentPoolResource. |
| 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) |
| 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) |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(WaitUntil, ContainerServiceAgentPoolData, MatchConditions, CancellationToken) |
Update a ContainerServiceAgentPool.
|
| Update(WaitUntil, ContainerServiceAgentPoolData, String, String, CancellationToken) |
Creates or updates an agent pool in the specified managed cluster.
|
| UpdateAsync(WaitUntil, ContainerServiceAgentPoolData, MatchConditions, CancellationToken) |
Update a ContainerServiceAgentPool.
|
| UpdateAsync(WaitUntil, ContainerServiceAgentPoolData, String, String, CancellationToken) |
Creates or updates an agent pool in the specified managed cluster.
|
| UpgradeNodeImageVersion(WaitUntil, CancellationToken) |
Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade
|
| UpgradeNodeImageVersionAsync(WaitUntil, CancellationToken) |
Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<ContainerServiceAgentPoolData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ContainerServiceAgentPoolData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ContainerServiceAgentPoolData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ContainerServiceAgentPoolData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ContainerServiceAgentPoolData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
