Getting Location by Name

In this article

    You can get information about a Microsoft Azure region with the specified name.

    Request

    GET https://<hostname>:4443/v6/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/Locations/{locationName}

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameters must be specified in the URL of the request:

    Parameter

    Type

    Description

    serviceAccountId

    string

    Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Getting Azure Service Accounts.

    subscriptionId

    string

    Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Getting Subscriptions.

    locationName

    string

    Specifies the Microsoft Azure region name. For more information on how to get this parameter, see Getting Locations.

    Request Body

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    The response body contains the following properties:

    Property

    Type

    Description

    name

    string

    Specifies the Microsoft Azure region name.

    displayName

    string

    Specifies the Microsoft Azure region display name.

    Example

    The example shows how to get information about the westeurope Microsoft Azure region.

    Request:

    GET https://abc.tech.local:4443/v6/AzureServiceAccounts/576705c3-a1af-49bd-878f-9067865bfcf9/Subscriptions/be7051ea-8fa4-4605-c607-89f3dd09fffd/Locations/westeurope

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "name": "westeurope",

     "displayName": "West Europe"

    }