Named Value - Create Or Update

Benoemde waarde maken of bijwerken.

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

URI-parameters

Name In Vereist Type Description
namedValueId
path True

string

Id van de NamedValue.

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

resourceGroupName
path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName
path True

string

De naam van de API Management service.

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

subscriptionId
path True

string

De id van het doelabonnement.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name Vereist Type Description
If-Match

string

ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit.

Aanvraagbody

Name Vereist Type Description
properties.displayName True

string

Unieke naam van NamedValue. Het mag alleen letters, cijfers, punt, streepje en onderstrepingstekens bevatten.

properties.keyVault

KeyVaultContractCreateProperties

KeyVault-locatiedetails van de namedValue.

properties.secret

boolean

Bepaalt of de waarde een geheim is en moet worden versleuteld of niet. De standaardwaarde is false.

properties.tags

string[]

Optionele tags die indien opgegeven kunnen worden gebruikt om de lijst NamedValue te filteren.

properties.value

string

Waarde van de NamedValue. Kan beleidsexpressies bevatten. Het mag niet leeg zijn of alleen uit witruimte bestaan. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen! Gebruik post-aanvraag '/listSecrets' om de waarde op te halen.

Antwoorden

Name Type Description
200 OK

NamedValueContract

De benoemde waarde is bijgewerkt.

Headers

ETag: string

201 Created

NamedValueContract

De benoemde waarde is gemaakt.

Headers

ETag: string

202 Accepted

Aanvraag voor het maken of bijwerken van een benoemde waarde is geaccepteerd.

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name Description
ErrorFieldContract

Fout veldcontract.

ErrorResponse

Foutreactie.

KeyVaultContractCreateProperties

Maak keyVault-contractgegevens.

KeyVaultContractProperties

Details van het KeyVault-contract.

KeyVaultLastAccessStatusContractProperties

Update-eigenschappen van contract uitgeven.

NamedValueContract

Details van NamedValue.

NamedValueCreateContract

Details van NamedValue.

ErrorFieldContract

Fout veldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.

message

string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target

string

Naam van eigenschap.

ErrorResponse

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

ErrorFieldContract[]

De lijst met ongeldige velden verzenden in aanvraag, in geval van een validatiefout.

error.message

string

Door mensen leesbare weergave van de fout.

KeyVaultContractCreateProperties

Maak keyVault-contractgegevens.

Name Type Description
identityClientId

string

Null voor SystemAssignedIdentity of Client-id voor UserAssignedIdentity , die wordt gebruikt voor toegang tot het sleutelkluisgeheim.

secretIdentifier

string

Sleutelkluisgeheim-id voor het ophalen van het geheim. Als u een geheim met versie op geeft, wordt automatisch vernieuwen voorkomen. Hiervoor moet API Management service worden geconfigureerd met aka.ms/apimmsi

KeyVaultContractProperties

Details van het KeyVault-contract.

Name Type Description
identityClientId

string

Null voor SystemAssignedIdentity of Client-id voor UserAssignedIdentity , die wordt gebruikt voor toegang tot het sleutelkluisgeheim.

lastStatus

KeyVaultLastAccessStatusContractProperties

De laatste keer synchroniseren en vernieuwen van de status van het geheim uit de sleutelkluis.

secretIdentifier

string

Sleutelkluisgeheim-id voor het ophalen van het geheim. Als u een geheim met versie op geeft, wordt automatisch vernieuwen voorkomen. Hiervoor moet API Management service worden geconfigureerd met aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Update-eigenschappen van contract uitgeven.

Name Type Description
code

string

Laatste statuscode voor het synchroniseren en vernieuwen van het geheim uit de sleutelkluis.

message

string

Details van de fout, anders leeg.

timeStampUtc

string

De laatste keer dat het geheim is geopend. De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.

NamedValueContract

Details van NamedValue.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

De naam van de resource

properties.displayName

string

Unieke naam van NamedValue. Het mag alleen letters, cijfers, punt, streepje en onderstrepingstekens bevatten.

properties.keyVault

KeyVaultContractProperties

KeyVault-locatiedetails van de namedValue.

properties.secret

boolean

Bepaalt of de waarde een geheim is en moet worden versleuteld of niet. De standaardwaarde is false.

properties.tags

string[]

Optionele tags die indien opgegeven kunnen worden gebruikt om de lijst NamedValue te filteren.

properties.value

string

Waarde van de NamedValue. Kan beleidsexpressies bevatten. Het mag niet leeg zijn of alleen uit witruimte bestaan. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen! Gebruik post-aanvraag '/listSecrets' om de waarde op te halen.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

NamedValueCreateContract

Details van NamedValue.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

De naam van de resource

properties.displayName

string

Unieke naam van NamedValue. Het mag alleen letters, cijfers, punt, streepje en onderstrepingstekens bevatten.

properties.keyVault

KeyVaultContractCreateProperties

KeyVault-locatiedetails van de namedValue.

properties.secret

boolean

Bepaalt of de waarde een geheim is en moet worden versleuteld of niet. De standaardwaarde is false.

properties.tags

string[]

Optionele tags die indien opgegeven kunnen worden gebruikt om de lijst NamedValue te filteren.

properties.value

string

Waarde van de NamedValue. Kan beleidsexpressies bevatten. Het mag niet leeg zijn of alleen uit witruimte bestaan. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen! Gebruik post-aanvraag '/listSecrets' om de waarde op te halen.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'