Skip to main content

auto_upgrade_profiles

Creates, updates, deletes, gets or lists an auto_upgrade_profiles resource.

Overview​

Nameauto_upgrade_profiles
TypeResource
Idazure.container_service_fleet.auto_upgrade_profiles

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
autoUpgradeProfileStatusobjectThe status of the auto upgrade profile.
channelstringConfigures how auto-upgrade will be run. Required. Known values are: "Stable", "Rapid", "NodeImage", and "TargetKubernetesVersion". (Stable, Rapid, NodeImage, TargetKubernetesVersion)
disabledbooleanIf set to False: the auto upgrade has effect - target managed clusters will be upgraded on schedule. If set to True: the auto upgrade has no effect - no upgrade will be run on the target managed clusters. This is a boolean and not an enum because enabled/disabled are all available states of the auto upgrade profile. By default, this is set to False.
eTagstringIf eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
longTermSupportbooleanIf upgrade channel is not TargetKubernetesVersion, this field must be False. If set to True: Fleet auto upgrade will continue generate update runs for patches of minor versions earlier than N-2 (where N is the latest supported minor version) if those minor versions support Long-Term Support (LTS). By default, this is set to False. For more information on AKS LTS, please see https://learn.microsoft.com/en-us/azure/aks/long-term-support _.
nodeImageSelectionobjectThe node image upgrade to be applied to the target clusters in auto upgrade.
provisioningStatestringThe provisioning state of the AutoUpgradeProfile resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
targetKubernetesVersionstringThis is the target Kubernetes version for auto-upgrade. The format must be {major version}.{minor version}. For example, "1.30". By default, this is empty. If upgrade channel is set to TargetKubernetesVersion, this field must not be empty. If upgrade channel is Rapid, Stable or NodeImage, this field must be empty.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateStrategyIdstringThe resource id of the UpdateStrategy resource to reference. If not specified, the auto upgrade will run on all clusters which are members of the fleet.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, fleet_name, auto_upgrade_profile_name, subscription_idGet a AutoUpgradeProfile.
list_by_fleetselectresource_group_name, fleet_name, subscription_id$top, $skipTokenList AutoUpgradeProfile resources by Fleet.
create_or_updateinsertresource_group_name, fleet_name, auto_upgrade_profile_name, subscription_idCreate a AutoUpgradeProfile.
create_or_updatereplaceresource_group_name, fleet_name, auto_upgrade_profile_name, subscription_idCreate a AutoUpgradeProfile.
deletedeleteresource_group_name, fleet_name, auto_upgrade_profile_name, subscription_idDelete a AutoUpgradeProfile.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
auto_upgrade_profile_namestringThe name of the AutoUpgradeProfile resource. Required.
fleet_namestringThe name of the Fleet resource. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring
$skipTokenstringThe page-continuation token to use with a paged version of this API. Default value is None.
$topintegerThe number of result items to return. Default value is None.

SELECT examples​

Get a AutoUpgradeProfile.

SELECT
id,
name,
autoUpgradeProfileStatus,
channel,
disabled,
eTag,
longTermSupport,
nodeImageSelection,
provisioningState,
systemData,
targetKubernetesVersion,
type,
updateStrategyId
FROM azure.container_service_fleet.auto_upgrade_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND auto_upgrade_profile_name = '{{ auto_upgrade_profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create a AutoUpgradeProfile.

INSERT INTO azure.container_service_fleet.auto_upgrade_profiles (
properties,
resource_group_name,
fleet_name,
auto_upgrade_profile_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ fleet_name }}',
'{{ auto_upgrade_profile_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
properties,
systemData,
type
;

REPLACE examples​

Create a AutoUpgradeProfile.

REPLACE azure.container_service_fleet.auto_upgrade_profiles
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND auto_upgrade_profile_name = '{{ auto_upgrade_profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
properties,
systemData,
type;

DELETE examples​

Delete a AutoUpgradeProfile.

DELETE FROM azure.container_service_fleet.auto_upgrade_profiles
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND auto_upgrade_profile_name = '{{ auto_upgrade_profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;