共用方式為


Tenant Access - Create

更新租使用者存取資訊詳細數據。

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

URI 參數

名稱 位於 必要 類型 Description
accessName
path True

AccessIdName

Access 組態的標識碼。

resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

serviceName
path True

string

API 管理 服務的名稱。

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

subscriptionId
path True

string

目標訂用帳戶的標識碼。

api-version
query True

string

用於此作業的 API 版本。

要求標頭

名稱 必要 類型 Description
If-Match True

string

實體的 ETag。 ETag 應該符合 GET 要求的標頭回應中目前的實體狀態,或者它應該是 * 進行無條件更新。

要求本文

名稱 類型 Description
properties.enabled

boolean

判斷是否啟用直接存取。

properties.primaryKey

string

主要存取金鑰。 此屬性不會填入 『GET』 作業! 使用 '/listSecrets' POST 要求來取得值。

properties.principalId

string

主體 (使用者) 標識碼。

properties.secondaryKey

string

次要存取金鑰。 此屬性不會填入 『GET』 作業! 使用 '/listSecrets' POST 要求來取得值。

回應

名稱 類型 Description
200 OK

AccessInformationContract

租使用者存取資訊已成功更新。

標題

ETag: string

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

ApiManagementCreateTenantAccess

範例要求

PUT 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
  }
}

定義

名稱 Description
AccessIdName

Access 組態的標識碼。

AccessInformationContract

租用戶設定。

AccessInformationCreateParameters

租使用者存取資訊更新參數。

ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

AccessIdName

Access 組態的標識碼。

名稱 類型 Description
access

string

gitAccess

string

AccessInformationContract

租用戶設定。

名稱 類型 Description
id

string

資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

資源的名稱

properties.enabled

boolean

判斷是否啟用直接存取。

properties.id

string

Access Information type ('access' 或 'gitAccess')

properties.principalId

string

主體 (使用者) 標識碼。

type

string

資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

AccessInformationCreateParameters

租使用者存取資訊更新參數。

名稱 類型 Description
properties.enabled

boolean

判斷是否啟用直接存取。

properties.primaryKey

string

主要存取金鑰。 此屬性不會填入 『GET』 作業! 使用 '/listSecrets' POST 要求來取得值。

properties.principalId

string

主體 (使用者) 標識碼。

properties.secondaryKey

string

次要存取金鑰。 此屬性不會填入 『GET』 作業! 使用 '/listSecrets' POST 要求來取得值。

ErrorFieldContract

錯誤欄位合約。

名稱 類型 Description
code

string

屬性層級錯誤碼。

message

string

人類可讀取的屬性層級錯誤表示法。

target

string

屬性名稱。

ErrorResponse

錯誤回應。

名稱 類型 Description
error.code

string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。

error.details

ErrorFieldContract[]

要求中傳送無效欄位的清單,以防發生驗證錯誤。

error.message

string

人類可閱讀的錯誤表示法。