tenant_accesses

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

Overview

Name	tenant_accesses
Type	Resource
Id	azure.api_management.tenant_accesses

Fields

vw_tenant_accesses

Name	Datatype	Description
id	text	field from the properties object
accessName	text	field from the properties object
enabled	text	field from the properties object
principal_id	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object

tenant_accesses

Name	Datatype	Description
properties	object	Tenant access information contract of the API Management service.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accessName, resourceGroupName, serviceName, subscriptionId	Get tenant access information details without secrets.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Returns list of access infos - for Git and Management endpoints.
create	INSERT	If-Match, accessName, resourceGroupName, serviceName, subscriptionId	Update tenant access information details.
update	UPDATE	If-Match, accessName, resourceGroupName, serviceName, subscriptionId	Update tenant access information details.
regenerate_git_primary_key	EXEC	accessName, resourceGroupName, serviceName, subscriptionId	Regenerate primary access key for GIT.
regenerate_git_secondary_key	EXEC	accessName, resourceGroupName, serviceName, subscriptionId	Regenerate secondary access key for GIT.
regenerate_primary_key	EXEC	accessName, resourceGroupName, serviceName, subscriptionId	Regenerate primary access key
regenerate_secondary_key	EXEC	accessName, resourceGroupName, serviceName, subscriptionId	Regenerate secondary access key

SELECT examples

Returns list of access infos - for Git and Management endpoints.

vw_tenant_accesses

SELECT
id,
accessName,
enabled,
principal_id,
resourceGroupName,
serviceName,
subscriptionId
FROM azure.api_management.vw_tenant_accesses
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

tenant_accesses

SELECT
properties
FROM azure.api_management.tenant_accesses
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new tenant_accesses resource.

All Properties

/*+ create */
INSERT INTO azure.api_management.tenant_accesses (
If-Match,
accessName,
resourceGroupName,
serviceName,
subscriptionId,
properties
)
SELECT 
'{{ If-Match }}',
'{{ accessName }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: principalId
          value: string
        - name: primaryKey
          value: string
        - name: secondaryKey
          value: string
        - name: enabled
          value: boolean

UPDATE example

Updates a tenant_accesses resource.

/*+ update */
UPDATE azure.api_management.tenant_accesses
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND accessName = '{{ accessName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';