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

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
asn	string	The ASN for CIDR advertising. Should be an integer as string.
authorizationMessage	string	Authorization message for WAN validation.
childCustomIpPrefixes	array	The list of all Children for IPv6 /48 CustomIpPrefix.
cidr	string	The prefix range in CIDR notation. Should include the start address and the prefix length.
commissionedState	string	The commissioned state of the Custom IP Prefix. Known values are: "Provisioning", "Provisioned", "Commissioning", "CommissionedNoInternetAdvertise", "Commissioned", "Decommissioning", "Deprovisioning", and "Deprovisioned". (Provisioning, Provisioned, Commissioning, CommissionedNoInternetAdvertise, Commissioned, Decommissioning, Deprovisioning, Deprovisioned)
customIpPrefixParent	object	Reference to another subresource.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteAdvertise	boolean	Whether to do express route advertise.
extendedLocation	object	The extended location of the custom IP prefix.
failedReason	string	The reason why resource is in failed state.
geo	string	The Geo for CIDR advertising. Should be an Geo code. Known values are: "GLOBAL", "AFRI", "APAC", "EURO", "LATAM", "NAM", "ME", "OCEANIA", and "AQ". (GLOBAL, AFRI, APAC, EURO, LATAM, NAM, ME, OCEANIA, AQ)
location	string	Resource location.
noInternetAdvertise	boolean	Whether to Advertise the range to Internet.
prefixType	string	Type of custom IP prefix. Should be Singular, Parent, or Child. Known values are: "Singular", "Parent", and "Child". (Singular, Parent, Child)
provisioningState	string	The provisioning state of the custom IP prefix resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIpPrefixes	array	The list of all referenced PublicIpPrefixes.
resourceGuid	string	The resource GUID property of the custom IP prefix resource.
signedMessage	string	Signed message for WAN validation.
tags	object	Resource tags.
type	string	Resource type.
zones	array	A list of availability zones denoting where the resource needs to come from.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
asn	string	The ASN for CIDR advertising. Should be an integer as string.
authorizationMessage	string	Authorization message for WAN validation.
childCustomIpPrefixes	array	The list of all Children for IPv6 /48 CustomIpPrefix.
cidr	string	The prefix range in CIDR notation. Should include the start address and the prefix length.
commissionedState	string	The commissioned state of the Custom IP Prefix. Known values are: "Provisioning", "Provisioned", "Commissioning", "CommissionedNoInternetAdvertise", "Commissioned", "Decommissioning", "Deprovisioning", and "Deprovisioned". (Provisioning, Provisioned, Commissioning, CommissionedNoInternetAdvertise, Commissioned, Decommissioning, Deprovisioning, Deprovisioned)
customIpPrefixParent	object	Reference to another subresource.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteAdvertise	boolean	Whether to do express route advertise.
extendedLocation	object	The extended location of the custom IP prefix.
failedReason	string	The reason why resource is in failed state.
geo	string	The Geo for CIDR advertising. Should be an Geo code. Known values are: "GLOBAL", "AFRI", "APAC", "EURO", "LATAM", "NAM", "ME", "OCEANIA", and "AQ". (GLOBAL, AFRI, APAC, EURO, LATAM, NAM, ME, OCEANIA, AQ)
location	string	Resource location.
noInternetAdvertise	boolean	Whether to Advertise the range to Internet.
prefixType	string	Type of custom IP prefix. Should be Singular, Parent, or Child. Known values are: "Singular", "Parent", and "Child". (Singular, Parent, Child)
provisioningState	string	The provisioning state of the custom IP prefix resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIpPrefixes	array	The list of all referenced PublicIpPrefixes.
resourceGuid	string	The resource GUID property of the custom IP prefix resource.
signedMessage	string	Signed message for WAN validation.
tags	object	Resource tags.
type	string	Resource type.
zones	array	A list of availability zones denoting where the resource needs to come from.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
asn	string	The ASN for CIDR advertising. Should be an integer as string.
authorizationMessage	string	Authorization message for WAN validation.
childCustomIpPrefixes	array	The list of all Children for IPv6 /48 CustomIpPrefix.
cidr	string	The prefix range in CIDR notation. Should include the start address and the prefix length.
commissionedState	string	The commissioned state of the Custom IP Prefix. Known values are: "Provisioning", "Provisioned", "Commissioning", "CommissionedNoInternetAdvertise", "Commissioned", "Decommissioning", "Deprovisioning", and "Deprovisioned". (Provisioning, Provisioned, Commissioning, CommissionedNoInternetAdvertise, Commissioned, Decommissioning, Deprovisioning, Deprovisioned)
customIpPrefixParent	object	Reference to another subresource.
etag	string	A unique read-only string that changes whenever the resource is updated.
expressRouteAdvertise	boolean	Whether to do express route advertise.
extendedLocation	object	The extended location of the custom IP prefix.
failedReason	string	The reason why resource is in failed state.
geo	string	The Geo for CIDR advertising. Should be an Geo code. Known values are: "GLOBAL", "AFRI", "APAC", "EURO", "LATAM", "NAM", "ME", "OCEANIA", and "AQ". (GLOBAL, AFRI, APAC, EURO, LATAM, NAM, ME, OCEANIA, AQ)
location	string	Resource location.
noInternetAdvertise	boolean	Whether to Advertise the range to Internet.
prefixType	string	Type of custom IP prefix. Should be Singular, Parent, or Child. Known values are: "Singular", "Parent", and "Child". (Singular, Parent, Child)
provisioningState	string	The provisioning state of the custom IP prefix resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIpPrefixes	array	The list of all referenced PublicIpPrefixes.
resourceGuid	string	The resource GUID property of the custom IP prefix resource.
signedMessage	string	Signed message for WAN validation.
tags	object	Resource tags.
type	string	Resource type.
zones	array	A list of availability zones denoting where the resource needs to come from.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, custom_ip_prefix_name, subscription_id	$expand	Gets the specified custom IP prefix in a specified resource group.
list	select	resource_group_name, subscription_id		Gets all custom IP prefixes in a resource group.
list_all	select	subscription_id		Gets all the custom IP prefixes in a subscription.
create_or_update	insert	resource_group_name, custom_ip_prefix_name, subscription_id		Creates or updates a custom IP prefix.
update_tags	update	resource_group_name, custom_ip_prefix_name, subscription_id		Updates custom IP prefix tags.
create_or_update	replace	resource_group_name, custom_ip_prefix_name, subscription_id		Creates or updates a custom IP prefix.
delete	delete	resource_group_name, custom_ip_prefix_name, subscription_id		Deletes the specified custom IP prefix.

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
custom_ip_prefix_name	string	The name of the custom IP prefix. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	Expands referenced resources. Default value is None.

