Share via


Named Value - Create Or Update

Létrehozza vagy frissíti a névvel ellátott értéket.

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

URI-paraméterek

Name In Kötelező Típus Description
namedValueId
path True

string

A NamedValue azonosítója.

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

resourceGroupName
path True

string

Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.

serviceName
path True

string

A API Management szolgáltatás neve.

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

subscriptionId
path True

string

A cél-előfizetés azonosítója.

api-version
query True

string

A művelethez használandó API-verzió.

Kérelem fejléce

Name Kötelező Típus Description
If-Match

string

Az entitás ETagje. Entitás létrehozásakor nem kötelező, de az entitások frissítésekor szükséges.

Kérelem törzse

Name Kötelező Típus Description
properties.displayName True

string

A NamedValue egyedi neve. Csak betűket, számjegyeket, pontot, kötőjelet és aláhúzásjelet tartalmazhat.

properties.keyVault

KeyVaultContractCreateProperties

A KeyVault nevű Érték helyadatai.

properties.secret

boolean

Meghatározza, hogy az érték titkos-e, és titkosítva kell-e lennie. Az alapértelmezett érték hamis.

properties.tags

string[]

A megadott opcionális címkék a NamedValue lista szűrésére használhatók.

properties.value

string

A NamedValue értéke. Tartalmazhat szabályzatkifejezéseket. Lehet, hogy nem üres, vagy csak szóközből áll. Ez a tulajdonság nem lesz kitöltve a GET műveletekben! Az érték lekéréséhez használja a "/listSecrets" POST kérést.

Válaszok

Name Típus Description
200 OK

NamedValueContract

A névvel ellátott érték frissítése sikerült.

Headers

ETag: string

201 Created

NamedValueContract

A névvel ellátott érték létrehozása sikerült.

Headers

ETag: string

202 Accepted

A névvel ellátott érték létrehozására vagy frissítésére vonatkozó kérés elfogadva.

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

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 felhasználói fiók megszemélyesítése

Példák

ApiManagementCreateNamedValue
ApiManagementCreateNamedValueWithKeyVault

ApiManagementCreateNamedValue

Sample Request

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

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

Sample Response

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

ApiManagementCreateNamedValueWithKeyVault

Sample Request

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

{
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret"
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop6",
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret",
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop6",
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret",
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

Definíciók

Name Description
ErrorFieldContract

Hibamező-szerződés.

ErrorResponse

Hibaválasz.

KeyVaultContractCreateProperties

A keyVault szerződés részleteinek létrehozása.

KeyVaultContractProperties

KeyVault-szerződés részletei.

KeyVaultLastAccessStatusContractProperties

Szerződés frissítési tulajdonságainak kiadása.

NamedValueContract

NamedValue részletei.

NamedValueCreateContract

NamedValue részletei.

ErrorFieldContract

Hibamező-szerződés.

Name Típus Description
code

string

Tulajdonságszintű hibakód.

message

string

A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.

target

string

Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name Típus Description
error.code

string

Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.

error.details

ErrorFieldContract[]

Érvényesítési hiba esetén az érvénytelen mezők listája küldi el a kérést.

error.message

string

A hiba emberi olvasásra alkalmas ábrázolása.

KeyVaultContractCreateProperties

A keyVault szerződés részleteinek létrehozása.

Name Típus Description
identityClientId

string

Null érték a SystemAssignedIdentity vagy a UserAssignedIdentity ügyfélazonosító esetében, amely a kulcstartó titkos kulcsának eléréséhez lesz használva.

secretIdentifier

string

Kulcstartó titkos kulcsazonosítója a titkos kód lekéréséhez. A verziószámozott titkos kód megadása megakadályozza az automatikus frissítést. Ehhez API Management szolgáltatást kell konfigurálni a aka.ms/apimmsi

KeyVaultContractProperties

KeyVault-szerződés részletei.

Name Típus Description
identityClientId

string

Null érték a SystemAssignedIdentity vagy a UserAssignedIdentity ügyfélazonosító esetében, amely a kulcstartó titkos kulcsának eléréséhez lesz használva.

lastStatus

KeyVaultLastAccessStatusContractProperties

A kulcstartó titkos kódjának legutóbbi szinkronizálási és frissítési állapota.

secretIdentifier

string

Kulcstartó titkos kulcsazonosítója a titkos kód lekéréséhez. A verziószámozott titkos kód megadása megakadályozza az automatikus frissítést. Ehhez API Management szolgáltatást kell konfigurálni a aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Szerződés frissítési tulajdonságainak kiadása.

Name Típus Description
code

string

Utolsó állapotkód a kulcstartó titkos kódjának szinkronizálásához és frissítéséhez.

message

string

A hiba részletei üresek.

timeStampUtc

string

Legutóbb a titkos kód elérésekor. A dátum az ISO 8601 szabványban megadott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.

NamedValueContract

NamedValue részletei.

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Az erőforrás neve

properties.displayName

string

A NamedValue egyedi neve. Csak betűket, számjegyeket, pontot, kötőjelet és aláhúzásjelet tartalmazhat.

properties.keyVault

KeyVaultContractProperties

A KeyVault nevű Érték helyadatai.

properties.secret

boolean

Meghatározza, hogy az érték titkos-e, és titkosítva kell-e lennie. Az alapértelmezett érték hamis.

properties.tags

string[]

A megadott opcionális címkék a NamedValue lista szűrésére használhatók.

properties.value

string

A NamedValue értéke. Tartalmazhat szabályzatkifejezéseket. Lehet, hogy nem üres, vagy csak szóközből áll. Ez a tulajdonság nem lesz kitöltve a GET műveletekben! Az érték lekéréséhez használja a "/listSecrets" POST kérést.

type

string

Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

NamedValueCreateContract

NamedValue részletei.

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Az erőforrás neve

properties.displayName

string

A NamedValue egyedi neve. Csak betűket, számjegyeket, pontot, kötőjelet és aláhúzásjelet tartalmazhat.

properties.keyVault

KeyVaultContractCreateProperties

A KeyVault nevű Érték helyadatai.

properties.secret

boolean

Meghatározza, hogy az érték titkos-e, és titkosítva kell-e lennie. Az alapértelmezett érték hamis.

properties.tags

string[]

A megadott opcionális címkék a NamedValue lista szűrésére használhatók.

properties.value

string

A NamedValue értéke. Tartalmazhat szabályzatkifejezéseket. Lehet, hogy nem üres, vagy csak szóközből áll. Ez a tulajdonság nem lesz kitöltve a GET műveletekben! Az érték lekéréséhez használja a "/listSecrets" POST kérést.

type

string

Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"