virtual_hub_ip_configurations

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

Overview

Name	virtual_hub_ip_configurations
Type	Resource
Id	azure.network.virtual_hub_ip_configurations

Fields

The following fields are returned by SELECT queries:

get

Request successful. Returns the details of the Bgp Connection retrieved.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the Ip Configuration.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The properties of the Virtual Hub IPConfigurations.
type	string	Ipconfiguration type.

list

Request successful. Returns the details of all the VirtualHubIpConfigurations for the VirtualHub.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the Ip Configuration.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The properties of the Virtual Hub IPConfigurations.
type	string	Ipconfiguration type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, virtualHubName, ipConfigName		Retrieves the details of a Virtual Hub Ip configuration.
list	select	subscriptionId, resourceGroupName, virtualHubName		Retrieves the details of all VirtualHubIpConfigurations.
create_or_update	insert	subscriptionId, resourceGroupName, virtualHubName, ipConfigName		Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.
delete	delete	subscriptionId, resourceGroupName, virtualHubName, ipConfigName		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
ipConfigName	string	The name of the ipconfig.
resourceGroupName	string	The resource group name of the VirtualHubBgpConnection.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualHubName	string	The name of the VirtualHub.

SELECT examples

get

Retrieves the details of a Virtual Hub Ip configuration.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.virtual_hub_ip_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualHubName = '{{ virtualHubName }}' -- required
AND ipConfigName = '{{ ipConfigName }}' -- required
;

list

Retrieves the details of all VirtualHubIpConfigurations.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.virtual_hub_ip_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualHubName = '{{ virtualHubName }}' -- 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_configurations (
data__properties,
data__name,
data__id,
subscriptionId,
resourceGroupName,
virtualHubName,
ipConfigName
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ virtualHubName }}',
'{{ ipConfigName }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_hub_ip_configurations
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_hub_ip_configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_hub_ip_configurations resource.
    - name: virtualHubName
      value: string
      description: Required parameter for the virtual_hub_ip_configurations resource.
    - name: ipConfigName
      value: string
      description: Required parameter for the virtual_hub_ip_configurations resource.
    - name: properties
      value: object
      description: |
        The properties of the Virtual Hub IPConfigurations.
    - name: name
      value: string
      description: |
        Name of the Ip Configuration.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes a VirtualHubIpConfiguration.

DELETE FROM azure.network.virtual_hub_ip_configurations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND virtualHubName = '{{ virtualHubName }}' --required
AND ipConfigName = '{{ ipConfigName }}' --required
;