Een lijst met alle Azure-regio's waarin de service bestaat.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions?api-version=2022-08-01
URI-parameters
| Name |
In |
Vereist |
Type |
Description |
|
resourceGroupName
|
path |
True
|
string
|
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
|
|
serviceName
|
path |
True
|
string
|
De naam van de API Management service.
Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
|
subscriptionId
|
path |
True
|
string
|
De id van het doelabonnement.
|
|
api-version
|
query |
True
|
string
|
De API-versie die voor deze bewerking moet worden gebruikt.
|
Antwoorden
| Name |
Type |
Description |
|
200 OK
|
RegionListResult
|
Lijsten met regio's waarin de service wordt geïmplementeerd.
|
|
Other Status Codes
|
ErrorResponse
|
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.
|
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
uw gebruikersaccount imiteren
|
Voorbeelden
ApiManagementListRegions
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/regions?api-version=2022-08-01
/** Samples for Region ListByService. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListRegions.json
*/
/**
* Sample code: ApiManagementListRegions.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementListRegions(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager.regions().listByService("rg1", "apimService1", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apimanagement
# USAGE
python api_management_list_regions.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ApiManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.region.list_by_service(
resource_group_name="rg1",
service_name="apimService1",
)
for item in response:
print(item)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListRegions.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armapimanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListRegions.json
func ExampleRegionClient_NewListByServicePager() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewRegionClient().NewListByServicePager("rg1", "apimService1", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.RegionListResult = armapimanagement.RegionListResult{
// Count: to.Ptr[int64](1),
// Value: []*armapimanagement.RegionContract{
// {
// Name: to.Ptr("West US"),
// IsDeleted: to.Ptr(false),
// IsMasterRegion: to.Ptr(true),
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists all azure regions in which the service exists.
*
* @summary Lists all azure regions in which the service exists.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListRegions.json
*/
async function apiManagementListRegions() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.region.listByService(resourceGroupName, serviceName)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"value": [
{
"name": "West US",
"isMasterRegion": true,
"isDeleted": false
}
],
"count": 1,
"nextLink": ""
}
Definities
ErrorFieldContract
Fout Veldcontract.
| Name |
Type |
Description |
|
code
|
string
|
Foutcode op eigenschapsniveau.
|
|
message
|
string
|
Door mensen leesbare weergave van fout op eigenschapsniveau.
|
|
target
|
string
|
Naam van eigenschap.
|
ErrorResponse
Foutreactie.
| Name |
Type |
Description |
|
error.code
|
string
|
Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
|
|
error.details
|
ErrorFieldContract[]
|
De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.
|
|
error.message
|
string
|
Door mensen leesbare weergave van de fout.
|
RegionContract
Regioprofiel.
| Name |
Type |
Description |
|
isDeleted
|
boolean
|
of Regio is verwijderd.
|
|
isMasterRegion
|
boolean
|
of Regio de hoofdregio is.
|
|
name
|
string
|
Regionaam.
|
RegionListResult
Geeft een overzicht van de details van de bewerkingsreacties van Regio's.
| Name |
Type |
Description |
|
count
|
integer
|
Totaal aantal records voor alle pagina's.
|
|
nextLink
|
string
|
Koppeling naar volgende pagina, indien aanwezig.
|
|
value
|
RegionContract[]
|
Lijsten met regio's.
|