authorities
Creates, updates, deletes, gets or lists an authorities
resource.
Overview
Name | authorities |
Type | Resource |
Id | azure.verified_id.authorities |
Fields
The following fields are returned by SELECT
queries:
- get
- list_by_resource_group
- list_by_subscription
Azure operation completed successfully.
Name | Datatype | Description |
---|---|---|
location | string | The geo-location where the resource lives |
properties | object | The resource-specific properties for this resource. |
tags | object | Resource tags. |
Azure operation completed successfully.
Name | Datatype | Description |
---|---|---|
location | string | The geo-location where the resource lives |
properties | object | The resource-specific properties for this resource. |
tags | object | Resource tags. |
Azure operation completed successfully.
Name | Datatype | Description |
---|---|---|
location | string | The geo-location where the resource lives |
properties | object | The resource-specific properties for this resource. |
tags | object | Resource tags. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | subscriptionId , resourceGroupName , authorityName | Get a Authority | |
list_by_resource_group | select | subscriptionId , resourceGroupName | List Authority resources by resource group | |
list_by_subscription | select | subscriptionId | List Authority resources by subscription ID | |
create_or_update | insert | subscriptionId , resourceGroupName , authorityName | Create a Authority | |
update | update | subscriptionId , resourceGroupName , authorityName | Update a Authority | |
delete | delete | subscriptionId , resourceGroupName , authorityName | Delete a Authority |
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 |
---|---|---|
authorityName | string | The ID of the authority |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
SELECT
examples
- get
- list_by_resource_group
- list_by_subscription
Get a Authority
SELECT
location,
properties,
tags
FROM azure.verified_id.authorities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND authorityName = '{{ authorityName }}' -- required
;
List Authority resources by resource group
SELECT
location,
properties,
tags
FROM azure.verified_id.authorities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;
List Authority resources by subscription ID
SELECT
location,
properties,
tags
FROM azure.verified_id.authorities
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;
INSERT
examples
- create_or_update
- Manifest
Create a Authority
INSERT INTO azure.verified_id.authorities (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
authorityName
)
SELECT
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ authorityName }}'
RETURNING
location,
properties,
tags
;
# Description fields are for documentation purposes
- name: authorities
props:
- name: subscriptionId
value: string (uuid)
description: Required parameter for the authorities resource.
- name: resourceGroupName
value: string
description: Required parameter for the authorities resource.
- name: authorityName
value: string
description: Required parameter for the authorities resource.
- name: properties
value: object
description: |
The resource-specific properties for this resource.
- name: tags
value: object
description: |
Resource tags.
- name: location
value: string
description: |
The geo-location where the resource lives
UPDATE
examples
- update
Update a Authority
UPDATE azure.verified_id.authorities
SET
data__tags = '{{ tags }}'
WHERE
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND authorityName = '{{ authorityName }}' --required
RETURNING
location,
properties,
tags;
DELETE
examples
- delete
Delete a Authority
DELETE FROM azure.verified_id.authorities
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND authorityName = '{{ authorityName }}' --required
;