tenant_access_secrets

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

Overview

Name	tenant_access_secrets
Type	Resource
Id	azure.api_management.tenant_access_secrets

Fields

The following fields are returned by SELECT queries:

list

Tenant Access information.

Name	Datatype	Description
id	string	Access Information type ('access' or 'gitAccess')
enabled	boolean	Determines whether direct access is enabled.
primaryKey	string	Primary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
principalId	string	Principal (User) Identifier.
secondaryKey	string	Secondary access key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, serviceName, subscriptionId, accessName		Get tenant access information details.

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
accessName	string	The identifier of the Access configuration.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.

SELECT examples

list

Get tenant access information details.

SELECT
id,
enabled,
primaryKey,
principalId,
secondaryKey
FROM azure.api_management.tenant_access_secrets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND accessName = '{{ accessName }}' -- required
;