members

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

Overview

Name	members
Type	Resource
Id	azure.fleet.members

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
properties	object	The resource-specific properties for this resource.

list_by_fleet

Azure operation completed successfully.

Name	Datatype	Description
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, fleetName, fleetMemberName		Get a FleetMember
list_by_fleet	select	subscriptionId, resourceGroupName, fleetName		List FleetMember resources by Fleet
create	insert	subscriptionId, resourceGroupName, fleetName, fleetMemberName	If-Match, If-None-Match	Create a FleetMember
update	update	subscriptionId, resourceGroupName, fleetName, fleetMemberName	If-Match	Update a FleetMember
delete	delete	subscriptionId, resourceGroupName, fleetName, fleetMemberName	If-Match	Delete a FleetMember

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
fleetMemberName	string	The name of the Fleet member resource.
fleetName	string	The name of the Fleet resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
If-Match	string	The request should only proceed if an entity matches this string.
If-None-Match	string	The request should only proceed if no entity matches this string.

SELECT examples

get

Get a FleetMember

SELECT
eTag,
properties
FROM azure.fleet.members
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND fleetName = '{{ fleetName }}' -- required
AND fleetMemberName = '{{ fleetMemberName }}' -- required
;

list_by_fleet

List FleetMember resources by Fleet

SELECT
eTag,
properties
FROM azure.fleet.members
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND fleetName = '{{ fleetName }}' -- required
;

INSERT examples

create

Create a FleetMember

INSERT INTO azure.fleet.members (
data__properties,
subscriptionId,
resourceGroupName,
fleetName,
fleetMemberName,
If-Match,
If-None-Match
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ fleetName }}',
'{{ fleetMemberName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
eTag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: members
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the members resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the members resource.
    - name: fleetName
      value: string
      description: Required parameter for the members resource.
    - name: fleetMemberName
      value: string
      description: Required parameter for the members resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: If-Match
      value: string
      description: The request should only proceed if an entity matches this string.
    - name: If-None-Match
      value: string
      description: The request should only proceed if no entity matches this string.

UPDATE examples

update

Update a FleetMember

UPDATE azure.fleet.members
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND fleetName = '{{ fleetName }}' --required
AND fleetMemberName = '{{ fleetMemberName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
eTag,
properties;

DELETE examples

delete

Delete a FleetMember

DELETE FROM azure.fleet.members
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND fleetName = '{{ fleetName }}' --required
AND fleetMemberName = '{{ fleetMemberName }}' --required
AND If-Match = '{{ If-Match }}'
;