Hizmetin bulunduğu tüm Azure bölgelerini listeler.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions?api-version=2022-08-01
URI Parametreleri
Name |
İçinde |
Gerekli |
Tür |
Description |
resourceGroupName
|
path |
True
|
string
|
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
|
serviceName
|
path |
True
|
string
|
API Management hizmetinin adı.
Normal ifade deseni: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
subscriptionId
|
path |
True
|
string
|
Hedef aboneliğin kimliği.
|
api-version
|
query |
True
|
string
|
Bu işlem için kullanılacak API sürümü.
|
Yanıtlar
Name |
Tür |
Description |
200 OK
|
RegionListResult
|
Hizmetin dağıtıldığı Bölgelerin listesi.
|
Other Status Codes
|
ErrorResponse
|
İşlemin neden başarısız olduğunu açıklayan hata yanıtı.
|
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name |
Description |
user_impersonation
|
kullanıcı hesabınızın kimliğine bürünme
|
Örnekler
ApiManagementListRegions
Örnek isteği
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
Örnek yanıt
{
"value": [
{
"name": "West US",
"isMasterRegion": true,
"isDeleted": false
}
],
"count": 1,
"nextLink": ""
}
Tanımlar
ErrorFieldContract
Hata Alanı sözleşmesi.
Name |
Tür |
Description |
code
|
string
|
Özellik düzeyi hata kodu.
|
message
|
string
|
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
|
target
|
string
|
Özellik adı.
|
ErrorResponse
Hata Yanıtı.
Name |
Tür |
Description |
error.code
|
string
|
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
|
error.details
|
ErrorFieldContract[]
|
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
|
error.message
|
string
|
Hatanın insan tarafından okunabilen gösterimi.
|
RegionContract
Bölge profili.
Name |
Tür |
Description |
isDeleted
|
boolean
|
Bölge'nin silinip silinmediği.
|
isMasterRegion
|
boolean
|
Region öğesinin ana bölge olup olmadığı.
|
name
|
string
|
Bölge adı.
|
RegionListResult
Bölgelerin işlem yanıt ayrıntılarını listeler.
Name |
Tür |
Description |
count
|
integer
|
Tüm sayfalardaki toplam kayıt sayısı.
|
nextLink
|
string
|
Varsa sonraki sayfa bağlantısı.
|
value
|
RegionContract[]
|
Bölge Listeleri.
|