server_trust_groups

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

Overview

Name	server_trust_groups
Type	Resource
Id	azure.sql.server_trust_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
groupMembers	array	Group members information for the server trust group. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
trustScopes	array	Trust scope of the server trust group. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_location

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
groupMembers	array	Group members information for the server trust group. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
trustScopes	array	Trust scope of the server trust group. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_instance

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
groupMembers	array	Group members information for the server trust group. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
trustScopes	array	Trust scope of the server trust group. Required.
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	resource_group_name, location_name, server_trust_group_name, subscription_id		Gets a server trust group.
list_by_location	select	resource_group_name, location_name, subscription_id		Lists a server trust group.
list_by_instance	select	resource_group_name, managed_instance_name, subscription_id		Gets a server trust groups by instance name.
create_or_update	insert	resource_group_name, location_name, server_trust_group_name, subscription_id		Creates or updates a server trust group.
create_or_update	replace	resource_group_name, location_name, server_trust_group_name, subscription_id		Creates or updates a server trust group.
delete	delete	resource_group_name, location_name, server_trust_group_name, subscription_id		Deletes a server trust group.

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
location_name	string	The name of the region where the resource is located. Required.
managed_instance_name	string	The name of the managed instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_trust_group_name	string	The name of the server trust group. Required.
subscription_id	string

SELECT examples

get

Gets a server trust group.

SELECT
id,
name,
groupMembers,
systemData,
trustScopes,
type
FROM azure.sql.server_trust_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND location_name = '{{ location_name }}' -- required
AND server_trust_group_name = '{{ server_trust_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_location

Lists a server trust group.

SELECT
id,
name,
groupMembers,
systemData,
trustScopes,
type
FROM azure.sql.server_trust_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND location_name = '{{ location_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_instance

Gets a server trust groups by instance name.

SELECT
id,
name,
groupMembers,
systemData,
trustScopes,
type
FROM azure.sql.server_trust_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND managed_instance_name = '{{ managed_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a server trust group.

INSERT INTO azure.sql.server_trust_groups (
properties,
resource_group_name,
location_name,
server_trust_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ location_name }}',
'{{ server_trust_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_trust_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_trust_groups resource.
  - name: location_name
    value: "{{ location_name }}"
    description: Required parameter for the server_trust_groups resource.
  - name: server_trust_group_name
    value: "{{ server_trust_group_name }}"
    description: Required parameter for the server_trust_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_trust_groups resource.
  - name: properties
    description: |
      Resource properties.
    value:
      groupMembers:
        - serverId: "{{ serverId }}"
      trustScopes:
        - "{{ trustScopes }}"

REPLACE examples

create_or_update

Creates or updates a server trust group.

REPLACE azure.sql.server_trust_groups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND location_name = '{{ location_name }}' --required
AND server_trust_group_name = '{{ server_trust_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a server trust group.

DELETE FROM azure.sql.server_trust_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND location_name = '{{ location_name }}' --required
AND server_trust_group_name = '{{ server_trust_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;