Environments - List

服务:

API Center

API 版本:

2024-02-01-preview

列出环境的集合。

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
region	path	True	string	区域名称
serviceName	path	True	string	区域唯一 API 中心服务名称
workspaceName	path	True	string maxLength: 50	工作区标识符。
api-version	query	True	string minLength: 1	用于此作的 API 版本。
maxpagesize	query		integer (int32)	每个页面的结果项的最大数目。
skip	query		integer (int32)	要跳过的结果项数。
top	query		integer (int32)	要返回的结果项数。

响应

名称	类型	说明
200 OK	PagedEnvironment	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

AadOauth2Auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://azure-apicenter.net/user_impersonation

示例

Environments_List

示例请求

HTTP

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

示例响应

状态代码:

200

{
  "value": [
    {
      "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"
        ]
      }
    }
  ],
  "nextLink": "https://..."
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
Environment	环境资源模型。
EnvironmentKind	环境类型
EnvironmentOnboardingModel	环境载入模型
EnvironmentServer	环境服务器
PagedEnvironment	环境项的分页集合

Azure.Core.Foundations.Error

Object

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

Environment

Object

环境资源模型。

名称	类型	说明
customProperties	object	为环境实体定义的自定义元数据。
description	string maxLength: 1000	环境说明。
kind	EnvironmentKind	部署环境类型。
name	string maxLength: 50	环境标识符。
onboarding	EnvironmentOnboardingModel	载入此环境的信息。
server	EnvironmentServer	环境的服务器信息。
title	string maxLength: 50	环境的名称。

EnvironmentKind

枚举

环境类型

值	说明
development	环境处于开发阶段
testing	环境处于测试阶段
staging	环境处于过渡阶段
production	环境处于生产阶段

EnvironmentOnboardingModel

Object

环境载入模型

名称	类型	说明
developerPortalUris	string[] (uri)	环境的开发人员门户 URI。
instructions	string maxLength: 1000	说明如何载入环境。

EnvironmentServer

Object

环境服务器

名称	类型	说明
managementPortalUris	string[] (uri)	服务器的管理门户的 URI。
type	string	表示环境的服务器的类型。

PagedEnvironment

Object

环境项的分页集合

名称	类型	说明
nextLink	string (uri)	指向下一页项的链接
value	Environment[]	此页上的环境项