OpenId Connect Provider - Update
匯報 特定的 OpenID Connect 提供者。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}?api-version=2021-08-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
opid
|
path | True |
string |
OpenID Connect 提供者的標識碼。 Regex 模式: |
resource
|
path | True |
string |
資源群組的名稱。 |
service
|
path | True |
string |
API 管理 服務的名稱。 Regex 模式: |
subscription
|
path | True |
string |
可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。 |
api-version
|
query | True |
string |
要與用戶端要求搭配使用的 API 版本。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
If-Match | True |
string |
實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態,否則應該為 * 進行無條件更新。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
properties.clientId |
string |
開發人員主控台的用戶端識別碼,也就是用戶端應用程式。 |
properties.clientSecret |
string |
開發人員主控台的客戶端密碼,這是用戶端應用程式。 |
properties.description |
string |
OpenID Connect 提供者的用戶易記描述。 |
properties.displayName |
string |
用戶易記的 OpenID Connect 提供者名稱。 |
properties.metadataEndpoint |
string |
元數據端點 URI。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
OpenIdConnect 提供者已成功更新。 標題 ETag: string |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
ApiManagementUpdateOpenIdConnectProvider
範例要求
範例回覆
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2",
"type": "Microsoft.ApiManagement/service/openidconnectproviders",
"name": "templateOpenIdConnect2",
"properties": {
"displayName": "templateoidprovider2",
"description": "open id provider template2",
"metadataEndpoint": "https://oidprovider-template2.net",
"clientId": "oidprovidertemplate2"
}
}
定義
名稱 | Description |
---|---|
Error |
錯誤欄位合約。 |
Error |
錯誤回應。 |
Openid |
OpenId Connect 提供者詳細數據。 |
Openid |
提供給 Update OpenID Connect 提供者作業的參數。 |
ErrorFieldContract
錯誤欄位合約。
名稱 | 類型 | Description |
---|---|---|
code |
string |
屬性層級錯誤碼。 |
message |
string |
人類可讀取的屬性層級錯誤表示法。 |
target |
string |
屬性名稱。 |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error.code |
string |
服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。 |
error.details |
在驗證錯誤時,要求中傳送的無效欄位清單。 |
|
error.message |
string |
人類可閱讀的錯誤表示法。 |
OpenidConnectProviderContract
OpenId Connect 提供者詳細數據。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
資源的名稱 |
properties.clientId |
string |
開發人員主控台的用戶端識別碼,也就是用戶端應用程式。 |
properties.clientSecret |
string |
開發人員主控台的客戶端密碼,這是用戶端應用程式。 |
properties.description |
string |
OpenID Connect 提供者的用戶易記描述。 |
properties.displayName |
string |
用戶易記的 OpenID Connect 提供者名稱。 |
properties.metadataEndpoint |
string |
元數據端點 URI。 |
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
OpenidConnectProviderUpdateContract
提供給 Update OpenID Connect 提供者作業的參數。
名稱 | 類型 | Description |
---|---|---|
properties.clientId |
string |
開發人員主控台的用戶端識別碼,也就是用戶端應用程式。 |
properties.clientSecret |
string |
開發人員主控台的客戶端密碼,這是用戶端應用程式。 |
properties.description |
string |
OpenID Connect 提供者的用戶易記描述。 |
properties.displayName |
string |
用戶易記的 OpenID Connect 提供者名稱。 |
properties.metadataEndpoint |
string |
元數據端點 URI。 |