Try SpotterManaged bastion host resource
| "added in version" 1.13.0 of azure.azcollection"
Authors: xuzhang3 (@xuzhang3), Fred-sun (@Fred-sun)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, Update or Delete bastion host resource.
- 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
sku:
description:
- The sku of this Bastion Host.
suboptions:
name:
choices:
- Standard
- Basic
description:
- The name of the SKU.
type: str
type: dict
name:
description:
- The name of the bastion host.
required: true
type: str
tags:
description:
- 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.
type: dict
state:
choices:
- present
- absent
default: present
description:
- Assert the state of the pirvate link service.
- Use I(state=present) to create or update the link service and I(state=absent) to
delete it.
type: str
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
location:
description:
- The resource location.
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
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 or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
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
append_tags:
default: true
description:
- 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.
type: bool
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
scale_units:
description:
- The scale units for the Bastion Host resource.
type: int
resource_group:
description:
- The name of the resource group.
required: true
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
enable_file_copy:
description:
- Enable or Disable File Copy feature of the Bastion Host resource.
type: bool
enable_tunneling:
description:
- Enable or Disable Tunneling feature of the Bastion Host resource.
type: bool
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
enable_ip_connect:
description:
- Enable or Disable IP Connect feature of the Bastion Host resource.
type: bool
ip_configurations:
description:
- An array of bastion host IP configurations.
elements: dict
suboptions:
name:
description:
- The name of bastion host ip configuration.
type: str
private_ip_allocation_method:
choices:
- Static
- Dynamic
description:
- Private IP allocation method.
type: str
public_ip_address:
description:
- Reference of the PublicIP resource.
suboptions:
id:
description:
- The ID of the public IP.
type: str
type: dict
subnet:
description:
- Reference of the subnet resource.
suboptions:
id:
description:
- The ID of the Subnet.
type: str
type: dict
type: list
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
disable_copy_paste:
description:
- Enable or Disable Copy or Paste feature of the Bastion Host resource.
type: bool
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
enable_shareable_link:
description:
- Enable or Disable Shareable Link of the Bastion Host resource.
type: bool
x509_certificate_path:
description:
- 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.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
disable_instance_discovery:
default: false
description:
- Determines whether or not instance discovery is performed when attempting to authenticate.
Setting this to true will completely disable both instance discovery and authority
validation. This functionality is intended for use in scenarios where the metadata
endpoint cannot be reached such as in private clouds or Azure Stack. The process
of instance discovery entails retrieving authority metadata from https://login.microsoft.com/
to validate the authority. By setting this to **True**, the validation of the authority
is disabled. As a result, it is crucial to ensure that the configured authority
host is valid and trustworthy.
- Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
bastion_host:
contains:
disable_copy_paste:
description:
- Enable/Disable Copy/Paste feature of the Bastion Host resource.
returned: always
sample: false
type: bool
dns_name:
description:
- FQDN for the endpoint on which bastion host is accessible.
returned: always
sample: bst-0ca1e1b6-9969-4167-be54-5972e1395c25.bastion.azure.com
type: str
enable_file_copy:
description:
- Enable/Disable File Copy feature of the Bastion Host resource.
returned: always
sample: false
type: bool
enable_ip_connect:
description:
- Enable/Disable IP Connect feature of the Bastion Host resource.
returned: always
sample: false
type: bool
enable_shareable_link:
description:
- Enable/Disable Shareable Link of the Bastion Host resource.
returned: always
sample: false
type: bool
enable_tunneling:
description:
- Enable/Disable Tunneling feature of the Bastion Host resource.
returned: always
sample: false
type: bool
etag:
description:
- A unique read-only string that changes whenever the resource is updated.
returned: always
sample: fb0e3a90-6afa-4a01-9171-9c84d144a0f3
type: str
id:
description:
- Resource ID of the Azure bastion host.
returned: always
sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/bastionHosts/testbastion
type: str
ip_configurations:
contains:
name:
description:
- Name of the resource that is unique within a resource group.
- This name can be used to access the resource.
returned: always
sample: IpConf
type: str
private_ip_allocation_method:
description:
- Private IP allocation method.
returned: always
sample: Static
type: str
public_ip_address:
contains:
id:
description:
- The ID of the public IP address.
returned: always
sample: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/publicIPAddresses/Myip
type: str
description:
- Reference of the PublicIP resource.
returned: always
type: complex
subnet:
contains:
id:
description:
- The ID of the subnet..
returned: always
sample: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AzureBastionSubnet
type: str
description:
- The reference to the subnet resource.
returned: always
type: str
description:
- An array of bastion host IP configurations.
returned: always
type: complex
location:
description:
- Resource location.
returned: always
sample: eastus
type: str
name:
description:
- Name of the Azure bastion host.
returned: always
sample: linkservice
type: str
provisioning_state:
description:
- The provisioning state of the bastion host resource.
returned: always
sample: Succeeded
type: str
scale_units:
description:
- The scale units for the Bastion Host resource.
returned: always
sample: 2
type: int
sku:
contains:
name:
description:
- The name of this Bastion Host.
returned: always
sample: Standard
type: str
description:
- The sku of this Bastion Host.
returned: always
type: complex
tags:
description:
- The resource tags.
returned: always
sample:
key1: value1
type: list
type:
description:
- The resource type.
returned: always
sample: Microsoft.Network/bastionHosts
type: str
description:
- List of Azure bastion host info.
returned: always
type: complex