virtual_hub_ip_configuration

Creates, updates, deletes, gets or lists a virtual_hub_ip_configuration resource.

Overview

Name	virtual_hub_ip_configuration
Type	Resource
Id	azure.network.virtual_hub_ip_configuration

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
privateIPAddress	string	The private IP address of the IP configuration.
privateIPAllocationMethod	string	The private IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic)
provisioningState	string	The provisioning state of the IP configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddress	object	The reference to the public IP resource.
subnet	object	Subnet in a virtual network resource.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
privateIPAddress	string	The private IP address of the IP configuration.
privateIPAllocationMethod	string	The private IP address allocation method. Known values are: "Static" and "Dynamic". (Static, Dynamic)
provisioningState	string	The provisioning state of the IP configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddress	object	The reference to the public IP resource.
subnet	object	Subnet in a virtual network resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_hub_name, ip_config_name, subscription_id		Retrieves the details of a Virtual Hub Ip configuration.
list	select	resource_group_name, virtual_hub_name, subscription_id		Retrieves the details of all VirtualHubIpConfigurations.
create_or_update	insert	resource_group_name, virtual_hub_name, ip_config_name, subscription_id		Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.
create_or_update	replace	resource_group_name, virtual_hub_name, ip_config_name, subscription_id		Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.
delete	delete	resource_group_name, virtual_hub_name, ip_config_name, subscription_id		Deletes a VirtualHubIpConfiguration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ip_config_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_hub_name	string	The name of the VirtualHub. Required.

SELECT examples

get

Retrieves the details of a Virtual Hub Ip configuration.

SELECT
id,
name,
etag,
privateIPAddress,
privateIPAllocationMethod,
provisioningState,
publicIPAddress,
subnet,
type
FROM azure.network.virtual_hub_ip_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND ip_config_name = '{{ ip_config_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Retrieves the details of all VirtualHubIpConfigurations.

SELECT
id,
name,
etag,
privateIPAddress,
privateIPAllocationMethod,
provisioningState,
publicIPAddress,
subnet,
type
FROM azure.network.virtual_hub_ip_configuration
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_hub_name = '{{ virtual_hub_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.

