Named Value - Create Or Update

Skapar eller uppdaterar namngivet värde.

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

URI-parametrar

Name I Obligatorisk Typ Description
namedValueId
path True

string

Identifierare för NamedValue.

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

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName
path True

string

Namnet på API Management-tjänsten.

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

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet.

Begärandetext

Name Obligatorisk Typ Description
properties.displayName True

string

Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck.

properties.keyVault

KeyVaultContractCreateProperties

KeyVault-platsinformation för namedValue.

properties.secret

boolean

Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt.

properties.tags

string[]

Valfria taggar som när de tillhandahålls kan användas för att filtrera listan NamedValue.

properties.value

string

Värdet för NamedValue. Kan innehålla principuttryck. Den kanske inte är tom eller bara består av blanksteg. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.

Svar

Name Typ Description
200 OK

NamedValueContract

Det namngivna värdet har uppdaterats.

Headers

ETag: string

201 Created

NamedValueContract

Det namngivna värdet har skapats.

Headers

ETag: string

202 Accepted

Begäran om att skapa eller uppdatera det namngivna värdet godkändes.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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 personifiera ditt användarkonto

Exempel

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

Definitioner

Name Description
ErrorFieldContract

Fel Fältkontrakt.

ErrorResponse

Felsvar.

KeyVaultContractCreateProperties

Skapa keyVault-kontraktinformation.

KeyVaultContractProperties

Information om KeyVault-kontrakt.

KeyVaultLastAccessStatusContractProperties

Problem med uppdateringsegenskaper för kontrakt.

NamedValueContract

NamedValue-information.

NamedValueCreateContract

NamedValue-information.

ErrorFieldContract

Fel Fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.

message

string

Mänsklig läsbar representation av fel på egenskapsnivå.

target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.

error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.

error.message

string

Mänsklig läsbar representation av felet.

KeyVaultContractCreateProperties

Skapa keyVault-kontraktinformation.

Name Typ Description
identityClientId

string

Null för SystemAssignedIdentity eller Klient-ID för UserAssignedIdentity , som används för att komma åt nyckelvalvshemlighet.

secretIdentifier

string

Hemlig identifierare för Nyckelvalv för att hämta hemlighet. Om du anger en versionshemlighet förhindrar du automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi

KeyVaultContractProperties

Information om KeyVault-kontrakt.

Name Typ Description
identityClientId

string

Null för SystemAssignedIdentity eller Klient-ID för UserAssignedIdentity , som används för att komma åt nyckelvalvshemlighet.

lastStatus

KeyVaultLastAccessStatusContractProperties

Senaste tidssynkronisering och uppdateringsstatus för hemligheten från nyckelvalvet.

secretIdentifier

string

Hemlig identifierare för Nyckelvalv för att hämta hemlighet. Om du anger en versionshemlighet förhindrar du automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Problem med uppdateringsegenskaper för kontrakt.

Name Typ Description
code

string

Senaste statuskod för synkronisering och uppdatering av hemlighet från nyckelvalvet.

message

string

Information om felet är tomt.

timeStampUtc

string

Senaste gången hemligheten användes. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.

NamedValueContract

NamedValue-information.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.displayName

string

Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck.

properties.keyVault

KeyVaultContractProperties

KeyVault-platsinformation för namedValue.

properties.secret

boolean

Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt.

properties.tags

string[]

Valfria taggar som när de tillhandahålls kan användas för att filtrera listan NamedValue.

properties.value

string

Värdet för NamedValue. Kan innehålla principuttryck. Den kanske inte är tom eller bara består av blanksteg. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

NamedValueCreateContract

NamedValue-information.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.displayName

string

Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck.

properties.keyVault

KeyVaultContractCreateProperties

KeyVault-platsinformation för namedValue.

properties.secret

boolean

Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt.

properties.tags

string[]

Valfria taggar som när de tillhandahålls kan användas för att filtrera listan NamedValue.

properties.value

string

Värdet för NamedValue. Kan innehålla principuttryck. Den kanske inte är tom eller bara består av blanksteg. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"