Named Value - Create Or Update

Crée ou met à jour la valeur nommée.

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

Paramètres URI

Name In Required Type Description
namedValueId
path True
  • string

Identificateur du NamedValue.

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

resourceGroupName
path True
  • string

Nom du groupe de ressources.

serviceName
path True
  • string

Nom du service gestion des API.

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

subscriptionId
path True
  • string

informations d’identification d’abonnement qui identifient de manière unique Microsoft Azure abonnement. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True
  • string

Version de l’API à utiliser avec la demande du client.

En-tête de la demande

Name Required Type Description
If-Match
  • string

ETag de l’entité. Non requis lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité.

Corps de la demande

Name Required Type Description
properties.displayName True
  • string

Nom unique de NamedValue. Il peut contenir uniquement des lettres, des chiffres, des points, des tirets et des caractères de soulignement.

properties.keyVault

Détails de l’emplacement du coffre de namedValue.

properties.secret
  • boolean

Détermine si la valeur est un secret et doit être chiffrée. La valeur par défaut est false.

properties.tags
  • string[]

Balises facultatives qui, lorsqu’elles sont fournies, peuvent être utilisées pour filtrer la liste NamedValue.

properties.value
  • string

Valeur de NamedValue. Peut contenir des expressions de stratégie. Elle ne peut pas être vide ni se composer uniquement d’espaces blancs. Cette propriété ne sera pas remplie sur les opérations « d’extraction » ! Utilisez la demande de publication « /listSecrets » pour obtenir la valeur.

Réponses

Name Type Description
200 OK

La valeur nommée a été correctement mise à jour.

Headers

  • ETag: string
201 Created

La valeur nommée a été correctement créée.

Headers

  • ETag: string
202 Accepted

La demande de création ou de mise à jour de la valeur nommée a été acceptée.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

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 emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

KeyVaultContractCreateProperties

Créez les détails du contrat keyvault.

KeyVaultContractProperties

Détails du contrat keyvault.

KeyVaultLastAccessStatusContractProperties

Émettez les propriétés de mise à jour du contrat.

NamedValueContract

Détails de NamedValue.

NamedValueCreateContract

Détails de NamedValue.

ErrorFieldContract

Contrat de champ d’erreur.

Name Type Description
code
  • string

Code d'erreur de niveau propriété.

message
  • string

Représentation lisible de l’erreur au niveau de la propriété.

target
  • string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Name Type Description
error.code
  • string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

La liste des champs non valides est envoyée dans la demande, en cas d’erreur de validation.

error.message
  • string

Représentation contrôlable de visu de l’erreur.

KeyVaultContractCreateProperties

Créez les détails du contrat keyvault.

Name Type Description
identityClientId
  • string

ID client SystemAssignedIdentity ou UserAssignedIdentity qui sera utilisé pour accéder à la clé secrète du coffre de clés.

secretIdentifier
  • string

Identificateur de secret du coffre de clés pour l’extraction du secret. Le fait de fournir un secret avec version empêchera l’actualisation automatique. Cela nécessite la configuration du service gestion des API avec aka.ms/apimmsi

KeyVaultContractProperties

Détails du contrat keyvault.

Name Type Description
identityClientId
  • string

ID client SystemAssignedIdentity ou UserAssignedIdentity qui sera utilisé pour accéder à la clé secrète du coffre de clés.

lastStatus

Heure de la dernière synchronisation et actualisation de l’état du secret à partir du coffre de clés.

secretIdentifier
  • string

Identificateur de secret du coffre de clés pour l’extraction du secret. Le fait de fournir un secret avec version empêchera l’actualisation automatique. Cela nécessite la configuration du service gestion des API avec aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Émettez les propriétés de mise à jour du contrat.

Name Type Description
code
  • string

Dernier code d’État pour la synchronisation et l’actualisation du secret à partir du coffre de clés.

message
  • string

Détails de l’erreur sinon vide.

timeStampUtc
  • string

Heure de la dernière tentative d’accès au secret. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.

NamedValueContract

Détails de NamedValue.

Name Type Description
id
  • string

ID de la ressource

name
  • string

Nom de la ressource.

properties.displayName
  • string

Nom unique de NamedValue. Il peut contenir uniquement des lettres, des chiffres, des points, des tirets et des caractères de soulignement.

properties.keyVault

Détails de l’emplacement du coffre de namedValue.

properties.secret
  • boolean

Détermine si la valeur est un secret et doit être chiffrée. La valeur par défaut est false.

properties.tags
  • string[]

Balises facultatives qui, lorsqu’elles sont fournies, peuvent être utilisées pour filtrer la liste NamedValue.

properties.value
  • string

Valeur de NamedValue. Peut contenir des expressions de stratégie. Elle ne peut pas être vide ni se composer uniquement d’espaces blancs. Cette propriété ne sera pas remplie sur les opérations « d’extraction » ! Utilisez la demande de publication « /listSecrets » pour obtenir la valeur.

type
  • string

Type de ressource pour la ressource gestion des API.

NamedValueCreateContract

Détails de NamedValue.

Name Type Description
id
  • string

ID de la ressource

name
  • string

Nom de la ressource.

properties.displayName
  • string

Nom unique de NamedValue. Il peut contenir uniquement des lettres, des chiffres, des points, des tirets et des caractères de soulignement.

properties.keyVault

Détails de l’emplacement du coffre de namedValue.

properties.secret
  • boolean

Détermine si la valeur est un secret et doit être chiffrée. La valeur par défaut est false.

properties.tags
  • string[]

Balises facultatives qui, lorsqu’elles sont fournies, peuvent être utilisées pour filtrer la liste NamedValue.

properties.value
  • string

Valeur de NamedValue. Peut contenir des expressions de stratégie. Elle ne peut pas être vide ni se composer uniquement d’espaces blancs. Cette propriété ne sera pas remplie sur les opérations « d’extraction » ! Utilisez la demande de publication « /listSecrets » pour obtenir la valeur.

type
  • string

Type de ressource pour la ressource gestion des API.