exec.azurerm.network.local_network_gateway¶
Azure Resource Manager (ARM) Local Network Gateway Execution Module
New in version 1.0.0.
Changed in version 4.0.0.
maintainer: | |
---|---|
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:
Optional provider parameters: cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:
|
-
idem_azurerm.exec.azurerm.network.local_network_gateway.
create_or_update
(hub, ctx, name, resource_group, gateway_ip_address, bgp_settings=None, address_prefixes=None, fqdn=None, **kwargs)¶ New in version 1.0.0.
Changed in version 4.0.0.
Creates or updates a local network gateway object in the specified resource group.
Parameters: - name – The name of the local network gateway object to be created or updated.
- resource_group – The name of the resource group associated with the local network gateway.
- gateway_ip_address – IP address of the local network gateway.
- bgp_settings –
A dictionary representing a valid BgpSettings object, which stores the local network gateway’s BGP speaker settings. Valid parameters include:
asn
: (Required) The BGP speaker’s Autonomous System Number. This is an integer value.bgp_peering_address
: (Required) The BGP peering address and BGP identifier of this BGP speaker. This is a string value.peer_weight
: (Optional) The weight added to routes learned from this BGP speaker. This is an Integer value.
- address_prefixes – (Optional) A list of address blocks reserved for this virtual network in CIDR notation. Serves as the local network gateway’s site address space.
- fqdn – The FQDN of local network gateway.
CLI Example:
azurerm.network.local_network_gateway.create_or_update test_name test_group test_ip
-
idem_azurerm.exec.azurerm.network.local_network_gateway.
delete
(hub, ctx, name, resource_group, **kwargs)¶ New in version 1.0.0.
Deletes the specified local network gateway.
Parameters: - name – The name of the local network gateway that will be deleted.
- resource_group – The name of the resource group.
CLI Example:
azurerm.network.local_network_gateway.delete test_name test_group
-
idem_azurerm.exec.azurerm.network.local_network_gateway.
get
(hub, ctx, name, resource_group, **kwargs)¶ New in version 1.0.0.
Gets the details of a specific local network gateway within a specified resource group.
Parameters: - name – The name of the local network gateway.
- resource_group – The name of the resource group.
CLI Example:
azurerm.network.local_network_gateway.get test_name test_group
-
idem_azurerm.exec.azurerm.network.local_network_gateway.
list_
(hub, ctx, resource_group, **kwargs)¶ New in version 1.0.0.
Lists all local network gateways within a resource group.
Parameters: resource_group – The name of the resource group. CLI Example:
azurerm.network.local_network_gateway.list test_group
New in version 4.0.0.
Updates local network gateway tags with specified values.
Parameters: - name – The name of the local network gateway.
- resource_group – The name of the resource group to which the local network gateway belongs.
- tags – The tags of the resource.
CLI Example:
azurerm.network.local_network_gateway.update_tags test_name test_group tags='{"owner": "me"}'