Partager via


Named Value - Refresh Secret

Actualisez le secret de la valeur nommée spécifiée par son identificateur.

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

Paramètres URI

Nom Dans Obligatoire Type Description
namedValueId
path True

string

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

Identificateur de NamedValue.

resourceGroupName
path True

string

Nom du groupe de ressources.

serviceName
path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nom du service Gestion des API.

subscriptionId
path True

string

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

api-version
query True

string

Version de l’API à utiliser avec la demande cliente.

Réponses

Nom Type Description
200 OK

NamedValueContract

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

En-têtes

ETag: string

202 Accepted

La demande d’actualisation du secret a été acceptée.

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementRefreshNamedValue

Exemple de requête

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

Exemple de réponse

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6/refreshSecret?api-version=2021-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://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
      "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

Définitions

Nom Description
ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

KeyVaultContractProperties

Détails du contrat KeyVault.

KeyVaultLastAccessStatusContractProperties

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

NamedValueContract

Détails de La valeur nommée.

ErrorFieldContract

Contrat de champ d’erreur.

Nom Type Description
code

string

Code d’erreur au niveau de la propriété.

message

string

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

target

string

Nom de la propriété.

ErrorResponse

Réponse d’erreur.

Nom 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

ErrorFieldContract[]

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.

error.message

string

Représentation lisible par l’homme de l’erreur.

KeyVaultContractProperties

Détails du contrat KeyVault.

Nom Type Description
identityClientId

string

Null pour SystemAssignedIdentity ou l’ID client pour UserAssignedIdentity, qui sera utilisé pour accéder au secret du coffre de clés.

lastStatus

KeyVaultLastAccessStatusContractProperties

Dernière synchronisation et état d’actualisation du secret à partir du coffre de clés.

secretIdentifier

string

Identificateur de secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Cela nécessite que le service Gestion des API soit configuré avec aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

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

Nom 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 (date-time)

Dernière fois que le secret a été accédé. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.

NamedValueContract

Détails de La valeur nommée.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nom de la ressource

properties.displayName

string

minLength: 1
maxLength: 256
pattern: ^[A-Za-z0-9-._]+$

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

properties.keyVault

KeyVaultContractProperties

Détails de l’emplacement KeyVault de la valeur nommée.

properties.secret

boolean

Détermine si la valeur est un secret et doit être chiffrée ou non. 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

maxLength: 4096

Valeur de la valeur NamedValue. Peut contenir des expressions de stratégie. Il ne peut pas être vide ou se composer uniquement d’espaces blancs. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »