azure / azure.azcollection / 2.3.0 / module / azure_rm_bastionhost_info Get Azure bastion host info | "added in version" 1.13.0 of azure.azcollection" Authors: xuzhang3 (@xuzhang3), Fred-sun (@Fred-sun)azure.azcollection.azure_rm_bastionhost_info (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Get facts for Azure bastion host info.
- name: Get bastion host info by name azure_rm_bastionhost_info: name: bastion-name resource_group: myResourceGroup
- name: Get all bastion host by resource group azure_rm_bastionhost_info: resource_group: myResourceGroup
- name: Get all bastion hoste by subscription filter by tags azure_rm_bastionhost_info: tags: - key1 - abc
name: description: - Name of the bastion host. type: str tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. elements: str type: list 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 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 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 resource_group: description: - The name of the resource group. type: str 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 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: complex 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