tenant_configurations

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

Overview

Name	tenant_configurations
Type	Resource
Id	azure.api_management.tenant_configurations

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
deploy	exec	resourceGroupName, serviceName, subscriptionId, configurationName		This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.
save	exec	resourceGroupName, serviceName, subscriptionId, configurationName		This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.
validate	exec	resourceGroupName, serviceName, subscriptionId, configurationName		This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

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
configurationName	string	The identifier of the Git Configuration Operation.
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.

Lifecycle Methods

deploy

This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.

EXEC azure.api_management.tenant_configurations.deploy 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@configurationName='{{ configurationName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

save

This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.

EXEC azure.api_management.tenant_configurations.save 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@configurationName='{{ configurationName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

validate

This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

EXEC azure.api_management.tenant_configurations.validate 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@configurationName='{{ configurationName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;