policies

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

Overview

Name	policies
Type	Resource
Id	azure.device_registry.policies

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.
certificate	object	The certificate configuration.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
certificate	object	The certificate configuration.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, namespace_name, policy_name, subscription_id		Get a Policy.
list_by_resource_group	select	resource_group_name, namespace_name, subscription_id		List Policy resources by Credential.
create_or_update	insert	resource_group_name, namespace_name, policy_name, subscription_id		Create a Policy.
update	update	resource_group_name, namespace_name, policy_name, subscription_id		Update a Policy.
create_or_update	replace	resource_group_name, namespace_name, policy_name, subscription_id		Create a Policy.
delete	delete	resource_group_name, namespace_name, policy_name, subscription_id		Delete a Policy.
revoke_issuer	exec	resource_group_name, namespace_name, policy_name, subscription_id		A long-running resource action.
activate_bring_your_own_root	exec	resource_group_name, namespace_name, policy_name, subscription_id, certificateChain		Activates or renews a Bring Your Own Root policy by accepting a customer-provided signed certificate. This is a long-running operation that returns no content upon completion.

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
namespace_name	string	The name of the namespace. Required.
policy_name	string	The name of the Policy proxy resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Policy.

SELECT
id,
name,
certificate,
provisioningState,
systemData,
type
FROM azure.device_registry.policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND policy_name = '{{ policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List Policy resources by Credential.

SELECT
id,
name,
certificate,
provisioningState,
systemData,
type
FROM azure.device_registry.policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Policy.

INSERT INTO azure.device_registry.policies (
properties,
resource_group_name,
namespace_name,
policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the policies resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the policies resource.
  - name: policy_name
    value: "{{ policy_name }}"
    description: Required parameter for the policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the policies resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      certificate:
        certificateAuthorityConfiguration:
          keyType: "{{ keyType }}"
          subject: "{{ subject }}"
          validityNotBefore: "{{ validityNotBefore }}"
          validityNotAfter: "{{ validityNotAfter }}"
          bringYourOwnRoot:
            enabled: {{ enabled }}
            certificateSigningRequest: "{{ certificateSigningRequest }}"
            issuingCertificateThumbprint: "{{ issuingCertificateThumbprint }}"
            status: "{{ status }}"
        leafCertificateConfiguration:
          validityPeriodInDays: {{ validityPeriodInDays }}

UPDATE examples

update

Update a Policy.

UPDATE azure.device_registry.policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND policy_name = '{{ policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a Policy.

REPLACE azure.device_registry.policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND policy_name = '{{ policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Policy.

DELETE FROM azure.device_registry.policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND policy_name = '{{ policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

revoke_issuer

A long-running resource action.

EXEC azure.device_registry.policies.revoke_issuer 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@policy_name='{{ policy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

activate_bring_your_own_root

Activates or renews a Bring Your Own Root policy by accepting a customer-provided signed certificate. This is a long-running operation that returns no content upon completion.

EXEC azure.device_registry.policies.activate_bring_your_own_root 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@policy_name='{{ policy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"certificateChain": "{{ certificateChain }}"
}'
;