INSERT INTO azure.network.virtual_hub_ip_configuration (
id,
name,
properties,
resource_group_name,
virtual_hub_name,
ip_config_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ virtual_hub_name }}',
'{{ ip_config_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_hub_ip_configuration
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_hub_ip_configuration resource.
  - name: virtual_hub_name
    value: "{{ virtual_hub_name }}"
    description: Required parameter for the virtual_hub_ip_configuration resource.
  - name: ip_config_name
    value: "{{ ip_config_name }}"
    description: Required parameter for the virtual_hub_ip_configuration resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_hub_ip_configuration resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      The properties of the Virtual Hub IPConfigurations.
    value:
      privateIPAddress: "{{ privateIPAddress }}"
      privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
      subnet:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        properties:
          addressPrefix: "{{ addressPrefix }}"
          addressPrefixes:
            - "{{ addressPrefixes }}"
          networkSecurityGroup:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            location: "{{ location }}"
            tags: "{{ tags }}"
            properties:
              flushConnection: {{ flushConnection }}
              securityRules: "{{ securityRules }}"
              defaultSecurityRules: "{{ defaultSecurityRules }}"
              networkInterfaces: "{{ networkInterfaces }}"
              subnets: "{{ subnets }}"
              flowLogs: "{{ flowLogs }}"
              resourceGuid: "{{ resourceGuid }}"
              provisioningState: "{{ provisioningState }}"
            etag: "{{ etag }}"
          routeTable:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            location: "{{ location }}"
            tags: "{{ tags }}"
            properties:
              routes: "{{ routes }}"
              subnets: "{{ subnets }}"
              disableBgpRoutePropagation: {{ disableBgpRoutePropagation }}
              disablePeeringRoute: "{{ disablePeeringRoute }}"
              provisioningState: "{{ provisioningState }}"
              resourceGuid: "{{ resourceGuid }}"
            etag: "{{ etag }}"
          natGateway:
            id: "{{ id }}"
          serviceEndpoints:
            - service: "{{ service }}"
              networkIdentifier:
                id: "{{ id }}"
              locations: "{{ locations }}"
              provisioningState: "{{ provisioningState }}"
          serviceEndpointPolicies:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                serviceEndpointPolicyDefinitions: "{{ serviceEndpointPolicyDefinitions }}"
                subnets: "{{ subnets }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                serviceAlias: "{{ serviceAlias }}"
                contextualServiceEndpointPolicies: "{{ contextualServiceEndpointPolicies }}"
              etag: "{{ etag }}"
              kind: "{{ kind }}"
          privateEndpoints:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                subnet: "{{ subnet }}"
                networkInterfaces: "{{ networkInterfaces }}"
                provisioningState: "{{ provisioningState }}"
                ipVersionType: "{{ ipVersionType }}"
                privateLinkServiceConnections: "{{ privateLinkServiceConnections }}"
                manualPrivateLinkServiceConnections: "{{ manualPrivateLinkServiceConnections }}"
                customDnsConfigs: "{{ customDnsConfigs }}"
                applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                ipConfigurations: "{{ ipConfigurations }}"
                customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
                billingSku: "{{ billingSku }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
          ipConfigurations:
            - id: "{{ id }}"
              properties:
                privateIPAddress: "{{ privateIPAddress }}"
                privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                subnet: "{{ subnet }}"
                publicIPAddress: "{{ publicIPAddress }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
          ipConfigurationProfiles:
            - id: "{{ id }}"
              properties:
                subnet: "{{ subnet }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              type: "{{ type }}"
              etag: "{{ etag }}"
          ipAllocations:
            - id: "{{ id }}"
          resourceNavigationLinks:
            - id: "{{ id }}"
              properties:
                linkedResourceType: "{{ linkedResourceType }}"
                link: "{{ link }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
              type: "{{ type }}"
          serviceAssociationLinks:
            - id: "{{ id }}"
              properties:
                linkedResourceType: "{{ linkedResourceType }}"
                link: "{{ link }}"
                provisioningState: "{{ provisioningState }}"
                allowDelete: {{ allowDelete }}
                locations: "{{ locations }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
              type: "{{ type }}"
          delegations:
            - id: "{{ id }}"
              properties:
                serviceName: "{{ serviceName }}"
                actions: "{{ actions }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
              type: "{{ type }}"
          purpose: "{{ purpose }}"
          provisioningState: "{{ provisioningState }}"
          privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
          privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
          applicationGatewayIPConfigurations:
            - id: "{{ id }}"
              properties:
                subnet: "{{ subnet }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
              type: "{{ type }}"
          sharingScope: "{{ sharingScope }}"
          defaultOutboundAccess: {{ defaultOutboundAccess }}
          ipamPoolPrefixAllocations:
            - pool:
                id: "{{ id }}"
              numberOfIpAddresses: "{{ numberOfIpAddresses }}"
              allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
          serviceGateway:
            id: "{{ id }}"
        etag: "{{ etag }}"
      publicIPAddress:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        location: "{{ location }}"
        tags: "{{ tags }}"
        properties:
          publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
          publicIPAddressVersion: "{{ publicIPAddressVersion }}"
          ipConfiguration:
            id: "{{ id }}"
            properties:
              privateIPAddress: "{{ privateIPAddress }}"
              privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
              subnet: "{{ subnet }}"
              publicIPAddress: "{{ publicIPAddress }}"
              provisioningState: "{{ provisioningState }}"
            name: "{{ name }}"
            etag: "{{ etag }}"
          dnsSettings:
            domainNameLabel: "{{ domainNameLabel }}"
            domainNameLabelScope: "{{ domainNameLabelScope }}"
            fqdn: "{{ fqdn }}"
            reverseFqdn: "{{ reverseFqdn }}"
          ddosSettings:
            protectionMode: "{{ protectionMode }}"
            ddosCustomPolicy:
              id: "{{ id }}"
            ddosProtectionPlan:
              id: "{{ id }}"
          ipTags:
            - ipTagType: "{{ ipTagType }}"
              tag: "{{ tag }}"
          ipAddress: "{{ ipAddress }}"
          publicIPPrefix:
            id: "{{ id }}"
          idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
          resourceGuid: "{{ resourceGuid }}"
          provisioningState: "{{ provisioningState }}"
          servicePublicIPAddress:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            location: "{{ location }}"
            tags: "{{ tags }}"
            properties:
              publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
              publicIPAddressVersion: "{{ publicIPAddressVersion }}"
              ipConfiguration: "{{ ipConfiguration }}"
              dnsSettings: "{{ dnsSettings }}"
              ddosSettings: "{{ ddosSettings }}"
              ipTags: "{{ ipTags }}"
              ipAddress: "{{ ipAddress }}"
              publicIPPrefix: "{{ publicIPPrefix }}"
              idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
              resourceGuid: "{{ resourceGuid }}"
              provisioningState: "{{ provisioningState }}"
              servicePublicIPAddress: "{{ servicePublicIPAddress }}"
              natGateway: "{{ natGateway }}"
              migrationPhase: "{{ migrationPhase }}"
              linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
              deleteOption: "{{ deleteOption }}"
            extendedLocation:
              name: "{{ name }}"
              type: "{{ type }}"
            sku:
              name: "{{ name }}"
              tier: "{{ tier }}"
            etag: "{{ etag }}"
            zones:
              - "{{ zones }}"
          natGateway:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            location: "{{ location }}"
            tags: "{{ tags }}"
            properties:
              idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
              publicIpAddresses: "{{ publicIpAddresses }}"
              publicIpAddressesV6: "{{ publicIpAddressesV6 }}"
              publicIpPrefixes: "{{ publicIpPrefixes }}"
              publicIpPrefixesV6: "{{ publicIpPrefixesV6 }}"
              subnets: "{{ subnets }}"
              sourceVirtualNetwork: "{{ sourceVirtualNetwork }}"
              serviceGateway: "{{ serviceGateway }}"
              nat64: "{{ nat64 }}"
              resourceGuid: "{{ resourceGuid }}"
              provisioningState: "{{ provisioningState }}"
            sku:
              name: "{{ name }}"
            zones:
              - "{{ zones }}"
            etag: "{{ etag }}"
          migrationPhase: "{{ migrationPhase }}"
          linkedPublicIPAddress:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            location: "{{ location }}"
            tags: "{{ tags }}"
            properties:
              publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
              publicIPAddressVersion: "{{ publicIPAddressVersion }}"
              ipConfiguration: "{{ ipConfiguration }}"
              dnsSettings: "{{ dnsSettings }}"
              ddosSettings: "{{ ddosSettings }}"
              ipTags: "{{ ipTags }}"
              ipAddress: "{{ ipAddress }}"
              publicIPPrefix: "{{ publicIPPrefix }}"
              idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
              resourceGuid: "{{ resourceGuid }}"
              provisioningState: "{{ provisioningState }}"
              servicePublicIPAddress: "{{ servicePublicIPAddress }}"
              natGateway: "{{ natGateway }}"
              migrationPhase: "{{ migrationPhase }}"
              linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
              deleteOption: "{{ deleteOption }}"
            extendedLocation:
              name: "{{ name }}"
              type: "{{ type }}"
            sku:
              name: "{{ name }}"
              tier: "{{ tier }}"
            etag: "{{ etag }}"
            zones:
              - "{{ zones }}"
          deleteOption: "{{ deleteOption }}"
        extendedLocation:
          name: "{{ name }}"
          type: "{{ type }}"
        sku:
          name: "{{ name }}"
          tier: "{{ tier }}"
        etag: "{{ etag }}"
        zones:
          - "{{ zones }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.

REPLACE azure.network.virtual_hub_ip_configuration
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hub_name = '{{ virtual_hub_name }}' --required
AND ip_config_name = '{{ ip_config_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes a VirtualHubIpConfiguration.

DELETE FROM azure.network.virtual_hub_ip_configuration
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_hub_name = '{{ virtual_hub_name }}' --required
AND ip_config_name = '{{ ip_config_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;