network_profiles

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

Overview

Name	network_profiles
Type	Resource
Id	azure.network.network_profiles

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
containerNetworkInterfaceConfigurations	array	List of chid container network interface configurations.
containerNetworkInterfaces	array	List of child container network interfaces.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the network profile resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network profile resource.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
containerNetworkInterfaceConfigurations	array	List of chid container network interface configurations.
containerNetworkInterfaces	array	List of child container network interfaces.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the network profile resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network profile resource.
tags	object	Resource tags.
type	string	Resource type.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
containerNetworkInterfaceConfigurations	array	List of chid container network interface configurations.
containerNetworkInterfaces	array	List of child container network interfaces.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the network profile resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the network profile resource.
tags	object	Resource tags.
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, network_profile_name, subscription_id	$expand	Gets the specified network profile in a specified resource group.
list	select	resource_group_name, subscription_id		Gets all network profiles in a resource group.
list_all	select	subscription_id		Gets all the network profiles in a subscription.
create_or_update	insert	resource_group_name, network_profile_name, subscription_id		Creates or updates a network profile.
update_tags	update	resource_group_name, network_profile_name, subscription_id		Updates network profile tags.
create_or_update	replace	resource_group_name, network_profile_name, subscription_id		Creates or updates a network profile.
delete	delete	resource_group_name, network_profile_name, subscription_id		Deletes the specified network profile.

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_profile_name	string	The name of the public 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 network profile in a specified resource group.

SELECT
id,
name,
containerNetworkInterfaceConfigurations,
containerNetworkInterfaces,
etag,
location,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.network_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_profile_name = '{{ network_profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all network profiles in a resource group.

SELECT
id,
name,
containerNetworkInterfaceConfigurations,
containerNetworkInterfaces,
etag,
location,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.network_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all the network profiles in a subscription.

SELECT
id,
name,
containerNetworkInterfaceConfigurations,
containerNetworkInterfaces,
etag,
location,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.network_profiles
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network profile.

INSERT INTO azure.network.network_profiles (
id,
location,
tags,
properties,
resource_group_name,
network_profile_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_profile_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_profiles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_profiles resource.
  - name: network_profile_name
    value: "{{ network_profile_name }}"
    description: Required parameter for the network_profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_profiles 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: |
      Network profile properties.
    value:
      containerNetworkInterfaces:
        - id: "{{ id }}"
          properties:
            containerNetworkInterfaceConfiguration:
              id: "{{ id }}"
              properties:
                ipConfigurations: "{{ ipConfigurations }}"
                containerNetworkInterfaces: "{{ containerNetworkInterfaces }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              type: "{{ type }}"
              etag: "{{ etag }}"
            container:
              id: "{{ id }}"
            ipConfigurations:
              - properties:
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                type: "{{ type }}"
                etag: "{{ etag }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          type: "{{ type }}"
          etag: "{{ etag }}"
      containerNetworkInterfaceConfigurations:
        - id: "{{ id }}"
          properties:
            ipConfigurations:
              - id: "{{ id }}"
                properties:
                  subnet: "{{ subnet }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                type: "{{ type }}"
                etag: "{{ etag }}"
            containerNetworkInterfaces:
              - id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          type: "{{ type }}"
          etag: "{{ etag }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update_tags

Updates network profile tags.

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

REPLACE examples

create_or_update

Creates or updates a network profile.

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

DELETE examples

delete

Deletes the specified network profile.

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