profiles

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

Overview

Name	profiles
Type	Resource
Id	azure.network.profiles

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting NetworkProfile resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Network profile properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Request successful. The operation returns a list of NetworkProfile resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Network profile properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_all

Request successful. The operation returns a list of NetworkProfile resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Network profile properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	resourceGroupName, networkProfileName, subscriptionId	$expand	Gets the specified network profile in a specified resource group.
list	select	resourceGroupName, subscriptionId		Gets all network profiles in a resource group.
list_all	select	subscriptionId		Gets all the network profiles in a subscription.
create_or_update	insert	resourceGroupName, networkProfileName, subscriptionId		Creates or updates a network profile.
delete	delete	resourceGroupName, networkProfileName, subscriptionId		Deletes the specified network profile.
update_tags	exec	resourceGroupName, networkProfileName, subscriptionId		Updates network profile tags.

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
networkProfileName	string	The name of the network profile.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets the specified network profile in a specified resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkProfileName = '{{ networkProfileName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all network profiles in a resource group.

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

list_all

Gets all the network profiles in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.profiles
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network profile.

INSERT INTO azure.network.profiles (
data__properties,
resourceGroupName,
networkProfileName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ networkProfileName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: profiles
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the profiles resource.
    - name: networkProfileName
      value: string
      description: Required parameter for the profiles resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the profiles resource.
    - name: properties
      value: object
      description: |
        Network profile properties.

DELETE examples

delete

Deletes the specified network profile.

DELETE FROM azure.network.profiles
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND networkProfileName = '{{ networkProfileName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates network profile tags.

EXEC azure.network.profiles.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkProfileName='{{ networkProfileName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;