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

OK - Returns information about the static member.

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.
properties	object	The Static Member properties
systemData	object	The system metadata related to this resource.
type	string	Resource type.

list

OK - Returns information about the static member.

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.
properties	object	The Static Member properties
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			Gets the specified static member.
list	select	subscriptionId, resourceGroupName, networkManagerName, networkGroupName	$top, $skipToken	Lists the specified static member.
create_or_update	insert			Creates or updates a static member.
delete	delete			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
networkGroupName	string	The name of the network group.
networkManagerName	string	The name of the network manager.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$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.
$top	integer (int32)	An optional query parameter which specifies the maximum number of records to be returned by the server.

SELECT examples

get

Gets the specified static member.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.static_members
;

list

Lists the specified static member.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.static_members
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkManagerName = '{{ networkManagerName }}' -- required
AND networkGroupName = '{{ networkGroupName }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a static member.

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

Manifest

# Description fields are for documentation purposes
- name: static_members
  props:
    - name: properties
      value: object
      description: |
        The Static Member properties

DELETE examples

delete

Deletes a static member.

DELETE FROM azure.network.static_members
;