regions
Creates, updates, deletes, gets or lists a regions
resource.
Overview
Name | regions |
Type | Resource |
Id | azure.api_management.regions |
Fields
The following fields are returned by SELECT
queries:
- list_by_service
Lists of Regions in which the service is deployed.
Name | Datatype | Description |
---|---|---|
name | string | Region name. |
isDeleted | boolean | whether Region is deleted. |
isMasterRegion | boolean | whether Region is the master region. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list_by_service | select | resourceGroupName , serviceName , subscriptionId | Lists all azure regions in which the service exists. |
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 |
---|---|---|
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_by_service
Lists all azure regions in which the service exists.
SELECT
name,
isDeleted,
isMasterRegion
FROM azure.api_management.regions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;