Megosztás a következőn keresztül:


Environments - Get

Környezet lekérése.

GET https://{serviceName}.data.{region}.azure-apicenter.ms/workspaces/{workspaceName}/environments/{environmentName}?api-version=2024-02-01-preview

URI-paraméterek

Name In Kötelező Típus Description
environmentName
path True

string

maxLength: 50

Környezeti azonosító.

region
path True

string

Régió neve

serviceName
path True

string

Régiónként egyedi API Center-szolgáltatásnév

workspaceName
path True

string

maxLength: 50

Munkaterület azonosítója.

api-version
query True

string

minLength: 1

A művelethez használni kívánt API-verzió.

Válaszok

Name Típus Description
200 OK

Environment

A kérés sikeres volt.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Váratlan hibaválasz.

Fejlécek

x-ms-error-code: string

Biztonság

AadOauth2Auth

Az Azure Active Directory OAuth2 flow

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize
Jogkivonat URL-címe: https://login.microsoftonline.com/common/oauth2/token

Hatókörök

Name Description
https://azure-apicenter.net/user_impersonation

Példák

Environments_Get

Mintakérelem

GET https://{serviceName}.data.{region}.azure-apicenter.ms/workspaces/default/environments/production?api-version=2024-02-01-preview

Mintaválasz

{
  "name": "public",
  "title": "Public",
  "description": "Public Cloud environment.",
  "kind": "production",
  "server": {
    "type": "Azure API Management",
    "managementPortalUris": [
      "https://portal.azure.com"
    ]
  },
  "onboarding": {
    "instructions": "https://aka.ms/apim-devportal",
    "developerPortalUris": [
      "https://contoso.developer.azure-api.net"
    ]
  }
}

Definíciók

Name Description
Azure.Core.Foundations.Error

A hibaobjektum.

Azure.Core.Foundations.ErrorResponse

Hibaadatokat tartalmazó válasz.

Azure.Core.Foundations.InnerError

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Environment

Környezeti erőforrásmodell.

EnvironmentKind

Környezet típusa

EnvironmentOnboardingModel

Környezet előkészítési modellje

EnvironmentServer

Környezeti kiszolgáló

Azure.Core.Foundations.Error

A hibaobjektum.

Name Típus Description
code

string

A kiszolgáló által definiált hibakódok egyike.

details

Azure.Core.Foundations.Error[]

A jelentett hibához vezető konkrét hibák részleteinek tömbje.

innererror

Azure.Core.Foundations.InnerError

Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.

message

string

A hiba ember által olvasható ábrázolása.

target

string

A hiba célja.

Azure.Core.Foundations.ErrorResponse

Hibaadatokat tartalmazó válasz.

Name Típus Description
error

Azure.Core.Foundations.Error

A hibaobjektum.

Azure.Core.Foundations.InnerError

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name Típus Description
code

string

A kiszolgáló által definiált hibakódok egyike.

innererror

Azure.Core.Foundations.InnerError

Belső hiba.

Environment

Környezeti erőforrásmodell.

Name Típus Description
customProperties

object

A környezeti entitásokhoz definiált egyéni metaadatok.

description

string

maxLength: 1000

A környezet leírása.

kind

EnvironmentKind

Az üzembehelyezési környezet típusa.

name

string

maxLength: 50

Környezeti azonosító.

onboarding

EnvironmentOnboardingModel

A környezet információinak előkészítése.

server

EnvironmentServer

A környezet kiszolgálóadatai.

title

string

maxLength: 50

A környezet neve.

EnvironmentKind

Környezet típusa

Érték Description
development

A környezet a fejlesztési fázisban van

production

A környezet az éles fázisban van

staging

A környezet az előkészítési fázisban van

testing

A környezet a tesztelési fázisban van

EnvironmentOnboardingModel

Környezet előkészítési modellje

Name Típus Description
developerPortalUris

string[] (uri)

A fejlesztői portál környezeti URI-i.

instructions

string

maxLength: 1000

Útmutatás a környezetbe való előkészítéshez.

EnvironmentServer

Környezeti kiszolgáló

Name Típus Description
managementPortalUris

string[] (uri)

A kiszolgáló felügyeleti portáljának URI-i.

type

string

A környezetet képviselő kiszolgáló típusa.