Enumerate Azure Regions

Enumerate Azure Regions

Get the available regions for specified Azure cloud account

Request
URI
POST
https://{api_host}/iaas/api/cloud-accounts-azure/region-enumeration
COPY
Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about


Request Body
CloudAccountAzureSpecification of type(s) application/json
Optional
{
    "createDefaultZones": true,
    "clientApplicationId": "3287dd6e-76d8-41b7-9856-2584969e7739",
    "clientApplicationSecretKey": "GDfdasDasdASFas321das32cas2x3dsXCSA76xdcasg=",
    "name": "string",
    "tenantId": "9a13d920-4691-4e2d-b5d5-9c4c1279bc9a",
    "description": "string",
    "regionIds": [
        "string"
    ],
    "subscriptionId": "064865b2-e914-4717-b415-8806d17948f7",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}
boolean
createDefaultZones
Optional

Create default cloud zones for the enabled regions.

string
clientApplicationId
Required

Azure Client Application ID

string
clientApplicationSecretKey
Required

Azure Client Application Secret Key

string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
tenantId
Required

Azure Tenant ID

string
description
Optional

A human-friendly description.

array of string
regionIds
Required

A set of Region names to enable provisioning on. Refer to /iaas/cloud-accounts-azure/region-enumeration..

string
subscriptionId
Required

Azure Subscribtion ID

array of Tag
tags
Optional

A set of tag keys and optional values to set on the Cloud Account

Responses
200

successful operation

Returns CloudAccountRegions of type(s) application/json
{
    "externalRegionIds": [
        "string"
    ]
}
array of string
externalRegionIds
Required

A set of region ids for the cloud account.


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure