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

The following fields are returned by SELECT queries:

get

Tenant Access information.

Name	Datatype	Description
properties	object	AccessInformation entity contract properties.

list_by_service

Lists a collection of TenantAccessInfo entities.

Name	Datatype	Description
properties	object	AccessInformation entity contract properties.

Methods

The following methods are available for this resource:

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

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
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.
$filter	string	Not used

SELECT examples

get

Get tenant access information details without secrets.

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

list_by_service

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

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

INSERT examples

create

Update tenant access information details.

INSERT INTO azure.api_management.tenant_accesses (
data__properties,
resourceGroupName,
serviceName,
accessName,
If-Match,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ accessName }}',
'{{ If-Match }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: tenant_accesses
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the tenant_accesses resource.
    - name: serviceName
      value: string
      description: Required parameter for the tenant_accesses resource.
    - name: accessName
      value: string
      description: Required parameter for the tenant_accesses resource.
    - name: If-Match
      value: string
      description: Required parameter for the tenant_accesses resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the tenant_accesses resource.
    - name: properties
      value: object
      description: |
        Tenant access information update parameter properties.

UPDATE examples

update

Update tenant access information details.

UPDATE azure.api_management.tenant_accesses
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND accessName = '{{ accessName }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

Lifecycle Methods

regenerate_primary_key

Regenerate primary access key

EXEC azure.api_management.tenant_accesses.regenerate_primary_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@accessName='{{ accessName }}' --required
;

regenerate_secondary_key

Regenerate secondary access key

EXEC azure.api_management.tenant_accesses.regenerate_secondary_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@accessName='{{ accessName }}' --required
;

regenerate_git_primary_key

Regenerate primary access key for GIT.

EXEC azure.api_management.tenant_accesses.regenerate_git_primary_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@accessName='{{ accessName }}' --required
;

regenerate_git_secondary_key

Regenerate secondary access key for GIT.

EXEC azure.api_management.tenant_accesses.regenerate_git_secondary_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@accessName='{{ accessName }}' --required
;