tenant_access

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

Overview

Name	tenant_access
Type	Resource
Id	azure.api_management.tenant_access

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.
enabled	boolean	Determines whether direct access is enabled.
principalId	string	Principal (User) Identifier.
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_service

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.
enabled	boolean	Determines whether direct access is enabled.
principalId	string	Principal (User) Identifier.
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, service_name, access_name, subscription_id		Get tenant access information details without secrets.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter	Returns list of access infos - for Git and Management endpoints.
create	insert	resource_group_name, service_name, access_name, subscription_id		Update tenant access information details.
update	update	resource_group_name, service_name, access_name, subscription_id		Update tenant access information details.
get_entity_tag	exec	resource_group_name, service_name, access_name, subscription_id		Tenant access metadata.
list_secrets	exec	resource_group_name, service_name, access_name, subscription_id		Get tenant access information details.
regenerate_primary_key	exec	resource_group_name, service_name, access_name, subscription_id		Regenerate primary access key.
regenerate_secondary_key	exec	resource_group_name, service_name, access_name, subscription_id		Regenerate secondary access key.

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
access_name	string	The identifier of the Access configuration. Known values are: "access" and "gitAccess". Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	Not used. Default value is None.

SELECT examples

get

Get tenant access information details without secrets.

SELECT
id,
name,
enabled,
principalId,
systemData,
type
FROM azure.api_management.tenant_access
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND access_name = '{{ access_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

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

SELECT
id,
name,
enabled,
principalId,
systemData,
type
FROM azure.api_management.tenant_access
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Update tenant access information details.

INSERT INTO azure.api_management.tenant_access (
properties,
resource_group_name,
service_name,
access_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ access_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: tenant_access
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the tenant_access resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the tenant_access resource.
  - name: access_name
    value: "{{ access_name }}"
    description: Required parameter for the tenant_access resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the tenant_access resource.
  - name: properties
    description: |
      Tenant access information update parameter properties.
    value:
      principalId: "{{ principalId }}"
      primaryKey: "{{ primaryKey }}"
      secondaryKey: "{{ secondaryKey }}"
      enabled: {{ enabled }}

UPDATE examples

update

Update tenant access information details.

UPDATE azure.api_management.tenant_access
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND access_name = '{{ access_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

get_entity_tag

Tenant access metadata.

EXEC azure.api_management.tenant_access.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@access_name='{{ access_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_secrets

Get tenant access information details.

EXEC azure.api_management.tenant_access.list_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@access_name='{{ access_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_primary_key

Regenerate primary access key.

EXEC azure.api_management.tenant_access.regenerate_primary_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@access_name='{{ access_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_secondary_key

Regenerate secondary access key.

EXEC azure.api_management.tenant_access.regenerate_secondary_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@access_name='{{ access_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;