commits

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

Overview

Name	commits
Type	Resource
Id	azure.network.commits

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
activeLocations	array	List of active locations.
commitType	string	Commit Type. Required. Known values are: "SecurityAdmin", "Connectivity", "SecurityUser", and "Routing". (SecurityAdmin, Connectivity, SecurityUser, Routing)
configurationIds	array	List of configuration IDs.
description	string	A description of the commit.
etag	string	A unique read-only string that changes whenever the resource is updated.
forceUpdateTag	string	A value that, when changed, forces the commit to be re-evaluated and redeployed.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	Unique identifier for this resource.
systemData	object	The system metadata related to this resource.
targetLocations	array	List of target locations. Required.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
activeLocations	array	List of active locations.
commitType	string	Commit Type. Required. Known values are: "SecurityAdmin", "Connectivity", "SecurityUser", and "Routing". (SecurityAdmin, Connectivity, SecurityUser, Routing)
configurationIds	array	List of configuration IDs.
description	string	A description of the commit.
etag	string	A unique read-only string that changes whenever the resource is updated.
forceUpdateTag	string	A value that, when changed, forces the commit to be re-evaluated and redeployed.
provisioningState	string	The provisioning state of the resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	Unique identifier for this resource.
systemData	object	The system metadata related to this resource.
targetLocations	array	List of target locations. Required.
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_manager_name, commit_name, subscription_id		Gets the specified commit.
list	select	resource_group_name, network_manager_name, subscription_id	$top, $skipToken	Lists all commits for the specified network manager.
create_or_update	insert	resource_group_name, network_manager_name, commit_name, subscription_id		Creates or updates a commit.
create_or_update	replace	resource_group_name, network_manager_name, commit_name, subscription_id		Creates or updates a commit.
delete	delete	resource_group_name, network_manager_name, commit_name, subscription_id		Deletes a commit.

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
commit_name	string	The name of the commit. Required.
network_manager_name	string	The name of the network manager. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skipToken	string	SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. Default value is None.
$top	integer	An optional query parameter which specifies the maximum number of records to be returned by the server. Default value is None.

SELECT examples

get

Gets the specified commit.

SELECT
id,
name,
activeLocations,
commitType,
configurationIds,
description,
etag,
forceUpdateTag,
provisioningState,
resourceGuid,
systemData,
targetLocations,
type
FROM azure.network.commits
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND commit_name = '{{ commit_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all commits for the specified network manager.

SELECT
id,
name,
activeLocations,
commitType,
configurationIds,
description,
etag,
forceUpdateTag,
provisioningState,
resourceGuid,
systemData,
targetLocations,
type
FROM azure.network.commits
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a commit.

INSERT INTO azure.network.commits (
properties,
resource_group_name,
network_manager_name,
commit_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_manager_name }}',
'{{ commit_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: commits
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the commits resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the commits resource.
  - name: commit_name
    value: "{{ commit_name }}"
    description: Required parameter for the commits resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the commits resource.
  - name: properties
    description: |
      The Commit properties.
    value:
      description: "{{ description }}"
      provisioningState: "{{ provisioningState }}"
      resourceGuid: "{{ resourceGuid }}"
      commitType: "{{ commitType }}"
      configurationIds:
        - "{{ configurationIds }}"
      targetLocations:
        - "{{ targetLocations }}"
      activeLocations:
        - "{{ activeLocations }}"
      forceUpdateTag: "{{ forceUpdateTag }}"

REPLACE examples

create_or_update

Creates or updates a commit.

REPLACE azure.network.commits
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND commit_name = '{{ commit_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Deletes a commit.

DELETE FROM azure.network.commits
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND commit_name = '{{ commit_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;