attestation_providers

Creates, updates, deletes, gets or lists an attestation_providers resource.

Overview

Name	attestation_providers
Type	Resource
Id	azure.attestation.attestation_providers

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.
attestUri	string	Gets the uri of attestation service.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connections associated with the attestation provider.
publicNetworkAccess	string	Controls whether traffic from the public network is allowed to access the Attestation Provider APIs. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
status	string	Status of attestation service. Known values are: "Ready", "NotReady", and "Error". (Ready, NotReady, Error)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tpmAttestationAuthentication	string	The setting that controls whether authentication is enabled or disabled for TPM Attestation REST APIs. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
trustModel	string	Trust model for the attestation provider.
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.
attestUri	string	Gets the uri of attestation service.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connections associated with the attestation provider.
publicNetworkAccess	string	Controls whether traffic from the public network is allowed to access the Attestation Provider APIs. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
status	string	Status of attestation service. Known values are: "Ready", "NotReady", and "Error". (Ready, NotReady, Error)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tpmAttestationAuthentication	string	The setting that controls whether authentication is enabled or disabled for TPM Attestation REST APIs. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
trustModel	string	Trust model for the attestation provider.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_default_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.
attestUri	string	Gets the uri of attestation service.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connections associated with the attestation provider.
publicNetworkAccess	string	Controls whether traffic from the public network is allowed to access the Attestation Provider APIs. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
status	string	Status of attestation service. Known values are: "Ready", "NotReady", and "Error". (Ready, NotReady, Error)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tpmAttestationAuthentication	string	The setting that controls whether authentication is enabled or disabled for TPM Attestation REST APIs. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
trustModel	string	Trust model for the attestation provider.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
attestUri	string	Gets the uri of attestation service.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of private endpoint connections associated with the attestation provider.
publicNetworkAccess	string	Controls whether traffic from the public network is allowed to access the Attestation Provider APIs. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
status	string	Status of attestation service. Known values are: "Ready", "NotReady", and "Error". (Ready, NotReady, Error)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tpmAttestationAuthentication	string	The setting that controls whether authentication is enabled or disabled for TPM Attestation REST APIs. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
trustModel	string	Trust model for the attestation provider.
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, provider_name, subscription_id		Get the status of Attestation Provider.
list_by_resource_group	select	resource_group_name, subscription_id		Returns attestation providers list in a resource group.
get_default_by_location	select	location, subscription_id		Get the default provider by location.
list	select	subscription_id		Returns a list of attestation providers in a subscription.
create	insert	resource_group_name, provider_name, subscription_id, location, properties		Creates or updates an Attestation Provider.
update	update	resource_group_name, provider_name, subscription_id		Updates the Attestation Provider.
delete	delete	resource_group_name, provider_name, subscription_id		Delete Attestation Service.
list_default	exec	subscription_id		Get the default provider.

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	string	The name of the Azure region. Required.
provider_name	string	Name of the attestation provider. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the status of Attestation Provider.

SELECT
id,
name,
attestUri,
location,
privateEndpointConnections,
publicNetworkAccess,
status,
systemData,
tags,
tpmAttestationAuthentication,
trustModel,
type
FROM azure.attestation.attestation_providers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND provider_name = '{{ provider_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Returns attestation providers list in a resource group.

SELECT
id,
name,
attestUri,
location,
privateEndpointConnections,
publicNetworkAccess,
status,
systemData,
tags,
tpmAttestationAuthentication,
trustModel,
type
FROM azure.attestation.attestation_providers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_default_by_location

Get the default provider by location.

SELECT
id,
name,
attestUri,
location,
privateEndpointConnections,
publicNetworkAccess,
status,
systemData,
tags,
tpmAttestationAuthentication,
trustModel,
type
FROM azure.attestation.attestation_providers
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of attestation providers in a subscription.

SELECT
id,
name,
attestUri,
location,
privateEndpointConnections,
publicNetworkAccess,
status,
systemData,
tags,
tpmAttestationAuthentication,
trustModel,
type
FROM azure.attestation.attestation_providers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates or updates an Attestation Provider.

INSERT INTO azure.attestation.attestation_providers (
location,
tags,
properties,
resource_group_name,
provider_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ provider_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: attestation_providers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the attestation_providers resource.
  - name: provider_name
    value: "{{ provider_name }}"
    description: Required parameter for the attestation_providers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the attestation_providers resource.
  - name: location
    value: "{{ location }}"
    description: |
      The supported Azure location where the attestation provider should be created. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags that will be assigned to the attestation provider.
  - name: properties
    description: |
      Properties of the attestation provider. Required.
    value:
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      policySigningCertificates:
        keys:
          - alg: "{{ alg }}"
            crv: "{{ crv }}"
            d: "{{ d }}"
            dp: "{{ dp }}"
            dq: "{{ dq }}"
            e: "{{ e }}"
            k: "{{ k }}"
            kid: "{{ kid }}"
            kty: "{{ kty }}"
            n: "{{ n }}"
            p: "{{ p }}"
            q: "{{ q }}"
            qi: "{{ qi }}"
            use: "{{ use }}"
            x: "{{ x }}"
            x5c: "{{ x5c }}"
            y: "{{ y }}"
      tpmAttestationAuthentication: "{{ tpmAttestationAuthentication }}"

UPDATE examples

update

Updates the Attestation Provider.

UPDATE azure.attestation.attestation_providers
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND provider_name = '{{ provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete Attestation Service.

DELETE FROM azure.attestation.attestation_providers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND provider_name = '{{ provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_default

Get the default provider.

EXEC azure.attestation.attestation_providers.list_default 
@subscription_id='{{ subscription_id }}' --required
;