exec.azurerm.network.bastion_host

Azure Resource Manager (ARM) Network Bastion Host Execution Module

New in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:
cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud.
Possible values:
  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.network.bastion_host.create_or_update(hub, ctx, name, resource_group, ip_configuration, dns_name=None, **kwargs)

New in version 4.0.0.

Creates or updates the specified Bastion Host.

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.

CLI Example:

azurerm.network.bastion_host.create_or_update test_name test_group test_configs
idem_azurerm.exec.azurerm.network.bastion_host.delete(hub, ctx, name, resource_group, **kwargs)

New in version 4.0.0.

Deletes the specified Bastion Host.

Parameters:
  • name – The name of the Bastion Host to delete.
  • resource_group – The resource group of the Bastion Host.

CLI Example:

azurerm.network.bastion_host.delete test_name test_group
idem_azurerm.exec.azurerm.network.bastion_host.get(hub, ctx, name, resource_group, **kwargs)

New in version 4.0.0.

Gets the specified Bastion Host within the specified resource group.

Parameters:
  • name – The name of the Bastion Host to query.
  • resource_group – The resource group of the Bastion Host.

CLI Example:

azurerm.network.bastion_host.get test_name test_group
idem_azurerm.exec.azurerm.network.bastion_host.list_(hub, ctx, resource_group=None, **kwargs)

New in version 4.0.0.

Lists all Bastion Hosts in a subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.network.bastion_host.list