states.azurerm.network.bastion_host¶
Azure Resource Manager (ARM) Network Bastion Host State Module
New in version 4.0.0.
maintainer: | |
---|---|
configuration: | This module requires Azure Resource Manager credentials to be passed via acct. Note that the authentication parameters are case sensitive. Required provider parameters:
Optional provider parameters: cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:
Example acct setup for Azure Resource Manager authentication: azurerm:
default:
subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
tenant: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
client_id: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
secret: XXXXXXXXXXXXXXXXXXXXXXXX
cloud_environment: AZURE_PUBLIC_CLOUD
user_pass_auth:
subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
username: fletch
password: 123pass
The authentication parameters can also be passed as a dictionary of keyword arguments to the |
-
idem_azurerm.states.azurerm.network.bastion_host.
absent
(hub, ctx, name, resource_group, connection_auth=None, **kwargs)¶ New in version 4.0.0.
Ensure the specified Bastion Host does not exist in the resource group.
Parameters: - name – The name of the Bastion Host.
- resource_group – The resource group assigned to the Bastion Host.
- connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.
Example usage:
Ensure bastion host absent: azurerm.network.bastion_host.absent: - name: test_host - resource_group: test_group
-
idem_azurerm.states.azurerm.network.bastion_host.
present
(hub, ctx, name, resource_group, ip_configuration, dns_name=None, tags=None, connection_auth=None, **kwargs)¶ New in version 4.0.0.
Ensure a Bastion Host exists.
Parameters: - name – The name of the Bastion Host.
- resource_group – The resource group of the Bastion Host.
- ip_configuration –
A dictionary representing a valid BastionHostIPConfiguration object. Valid parameters include the following:
name
: (Required) The name of the BastionHostIPConfiguration resource that is unique within the resource group.public_ip_address
: (Required) The resource ID of the public IP address which will be assigned to the Bastion Host object. The public ip address must have a “Standard” sku.subnet
: (Required) The resource ID of the “AzureBastionSubnet” subnet which will be used by the Bastion Host.private_ip_allocation_method
: (Optional) The Private IP allocation method. Possible values are: ‘Static’ and ‘Dynamic’.
- dns_name – FQDN for the endpoint on which bastion host is accessible.
- tags – A dictionary of strings can be passed as tag metadata to the Bastion Host object.
- connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.
Example usage:
Ensure bastion host exists: azurerm.network.bastion_host.present: - name: test_host - resource_group: test_group - ip_configuration: name: test_config public_ip_address: pub_ip_id subnet: subnet_id - tags: contact_name: Elmer Fudd Gantry