你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Tenant Access - List By Service

返回访问信息列表 - Git 和管理终结点。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant?api-version=2020-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant?$filter={$filter}&api-version=2020-12-01

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

资源组的名称。

serviceName
path True
  • string

API 管理服务的名称。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

要用于客户端请求的 API 的版本。

$filter
query
  • string

未使用

响应

Name Type Description
200 OK

列出 TenantAccessInfo 实体的集合。

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

ApiManagementListTenantAccess

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant?api-version=2020-12-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access",
      "type": "Microsoft.ApiManagement/service/tenant",
      "name": "access",
      "properties": {
        "enabled": true
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定义

AccessInformationCollection

分页 AccessInformation 列表表示形式。

AccessInformationContract

租户设置。

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

AccessInformationCollection

分页 AccessInformation 列表表示形式。

Name Type Description
count
  • integer

所有页面的总记录计数数。

nextLink
  • string

下一页链接(如果有)。

value

页面值。

AccessInformationContract

租户设置。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.enabled
  • boolean

确定是否启用了直接访问。

properties.id
  • string

访问信息类型 (“access”或“gitAccess”)

properties.principalId
  • string

主体 (用户) 标识符。

type
  • string

API 管理资源的资源类型。

ErrorFieldContract

错误字段协定。

Name Type Description
code
  • string

属性级错误代码。

message
  • string

属性级错误的人类可读表示形式。

target
  • string

属性名称。

ErrorResponse

错误响应。

Name Type Description
error.code
  • string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

请求中发送的无效字段列表(如果出现验证错误)。

error.message
  • string

错误的用户可读表示形式。