Environments - Get

Servicio:

API Center

Versión de la API:

2024-02-01-preview

Obtener un entorno.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
environmentName	path	True	string maxLength: 50	Identificador de entorno.
region	path	True	string	Nombre de la región
serviceName	path	True	string	Nombre del servicio del Centro de API único de la región
workspaceName	path	True	string maxLength: 50	Identificador del área de trabajo.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	Environment	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

AadOauth2Auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

Environments_Get

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

{
  "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"
    ]
  }
}

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Environment	Modelo de recursos de entorno.
EnvironmentKind	Tipo de entorno
EnvironmentOnboardingModel	Modelo de incorporación de entornos
EnvironmentServer	Servidor de entorno

Azure.Core.Foundations.Error

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Object

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

Environment

Object

Modelo de recursos de entorno.

Nombre	Tipo	Description
customProperties	object	Metadatos personalizados definidos para las entidades de entorno.
description	string maxLength: 1000	Descripción del entorno.
kind	EnvironmentKind	Tipo de entorno de implementación.
name	string maxLength: 50	Identificador de entorno.
onboarding	EnvironmentOnboardingModel	Información de incorporación para este entorno.
server	EnvironmentServer	Información del servidor del entorno.
title	string maxLength: 50	Nombre del entorno.

EnvironmentKind

Enumeración

Tipo de entorno

Valor	Description
development	El entorno está en la fase de desarrollo
production	El entorno está en la fase de producción
staging	El entorno está en la fase de ensayo
testing	El entorno está en la fase de prueba

EnvironmentOnboardingModel

Object

Modelo de incorporación de entornos

Nombre	Tipo	Description
developerPortalUris	string[] (uri)	URI del portal para desarrolladores del entorno.
instructions	string maxLength: 1000	Instrucciones sobre cómo incorporar al entorno.

EnvironmentServer

Object

Servidor de entorno

Nombre	Tipo	Description
managementPortalUris	string[] (uri)	URI del portal de administración del servidor.
type	string	Tipo del servidor que representa el entorno.