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

Tenant Access - Update

更新租户访问信息详细信息。

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

URI 参数

名称 必需 类型 说明
accessName
path True

AccessIdName

Access 配置的标识符。

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求头

名称 必需 类型 说明
If-Match True

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配,或者对于无条件更新,ETag 应为 * 。

请求正文

名称 类型 说明
properties.enabled

boolean

确定是否启用直接访问。

响应

名称 类型 说明
200 OK

AccessInformationContract

已成功更新租户访问信息。

标头

ETag: string

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementUpdateTenantAccess

示例请求

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


{
  "properties": {
    "enabled": true
  }
}

示例响应

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

定义

名称 说明
AccessIdName

Access 配置的标识符。

AccessInformationContract

租户设置。

AccessInformationUpdateParameters

租户访问信息更新参数。

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

AccessIdName

Access 配置的标识符。

名称 类型 说明
access

string

gitAccess

string

AccessInformationContract

租户设置。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.enabled

boolean

确定是否启用直接访问。

properties.id

string

访问信息类型 ('access'或'gitAccess')

properties.principalId

string

主体 (用户) 标识符。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

AccessInformationUpdateParameters

租户访问信息更新参数。

名称 类型 说明
properties.enabled

boolean

确定是否启用直接访问。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

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

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

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

error.details

ErrorFieldContract[]

在发生验证错误时,请求中发送的无效字段列表。

error.message

string

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