static_members

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

Overview

Name	static_members
Type	Resource
Id	azure.network.static_members

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the scope assignment resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
region	string	Resource region.
resourceId	string	Resource Id.
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the scope assignment resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
region	string	Resource region.
resourceId	string	Resource Id.
systemData	object	The system metadata related to this resource.
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, network_group_name, static_member_name, subscription_id		Gets the specified static member.
list	select	resource_group_name, network_manager_name, network_group_name, subscription_id	$top, $skipToken	Lists the specified static member.
create_or_update	insert	resource_group_name, network_manager_name, network_group_name, static_member_name, subscription_id		Creates or updates a static member.
create_or_update	replace	resource_group_name, network_manager_name, network_group_name, static_member_name, subscription_id		Creates or updates a static member.
delete	delete	resource_group_name, network_manager_name, network_group_name, static_member_name, subscription_id		Deletes a static member.

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_group_name	string	The name of the network group. 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.
static_member_name	string	The name of the static member. 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 static member.

SELECT
id,
name,
etag,
provisioningState,
region,
resourceId,
systemData,
type
FROM azure.network.static_members
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND network_group_name = '{{ network_group_name }}' -- required
AND static_member_name = '{{ static_member_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the specified static member.

SELECT
id,
name,
etag,
provisioningState,
region,
resourceId,
systemData,
type
FROM azure.network.static_members
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_manager_name = '{{ network_manager_name }}' -- required
AND network_group_name = '{{ network_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a static member.

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

Manifest

# Description fields are for documentation purposes
- name: static_members
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the static_members resource.
  - name: network_manager_name
    value: "{{ network_manager_name }}"
    description: Required parameter for the static_members resource.
  - name: network_group_name
    value: "{{ network_group_name }}"
    description: Required parameter for the static_members resource.
  - name: static_member_name
    value: "{{ static_member_name }}"
    description: Required parameter for the static_members resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the static_members resource.
  - name: properties
    description: |
      The Static Member properties.
    value:
      resourceId: "{{ resourceId }}"
      region: "{{ region }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates a static member.

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

DELETE examples

delete

Deletes a static member.

DELETE FROM azure.network.static_members
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_manager_name = '{{ network_manager_name }}' --required
AND network_group_name = '{{ network_group_name }}' --required
AND static_member_name = '{{ static_member_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;