SELECT examples

get

Gets the specified custom IP prefix in a specified resource group.

SELECT
id,
name,
asn,
authorizationMessage,
childCustomIpPrefixes,
cidr,
commissionedState,
customIpPrefixParent,
etag,
expressRouteAdvertise,
extendedLocation,
failedReason,
geo,
location,
noInternetAdvertise,
prefixType,
provisioningState,
publicIpPrefixes,
resourceGuid,
signedMessage,
tags,
type,
zones
FROM azure.network.custom_ip_prefixes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND custom_ip_prefix_name = '{{ custom_ip_prefix_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all custom IP prefixes in a resource group.

SELECT
id,
name,
asn,
authorizationMessage,
childCustomIpPrefixes,
cidr,
commissionedState,
customIpPrefixParent,
etag,
expressRouteAdvertise,
extendedLocation,
failedReason,
geo,
location,
noInternetAdvertise,
prefixType,
provisioningState,
publicIpPrefixes,
resourceGuid,
signedMessage,
tags,
type,
zones
FROM azure.network.custom_ip_prefixes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all the custom IP prefixes in a subscription.

SELECT
id,
name,
asn,
authorizationMessage,
childCustomIpPrefixes,
cidr,
commissionedState,
customIpPrefixParent,
etag,
expressRouteAdvertise,
extendedLocation,
failedReason,
geo,
location,
noInternetAdvertise,
prefixType,
provisioningState,
publicIpPrefixes,
resourceGuid,
signedMessage,
tags,
type,
zones
FROM azure.network.custom_ip_prefixes
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a custom IP prefix.

INSERT INTO azure.network.custom_ip_prefixes (
id,
location,
tags,
properties,
extendedLocation,
zones,
resource_group_name,
custom_ip_prefix_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ custom_ip_prefix_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: custom_ip_prefixes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the custom_ip_prefixes resource.
  - name: custom_ip_prefix_name
    value: "{{ custom_ip_prefix_name }}"
    description: Required parameter for the custom_ip_prefixes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the custom_ip_prefixes resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Custom IP prefix properties.
    value:
      asn: "{{ asn }}"
      cidr: "{{ cidr }}"
      signedMessage: "{{ signedMessage }}"
      authorizationMessage: "{{ authorizationMessage }}"
      customIpPrefixParent:
        id: "{{ id }}"
      childCustomIpPrefixes:
        - id: "{{ id }}"
      commissionedState: "{{ commissionedState }}"
      expressRouteAdvertise: {{ expressRouteAdvertise }}
      geo: "{{ geo }}"
      noInternetAdvertise: {{ noInternetAdvertise }}
      prefixType: "{{ prefixType }}"
      publicIpPrefixes:
        - id: "{{ id }}"
      resourceGuid: "{{ resourceGuid }}"
      failedReason: "{{ failedReason }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the custom IP prefix.
    value:
      name: "{{ name }}"
      type: "{{ type }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      A list of availability zones denoting where the resource needs to come from.

UPDATE examples

update_tags

Updates custom IP prefix tags.

UPDATE azure.network.custom_ip_prefixes
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND custom_ip_prefix_name = '{{ custom_ip_prefix_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type,
zones;

REPLACE examples

create_or_update

Creates or updates a custom IP prefix.

REPLACE azure.network.custom_ip_prefixes
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}',
zones = '{{ zones }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND custom_ip_prefix_name = '{{ custom_ip_prefix_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type,
zones;

DELETE examples

delete

Deletes the specified custom IP prefix.

DELETE FROM azure.network.custom_ip_prefixes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND custom_ip_prefix_name = '{{ custom_ip_prefix_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;