共用方式為


Named Value - Update

匯報 特定的具名值。

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

URI 參數

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

string

NamedValue 的標識碼。

Regex 模式: ^[^*#&+:<>?]+$

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

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

api-version
query True

string

要與用戶端要求搭配使用的 API 版本。

要求標頭

名稱 必要 類型 Description
If-Match True

string

實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態,否則應該為 * 進行無條件更新。

要求本文

名稱 類型 Description
properties.displayName

string

NamedValue 的唯一名稱。 只能包含字母、數字、句點、破折號和底線字元。

properties.keyVault

KeyVaultContractCreateProperties

namedValue的KeyVault位置詳細數據。

properties.secret

boolean

決定該值是否為密碼且是否應該加密。 預設值為 False。

properties.tags

string[]

提供時可用來篩選 NamedValue 清單的選擇性標籤。

properties.value

string

NamedValue 的值。 可以包含原則表達式。 不能是空白或只由空白字元組成。

回應

名稱 類型 Description
200 OK

NamedValueContract

已成功更新具名值。

標題

ETag: string

202 Accepted

已接受建立或更新具名值的要求。

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 模擬您的用戶帳戶

範例

ApiManagementUpdateNamedValue

範例要求

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


{
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar2"
    ],
    "secret": false
  }
}

範例回覆

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2021-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=204
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar2"
    ],
    "secret": false
  }
}

定義

名稱 Description
ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

KeyVaultContractCreateProperties

建立keyVault合約詳細數據。

KeyVaultContractProperties

KeyVault 合約詳細數據。

KeyVaultLastAccessStatusContractProperties

發出合約更新屬性。

NamedValueContract

NamedValue 詳細數據。

NamedValueUpdateParameters

NamedValue 更新參數。

ErrorFieldContract

錯誤欄位合約。

名稱 類型 Description
code

string

屬性層級錯誤碼。

message

string

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

target

string

屬性名稱。

ErrorResponse

錯誤回應。

名稱 類型 Description
error.code

string

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

error.details

ErrorFieldContract[]

在驗證錯誤時,要求中傳送的無效欄位清單。

error.message

string

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

KeyVaultContractCreateProperties

建立keyVault合約詳細數據。

名稱 類型 Description
identityClientId

string

SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的用戶端識別符,將用來存取密鑰保存庫秘密。

secretIdentifier

string

用於擷取秘密的金鑰保存庫秘密標識碼。 提供已建立版本的秘密將會防止自動重新整理。 這需要以 aka.ms/apimmsi 設定 API 管理 服務

KeyVaultContractProperties

KeyVault 合約詳細數據。

名稱 類型 Description
identityClientId

string

SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的用戶端識別符,將用來存取密鑰保存庫秘密。

lastStatus

KeyVaultLastAccessStatusContractProperties

上次從金鑰保存庫同步處理和重新整理秘密的狀態。

secretIdentifier

string

用於擷取秘密的金鑰保存庫秘密標識碼。 提供已建立版本的秘密將會防止自動重新整理。 這需要以 aka.ms/apimmsi 設定 API 管理 服務

KeyVaultLastAccessStatusContractProperties

發出合約更新屬性。

名稱 類型 Description
code

string

上次從金鑰保存庫同步和重新整理秘密的狀態代碼。

message

string

錯誤的詳細數據,否則為空白。

timeStampUtc

string

上次存取秘密的時間。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。

NamedValueContract

NamedValue 詳細數據。

名稱 類型 Description
id

string

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

name

string

資源的名稱

properties.displayName

string

NamedValue 的唯一名稱。 只能包含字母、數字、句點、破折號和底線字元。

properties.keyVault

KeyVaultContractProperties

namedValue的KeyVault位置詳細數據。

properties.secret

boolean

決定該值是否為密碼且是否應該加密。 預設值為 False。

properties.tags

string[]

提供時可用來篩選 NamedValue 清單的選擇性標籤。

properties.value

string

NamedValue 的值。 可以包含原則表達式。 不能是空白或只由空白字元組成。 此屬性不會填入 『GET』 作業! 使用 '/listSecrets' POST 要求來取得值。

type

string

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

NamedValueUpdateParameters

NamedValue 更新參數。

名稱 類型 Description
properties.displayName

string

NamedValue 的唯一名稱。 只能包含字母、數字、句點、破折號和底線字元。

properties.keyVault

KeyVaultContractCreateProperties

namedValue的KeyVault位置詳細數據。

properties.secret

boolean

決定該值是否為密碼且是否應該加密。 預設值為 False。

properties.tags

string[]

提供時可用來篩選 NamedValue 清單的選擇性標籤。

properties.value

string

NamedValue 的值。 可以包含原則表達式。 不能是空白或只由空白字元組成。