custom_ip_prefixes

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

Overview

Name	custom_ip_prefixes
Type	Resource
Id	azure.network.custom_ip_prefixes

Fields

vw_custom_ip_prefixes

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
asn	text	field from the properties object
authorization_message	text	field from the properties object
child_custom_ip_prefixes	text	field from the properties object
cidr	text	field from the properties object
commissioned_state	text	field from the properties object
customIpPrefixName	text	field from the properties object
custom_ip_prefix_parent	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
express_route_advertise	text	field from the properties object
extended_location	text	field from the properties object
failed_reason	text	field from the properties object
geo	text	field from the properties object
location	text	Resource location.
no_internet_advertise	text	field from the properties object
prefix_type	text	field from the properties object
provisioning_state	text	field from the properties object
public_ip_prefixes	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_guid	text	field from the properties object
signed_message	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.
zones	text	A list of availability zones denoting the IP allocated for the resource needs to come from.

custom_ip_prefixes

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	ExtendedLocation complex type.
location	string	Resource location.
properties	object	Custom IP prefix properties.
tags	object	Resource tags.
type	string	Resource type.
zones	array	A list of availability zones denoting the IP allocated for the resource needs to come from.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	customIpPrefixName, resourceGroupName, subscriptionId	Gets the specified custom IP prefix in a specified resource group.
list	SELECT	resourceGroupName, subscriptionId	Gets all custom IP prefixes in a resource group.
list_all	SELECT	subscriptionId	Gets all the custom IP prefixes in a subscription.
create_or_update	INSERT	customIpPrefixName, resourceGroupName, subscriptionId	Creates or updates a custom IP prefix.
delete	DELETE	customIpPrefixName, resourceGroupName, subscriptionId	Deletes the specified custom IP prefix.
update_tags	EXEC	customIpPrefixName, resourceGroupName, subscriptionId	Updates custom IP prefix tags.

SELECT examples

Gets all the custom IP prefixes in a subscription.

vw_custom_ip_prefixes

SELECT
id,
name,
asn,
authorization_message,
child_custom_ip_prefixes,
cidr,
commissioned_state,
customIpPrefixName,
custom_ip_prefix_parent,
etag,
express_route_advertise,
extended_location,
failed_reason,
geo,
location,
no_internet_advertise,
prefix_type,
provisioning_state,
public_ip_prefixes,
resourceGroupName,
resource_guid,
signed_message,
subscriptionId,
tags,
type,
zones
FROM azure.network.vw_custom_ip_prefixes
WHERE subscriptionId = '{{ subscriptionId }}';

custom_ip_prefixes

SELECT
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type,
zones
FROM azure.network.custom_ip_prefixes
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new custom_ip_prefixes resource.

All Properties

/*+ create */
INSERT INTO azure.network.custom_ip_prefixes (
customIpPrefixName,
resourceGroupName,
subscriptionId,
extendedLocation,
properties,
zones,
id,
location,
tags
)
SELECT 
'{{ customIpPrefixName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ extendedLocation }}',
'{{ properties }}',
'{{ zones }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []
    - name: properties
      value:
        - name: asn
          value: string
        - name: cidr
          value: string
        - name: signedMessage
          value: string
        - name: authorizationMessage
          value: string
        - name: customIpPrefixParent
          value:
            - name: id
              value: string
        - name: childCustomIpPrefixes
          value:
            - - name: id
                value: string
        - name: commissionedState
          value: string
        - name: expressRouteAdvertise
          value: boolean
        - name: geo
          value: string
        - name: noInternetAdvertise
          value: boolean
        - name: prefixType
          value: string
        - name: publicIpPrefixes
          value:
            - - name: id
                value: string
        - name: resourceGuid
          value: string
        - name: failedReason
          value: string
        - name: provisioningState
          value: []
    - name: etag
      value: string
    - name: zones
      value:
        - string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

DELETE example

Deletes the specified custom_ip_prefixes resource.

/*+ delete */
DELETE FROM azure.network.custom_ip_prefixes
WHERE customIpPrefixName = '{{ customIpPrefixName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';