exec.azurerm.postgresql.virtual_network_rule

Azure Resource Manager (ARM) PostgreSQL Virtual Network Rule Operations Execution Module

New in version 2.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.postgresql.virtual_network_rule.create_or_update(hub, ctx, name, server_name, resource_group, subnet_id, ignore_missing_endpoint=None, **kwargs)

New in version 2.0.0.

Creates or updates an existing virtual network rule.

Parameters:
  • name – The name of the virtual network rule.
  • server_name – The name of the server.
  • resource_group – The name of the resource group. The name is case insensitive.
  • subnet_id – The ARM Resource ID of the virtual network subnet. The ID will be in the following format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}’
  • ignore_missing_endpoint – (Optional) A boolean value representing whether the firewall rule is created before the virtual network has the vnet service endpoint enabled.

CLI Example:

azurerm.postgresql.virtual_network_rule.create_or_update test_name test_server test_group test_subnet
idem_azurerm.exec.azurerm.postgresql.virtual_network_rule.delete(hub, ctx, name, server_name, resource_group, **kwargs)

New in version 2.0.0.

Deletes the virtual network rule with the given name.

Parameters:
  • name – The name of the virtual network rule.
  • server_name – The name of the server.
  • resource_group – The name of the resource group. The name is case insensitive.

CLI Example:

azurerm.postgresql.virtual_network_rule.delete test_name test_server test_group
idem_azurerm.exec.azurerm.postgresql.virtual_network_rule.get(hub, ctx, name, server_name, resource_group, **kwargs)

New in version 2.0.0.

Gets a virtual network rule.

Parameters:
  • name – The name of the virtual network rule.
  • server_name – The name of the server.
  • resource_group – The name of the resource group. The name is case insensitive.

CLI Example:

azurerm.postgresql.virtual_network_rule.get test_name test_server test_group
idem_azurerm.exec.azurerm.postgresql.virtual_network_rule.list_by_server(hub, ctx, server_name, resource_group, **kwargs)

New in version 2.0.0.

Gets a list of virtual network rules in a server.

Parameters:
  • server_name – The name of the server.
  • resource_group – The name of the resource group. The name is case insensitive.

CLI Example:

azurerm.postgresql.virtual_network_rule.list_by_server test_server test_group