ContainerserviceFunctions

Functions

Link copied to clipboard

Agent Pool. Uses Azure REST API version 2023-04-01. Other available API versions: 2020-06-01, 2021-02-01, 2021-08-01, 2022-04-02-preview, 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-01, 2024-10-02-preview, 2025-01-01.

suspend fun getAgentPool(agentPoolName: String, resourceGroupName: String, resourceName: String): GetAgentPoolResult
Link copied to clipboard

Get a AutoUpgradeProfile Uses Azure REST API version 2024-05-02-preview.

suspend fun getAutoUpgradeProfile(autoUpgradeProfileName: String, fleetName: String, resourceGroupName: String): GetAutoUpgradeProfileResult
Link copied to clipboard
suspend fun getFleet(argument: GetFleetPlainArgs): GetFleetResult

Gets a Fleet. Uses Azure REST API version 2023-03-15-preview. Other available API versions: 2022-07-02-preview, 2023-06-15-preview, 2023-08-15-preview, 2023-10-15, 2024-02-02-preview, 2024-04-01, 2024-05-02-preview.

suspend fun getFleet(argument: suspend GetFleetPlainArgsBuilder.() -> Unit): GetFleetResult
suspend fun getFleet(fleetName: String, resourceGroupName: String): GetFleetResult
Link copied to clipboard

Get a FleetMember Uses Azure REST API version 2023-03-15-preview. Other available API versions: 2022-07-02-preview, 2023-06-15-preview, 2023-08-15-preview, 2023-10-15, 2024-02-02-preview, 2024-04-01, 2024-05-02-preview.

suspend fun getFleetMember(fleetMemberName: String, fleetName: String, resourceGroupName: String): GetFleetMemberResult
Link copied to clipboard

Get a FleetUpdateStrategy Uses Azure REST API version 2023-08-15-preview. Other available API versions: 2023-10-15, 2024-02-02-preview, 2024-04-01, 2024-05-02-preview.

suspend fun getFleetUpdateStrategy(fleetName: String, resourceGroupName: String, updateStrategyName: String): GetFleetUpdateStrategyResult
Link copied to clipboard

The configurations regarding multiple standard load balancers. If not supplied, single load balancer mode will be used. Multiple standard load balancers mode will be used if at lease one configuration is supplied. There has to be a configuration named kubernetes. Uses Azure REST API version 2024-03-02-preview. Other available API versions: 2024-04-02-preview, 2024-05-02-preview, 2024-06-02-preview, 2024-07-02-preview, 2024-09-02-preview, 2024-10-02-preview.

suspend fun getLoadBalancer(loadBalancerName: String, resourceGroupName: String, resourceName: String): GetLoadBalancerResult
Link copied to clipboard

See planned maintenance for more information about planned maintenance. Uses Azure REST API version 2023-04-01. Other available API versions: 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-01, 2024-10-02-preview, 2025-01-01.

suspend fun getMaintenanceConfiguration(configName: String, resourceGroupName: String, resourceName: String): GetMaintenanceConfigurationResult
Link copied to clipboard

Managed cluster. Uses Azure REST API version 2023-04-01. Other available API versions: 2019-06-01, 2021-05-01, 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-01, 2024-10-02-preview, 2025-01-01.

suspend fun getManagedCluster(resourceGroupName: String, resourceName: String): GetManagedClusterResult
Link copied to clipboard

A managed cluster snapshot resource. Uses Azure REST API version 2023-05-02-preview. Other available API versions: 2023-06-02-preview, 2023-07-02-preview, 2023-08-02-preview, 2023-09-02-preview, 2023-10-02-preview, 2023-11-02-preview, 2024-01-02-preview, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-02-preview, 2024-06-02-preview, 2024-07-02-preview, 2024-09-02-preview, 2024-10-02-preview.

suspend fun getManagedClusterSnapshot(resourceGroupName: String, resourceName: String): GetManagedClusterSnapshotResult
Link copied to clipboard

Gets the details of the managed OpenShift cluster with a specified resource group and name. Uses Azure REST API version 2019-10-27-preview.

suspend fun getOpenShiftManagedCluster(resourceGroupName: String, resourceName: String): GetOpenShiftManagedClusterResult
Link copied to clipboard

To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters Uses Azure REST API version 2023-04-01. Other available API versions: 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-01, 2024-10-02-preview, 2025-01-01.

suspend fun getPrivateEndpointConnection(privateEndpointConnectionName: String, resourceGroupName: String, resourceName: String): GetPrivateEndpointConnectionResult
Link copied to clipboard

A node pool snapshot resource. Uses Azure REST API version 2023-04-01. Other available API versions: 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-01, 2024-10-02-preview, 2025-01-01.

suspend fun getSnapshot(argument: suspend GetSnapshotPlainArgsBuilder.() -> Unit): GetSnapshotResult
suspend fun getSnapshot(resourceGroupName: String, resourceName: String): GetSnapshotResult
Link copied to clipboard

Defines binding between a resource and role Uses Azure REST API version 2023-05-02-preview. Other available API versions: 2023-06-02-preview, 2023-07-02-preview, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-01, 2024-10-02-preview, 2025-01-01.

suspend fun getTrustedAccessRoleBinding(resourceGroupName: String, resourceName: String, trustedAccessRoleBindingName: String): GetTrustedAccessRoleBindingResult
Link copied to clipboard

Get a UpdateRun Uses Azure REST API version 2023-03-15-preview. Other available API versions: 2023-06-15-preview, 2023-08-15-preview, 2023-10-15, 2024-02-02-preview, 2024-04-01, 2024-05-02-preview.

suspend fun getUpdateRun(fleetName: String, resourceGroupName: String, updateRunName: String): GetUpdateRunResult
Link copied to clipboard

Lists the user credentials of a Fleet. Uses Azure REST API version 2023-03-15-preview. Other available API versions: 2022-07-02-preview, 2023-06-15-preview, 2023-08-15-preview, 2023-10-15, 2024-02-02-preview, 2024-04-01, 2024-05-02-preview.

suspend fun listFleetCredentials(fleetName: String, resourceGroupName: String): ListFleetCredentialsResult
Link copied to clipboard

Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name. Uses Azure REST API version 2020-03-01. Other available API versions: 2019-06-01.

suspend fun listManagedClusterAccessProfile(resourceGroupName: String, resourceName: String, roleName: String): ListManagedClusterAccessProfileResult
Link copied to clipboard

The list credential result response. Uses Azure REST API version 2023-04-01. Other available API versions: 2019-06-01, 2021-05-01, 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-01, 2024-10-02-preview, 2025-01-01.

suspend fun listManagedClusterAdminCredentials(resourceGroupName: String, resourceName: String, serverFqdn: String? = null): ListManagedClusterAdminCredentialsResult

The list credential result response. Uses Azure REST API version 2023-04-01. Other available API versions: 2021-05-01, 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-01, 2024-10-02-preview, 2025-01-01.

Link copied to clipboard

The list credential result response. Uses Azure REST API version 2023-04-01. Other available API versions: 2019-06-01, 2021-05-01, 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-01, 2024-10-02-preview, 2025-01-01.

suspend fun listManagedClusterUserCredentials(format: String? = null, resourceGroupName: String, resourceName: String, serverFqdn: String? = null): ListManagedClusterUserCredentialsResult