azure.azcollection.azure_rm_bastionhost module – Managed bastion host resource

Note

This module is part of the azure.azcollection collection (version 1.19.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_bastionhost.

New in azure.azcollection 1.13.0

Synopsis

  • Create, Update or Delete bastion host resource.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • The host that executes this module must have the azure.azcollection collection installed via galaxy

  • All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection

  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter

Comments

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

Default: "latest"

append_tags

boolean

Use to control if tags field is canonical or just appends to existing tags.

When canonical, any tags not found in the tags parameter will be removed from the object’s metadata.

Choices:

  • false

  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable 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 msi was added in Ansible 2.6.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal.

cloud_environment

string

added in azure.azcollection 0.0.1

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

Default: "AzureCloud"

disable_copy_paste

boolean

Enable or Disable Copy or Paste feature of the Bastion Host resource.

Choices:

  • false

  • true

enable_file_copy

boolean

Enable or Disable File Copy feature of the Bastion Host resource.

Choices:

  • false

  • true

enable_ip_connect

boolean

Enable or Disable IP Connect feature of the Bastion Host resource.

Choices:

  • false

  • true

boolean

Enable or Disable Shareable Link of the Bastion Host resource.

Choices:

  • false

  • true

enable_tunneling

boolean

Enable or Disable Tunneling feature of the Bastion Host resource.

Choices:

  • false

  • true

ip_configurations

list / elements=dictionary

An array of bastion host IP configurations.

name

string

The name of bastion host ip configuration.

private_ip_allocation_method

string

Private IP allocation method.

Choices:

  • "Static"

  • "Dynamic"

public_ip_address

dictionary

Reference of the PublicIP resource.

id

string

The ID of the public IP.

subnet

dictionary

Reference of the subnet resource.

id

string

The ID of the Subnet.

location

string

The resource location.

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string / required

The name of the bastion host.

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

profile

string

Security profile found in ~/.azure/credentials file.

resource_group

string / required

The name of the resource group.

scale_units

integer

The scale units for the Bastion Host resource.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

sku

dictionary

The sku of this Bastion Host.

name

string

The name of the SKU.

Choices:

  • "Standard"

  • "Basic"

state

string

Assert the state of the pirvate link service.

Use state=present to create or update the link service and state=absent to delete it.

Choices:

  • "present" ← (default)

  • "absent"

subscription_id

string

Your Azure subscription Id.

tags

dictionary

Dictionary of string:string pairs to assign as metadata to the object.

Metadata tags on the object will be updated with any provided values.

To remove tags set append_tags option to false.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

  • Authentication is also possible using a service principal or Active Directory user.

  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create bastion host info
  azure_rm_bastionhost:
    name: bastion-name
    resource_group: myResourceGroup
    ip_configurations:
      - name: testip_configuration
        subnet:
          id: "{{ subnet_output.state.id }}"
        public_ip_address:
          id: "{{ publicIP_output.publicipaddresses[0].id }}"
        private_ip_allocation_method: Dynamic
    sku:
      name: Standard
    enable_tunneling: false
    enable_shareable_link: false
    enable_ip_connect: false
    enable_file_copy: false
    scale_units: 6
    disable_copy_paste: false
    tags:
      key1: value1

- name: Create bastion host info
  azure_rm_bastionhost:
    name: bastion-name
    resource_group: myResourceGroup
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

bastion_host

complex

List of Azure bastion host info.

Returned: always

disable_copy_paste

boolean

Enable/Disable Copy/Paste feature of the Bastion Host resource.

Returned: always

Sample: false

dns_name

string

FQDN for the endpoint on which bastion host is accessible.

Returned: always

Sample: "bst-0ca1e1b6-9969-4167-be54-5972e1395c25.bastion.azure.com"

enable_file_copy

boolean

Enable/Disable File Copy feature of the Bastion Host resource.

Returned: always

Sample: false

enable_ip_connect

boolean

Enable/Disable IP Connect feature of the Bastion Host resource.

Returned: always

Sample: false

boolean

Enable/Disable Shareable Link of the Bastion Host resource.

Returned: always

Sample: false

enable_tunneling

boolean

Enable/Disable Tunneling feature of the Bastion Host resource.

Returned: always

Sample: false

etag

string

A unique read-only string that changes whenever the resource is updated.

Returned: always

Sample: "fb0e3a90-6afa-4a01-9171-9c84d144a0f3"

id

string

Resource ID of the Azure bastion host.

Returned: always

Sample: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/bastionHosts/testbastion"

ip_configurations

complex

An array of bastion host IP configurations.

Returned: always

name

string

Name of the resource that is unique within a resource group.

This name can be used to access the resource.

Returned: always

Sample: "IpConf"

private_ip_allocation_method

string

Private IP allocation method.

Returned: always

Sample: "Static"

public_ip_address

complex

Reference of the PublicIP resource.

Returned: always

id

string

The ID of the public IP address.

Returned: always

Sample: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/publicIPAddresses/Myip"

subnet

string

The reference to the subnet resource.

Returned: always

id

string

The ID of the subnet..

Returned: always

Sample: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AzureBastionSubnet"

location

string

Resource location.

Returned: always

Sample: "eastus"

name

string

Name of the Azure bastion host.

Returned: always

Sample: "linkservice"

provisioning_state

string

The provisioning state of the bastion host resource.

Returned: always

Sample: "Succeeded"

scale_units

integer

The scale units for the Bastion Host resource.

Returned: always

Sample: 2

sku

complex

The sku of this Bastion Host.

Returned: always

name

string

The name of this Bastion Host.

Returned: always

Sample: "Standard"

tags

list / elements=string

The resource tags.

Returned: always

Sample: {"key1": "value1"}

type

string

The resource type.

Returned: always

Sample: "Microsoft.Network/bastionHosts"

Authors

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)