/ home / ansible / ansible.builtin / v2.9.17 / module / azure_rm_aksversion_info

ansible.builtin.azure_rm_aksversion_info (v2.9.17) — module

Get available kubernetes versions supported by Azure Kubernetes Service

| "added in version" 2.9 of ansible.builtin"

Authors: Yuwei Zhou (@yuwzho)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.9.17

Description

Get available kubernetes versions supported by Azure Kubernetes Service.

Requirements

python >= 2.7
azure >= 2.0.0

Usage examples

Scanned by Steampunk Spotter

    - name: Get available versions for AKS in location eastus
      azure_rm_aksversion_info:
        location: eastus

Scanned by Steampunk Spotter

    - name: Get  available versions an AKS can be upgrade to
      azure_rm_aksversion_info:
        location: eastis
        version: 1.11.6

Inputs

secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str

tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str

ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str

profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str

version:
description:
- Get the upgrade versions available for a managed Kubernetes cluster version.

location:
description:
- Get the versions available for creating a managed Kubernetes cluster.
required: true

password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str

client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str

api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection

auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used
to identify the subscription ID if more than one is present otherwise the default
az cli subscription is used.
- When set to C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID)
can be used to identify the subscription ID if the resource is granted access to
more than one subscription, otherwise the first subscription is chosen.
- The C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection

subscription_id:
description:
- Your Azure subscription Id.
type: str

cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection

adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection

cert_validation_mode:
choices:
- ignore
- validate
description:
- Controls the certificate validation behavior for Azure endpoints. By default, all
modules will validate the server certificate, but when an HTTPS proxy is in use,
or against Azure Stack, it may be necessary to disable this behavior by passing
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection

Outputs

azure_aks_versions:
  description: List of supported kubernetes versions.
  returned: always
  type: list

Install Ansible via pip