exec.azurerm.network.public_ip_address¶
Azure Resource Manager (ARM) Network Public IP Address 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.public_ip_address.
create_or_update
(hub, ctx, name, resource_group, **kwargs)¶ New in version 1.0.0.
Creates or updates a static or dynamic public IP address.
Parameters: - name – The name of the public IP address to create.
- resource_group – The resource group of the public IP address.
CLI Example:
azurerm.network.public_ip_address.create_or_update test-ip-0 testgroup
-
idem_azurerm.exec.azurerm.network.public_ip_address.
delete
(hub, ctx, name, resource_group, **kwargs)¶ New in version 1.0.0.
Delete a public IP address.
Parameters: - name – The name of the public IP address to delete.
- resource_group – The resource group name assigned to the public IP address.
CLI Example:
azurerm.network.public_ip_address.delete test-pub-ip testgroup
-
idem_azurerm.exec.azurerm.network.public_ip_address.
get
(hub, ctx, name, resource_group, expand=None, **kwargs)¶ New in version 1.0.0.
Changed in version 4.0.0.
Gets the specified public IP address in a specified resource group.
Parameters: - name – The name of the public IP address to query.
- resource_group – The resource group of the public IP address.
- expand – Expands referenced resources.
CLI Example:
azurerm.network.public_ip_address.get test-pub-ip testgroup
-
idem_azurerm.exec.azurerm.network.public_ip_address.
list_
(hub, ctx, resource_group=None, **kwargs)¶ New in version 1.0.0.
Changed in version 4.0.0.
Gets all the public IP addresses in a subscription.
Parameters: resource_group – The name of the resource group to limit the results. CLI Example:
azurerm.network.public_ip_address.list
New in version 4.0.0.
Updates public IP address tags.
Parameters: - name – The name of the public IP address.
- resource_group – The resource group of the public IP address.
- tags – The resource tags to update.
CLI Example:
azurerm.network.public_ip_address.update_tags test_name test_group test_tags