Named Value - Create Or Update

Erstellt oder aktualisiert einen benannten Wert

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

URI-Parameter

Name In Required Type Description
namedValueId
path True
  • string

Bezeichner des NamedValue.

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

resourceGroupName
path True
  • string

Der Name der Ressourcengruppe.

serviceName
path True
  • string

Der Name des API Management Diensts.

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

subscriptionId
path True
  • string

Abonnementanmeldeinformationen, die Microsoft Azure eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True
  • string

Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungsheader

Name Required Type Description
If-Match
  • string

ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, beim Aktualisieren einer Entität jedoch erforderlich.

Anforderungstext

Name Required Type Description
properties.displayName True
  • string

Eindeutiger Name von NamedValue. Er kann nur Buchstaben, Ziffern, Punkte, Gedankenstriche und Unterstriche enthalten.

properties.keyVault

KeyVault-Speicherortdetails des namedValue.

properties.secret
  • boolean

Bestimmt, ob der Wert ein geheimer Schlüssel ist und ob er verschlüsselt werden sollte. Der Standardwert ist „false“.

properties.tags
  • string[]

Optionale Tags, die, sofern angegeben, zum Filtern der NamedValue-Liste verwendet werden können.

properties.value
  • string

Der Wert des NamedValue. Kann Richtlinienausdrücke enthalten. Er darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert zu erhalten.

Antworten

Name Type Description
200 OK

Der benannte Wert wurde erfolgreich aktualisiert.

Headers

  • ETag: string
201 Created

Der benannte Wert wurde erfolgreich erstellt.

Headers

  • ETag: string
202 Accepted

Die Anforderung zum Erstellen oder Aktualisieren eines benannten Werts wurde akzeptiert.

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

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 Imitate your user account (Identität Ihres Benutzerkontos imitieren)

Beispiele

ApiManagementCreateNamedValue
ApiManagementCreateNamedValueWithKeyVault

ApiManagementCreateNamedValue

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2020-12-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=2020-12-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=2020-12-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=2020-12-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
  }
}

Definitionen

ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

KeyVaultContractCreateProperties

Erstellen Sie keyVault-Vertragsdetails.

KeyVaultContractProperties

KeyVault-Vertragsdetails.

KeyVaultLastAccessStatusContractProperties

Geben Sie Die Updateeigenschaften des Vertrags aus.

NamedValueContract

NamedValue-Details.

NamedValueCreateContract

NamedValue-Details.

ErrorFieldContract

Fehlerfeldvertrag.

Name Type Description
code
  • string

Fehlercode auf Eigenschaftsebene.

message
  • string

Für Menschen lesbare Darstellung von Fehlern auf Eigenschaftsebene.

target
  • string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Type Description
error.code
  • string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

Die Liste der ungültigen Felder, die bei einem Validierungsfehler in der Anforderung gesendet werden.

error.message
  • string

Lesbare Darstellung des Fehlers.

KeyVaultContractCreateProperties

Erstellen Sie keyVault-Vertragsdetails.

Name Type Description
identityClientId
  • string

SystemAssignedIdentity oder UserAssignedIdentity-Client-ID, die für den Zugriff auf das Schlüsseltresorgeheimnis verwendet wird.

secretIdentifier
  • string

Schlüsseltresor-Geheimnisbezeichner zum Abrufen des Geheimnisses. Wenn Sie ein Geheimnis mit Versionsversion bereitstellen, wird die automatische Aktualisierung verhindert. Dies erfordert, dass der API Management-Dienst mit einem aka.ms/apimmsi

KeyVaultContractProperties

KeyVault-Vertragsdetails.

Name Type Description
identityClientId
  • string

SystemAssignedIdentity oder UserAssignedIdentity-Client-ID, die für den Zugriff auf das Schlüsseltresorgeheimnis verwendet wird.

lastStatus

Zeitpunkt der letzten Synchronisierung und Aktualisierung des Status des Geheimnisses aus dem Schlüsseltresor.

secretIdentifier
  • string

Schlüsseltresor-Geheimnisbezeichner zum Abrufen des Geheimnisses. Wenn Sie ein Geheimnis mit Versionsversion bereitstellen, wird die automatische Aktualisierung verhindert. Dies erfordert, dass der API Management-Dienst mit einem aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Geben Sie Die Updateeigenschaften des Vertrags aus.

Name Type Description
code
  • string

Letzter Statuscode für die Synchronisierung und Aktualisierung des Geheimnisses aus dem Schlüsseltresor.

message
  • string

Details des Fehlers sind sonst leer.

timeStampUtc
  • string

Letzter Zugriff auf das Geheimnis. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß iso 8601-Standard.

NamedValueContract

NamedValue-Details.

Name Type Description
id
  • string

Ressourcen-ID

name
  • string

Name der Ressource.

properties.displayName
  • string

Eindeutiger Name von NamedValue. Er kann nur Buchstaben, Ziffern, Punkte, Gedankenstriche und Unterstriche enthalten.

properties.keyVault

KeyVault-Speicherortdetails des namedValue.

properties.secret
  • boolean

Bestimmt, ob der Wert ein geheimer Schlüssel ist und ob er verschlüsselt werden sollte. Der Standardwert ist „false“.

properties.tags
  • string[]

Optionale Tags, die, sofern angegeben, zum Filtern der NamedValue-Liste verwendet werden können.

properties.value
  • string

Der Wert des NamedValue. Kann Richtlinienausdrücke enthalten. Er darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert zu erhalten.

type
  • string

Ressourcentyp für API Management Ressource.

NamedValueCreateContract

NamedValue-Details.

Name Type Description
id
  • string

Ressourcen-ID

name
  • string

Name der Ressource.

properties.displayName
  • string

Eindeutiger Name von NamedValue. Er kann nur Buchstaben, Ziffern, Punkte, Gedankenstriche und Unterstriche enthalten.

properties.keyVault

KeyVault-Speicherortdetails des namedValue.

properties.secret
  • boolean

Bestimmt, ob der Wert ein geheimer Schlüssel ist und ob er verschlüsselt werden sollte. Der Standardwert ist „false“.

properties.tags
  • string[]

Optionale Tags, die, sofern angegeben, zum Filtern der NamedValue-Liste verwendet werden können.

properties.value
  • string

Der Wert des NamedValue. Kann Richtlinienausdrücke enthalten. Er darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert zu erhalten.

type
  • string

Ressourcentyp für API Management Ressource.