static_cidrs

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

Overview

Name	static_cidrs
Type	Resource
Id	azure.network.static_cidrs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
addressPrefixes	array	List of IP address prefixes of the resource.
description	string	:vartype description: str
numberOfIPAddressesToAllocate	string	Number of IP addresses to allocate for a static CIDR resource. The IP addresses will be assigned based on IpamPools available space.
provisioningState	string	Provisioning states of a resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalNumberOfIPAddresses	string	Total number of IP addresses allocated for the static CIDR resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
addressPrefixes	array	List of IP address prefixes of the resource.
description	string	:vartype description: str
numberOfIPAddressesToAllocate	string	Number of IP addresses to allocate for a static CIDR resource. The IP addresses will be assigned based on IpamPools available space.
provisioningState	string	Provisioning states of a resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalNumberOfIPAddresses	string	Total number of IP addresses allocated for the static CIDR resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_manager_name, pool_name, static_cidr_name, subscription_id		Gets the specific Static CIDR resource. Gets the specific Static CIDR resource.
list	select	resource_group_name, network_manager_name, pool_name, subscription_id	skipToken, skip, top, sortKey, sortValue	Gets list of Static CIDR resources at Network Manager level. Gets list of Static CIDR resources at Network Manager level.
create	insert	resource_group_name, network_manager_name, pool_name, static_cidr_name, subscription_id		Creates/Updates the Static CIDR resource. Creates/Updates the Static CIDR resource.
delete	delete	resource_group_name, network_manager_name, pool_name, static_cidr_name, subscription_id		Delete the Static CIDR resource. Delete the Static CIDR resource.

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
network_manager_name	string	The name of the network manager. Required.
pool_name	string	Pool resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
static_cidr_name	string	StaticCidr resource name to retrieve. Required.
subscription_id	string
skip	integer	Optional num entries to skip. Default value is 0.
skipToken	string	Optional skip token. Default value is None.
sortKey	string	Optional key by which to sort. Default value is None.
sortValue	string	Optional sort value for pagination. Default value is None.
top	integer	Optional num entries to show. Default value is 50.

SELECT examples

get

Gets the specific Static CIDR resource. Gets the specific Static CIDR resource.

SELECT
id,
name,
addressPrefixes,
description,
numberOfIPAddressesToAllocate,
provisioningState,
systemData,
totalNumberOfIPAddresses,
type
FROM azure.network.static_cidrs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND static_cidr_name = '{{ static_cidr_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets list of Static CIDR resources at Network Manager level. Gets list of Static CIDR resources at Network Manager level.

SELECT
id,
name,
addressPrefixes,
description,
numberOfIPAddressesToAllocate,
provisioningState,
systemData,
totalNumberOfIPAddresses,
type
FROM azure.network.static_cidrs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND skipToken = '{{ skipToken }}'
AND skip = '{{ skip }}'
AND top = '{{ top }}'
AND sortKey = '{{ sortKey }}'
AND sortValue = '{{ sortValue }}'
;

INSERT examples

create

Creates/Updates the Static CIDR resource. Creates/Updates the Static CIDR resource.

INSERT INTO azure.network.static_cidrs (
properties,
resource_group_name,
network_manager_name,
pool_name,
static_cidr_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_manager_name }}',
'{{ pool_name }}',
'{{ static_cidr_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: static_cidrs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the static_cidrs resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the static_cidrs resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the static_cidrs resource.
  - name: static_cidr_name
    value: "{{ static_cidr_name }}"
    description: Required parameter for the static_cidrs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the static_cidrs resource.
  - name: properties
    description: |
      Properties of static CIDR resource.
    value:
      description: "{{ description }}"
      numberOfIPAddressesToAllocate: "{{ numberOfIPAddressesToAllocate }}"
      addressPrefixes:
        - "{{ addressPrefixes }}"
      totalNumberOfIPAddresses: "{{ totalNumberOfIPAddresses }}"
      provisioningState: "{{ provisioningState }}"

DELETE examples

delete

Delete the Static CIDR resource. Delete the Static CIDR resource.

DELETE FROM azure.network.static_cidrs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND static_cidr_name = '{{ static_cidr_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;