Dela via


Region - List By Service

Visar en lista över alla Azure-regioner där tjänsten finns.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions?api-version=2022-08-01

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName
path True

string

Namnet på API Management-tjänsten.

Reguljärt uttrycksmönster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

RegionListResult

Listor över regioner där tjänsten distribueras.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementListRegions

Exempelbegäran

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/regions?api-version=2022-08-01

Exempelsvar

{
  "value": [
    {
      "name": "West US",
      "isMasterRegion": true,
      "isDeleted": false
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definitioner

Name Description
ErrorFieldContract

Fel fältkontrakt.

ErrorResponse

Felsvar.

RegionContract

Regionprofil.

RegionListResult

Visar svarsinformation om regionsåtgärden.

ErrorFieldContract

Fel fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.

message

string

Mänsklig läsbar representation av fel på egenskapsnivå.

target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.

error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, vid valideringsfel.

error.message

string

Mänsklig läsbar representation av felet.

RegionContract

Regionprofil.

Name Typ Description
isDeleted

boolean

om Region tas bort.

isMasterRegion

boolean

om Region är huvudregionen.

name

string

Regionnamn.

RegionListResult

Visar svarsinformation om regionsåtgärden.

Name Typ Description
count

integer

Totalt antal poster på alla sidor.

nextLink

string

Länk till nästa sida om det finns någon.

value

RegionContract[]

Listor över regioner.