Named Value - Update

Service:

API Management

Version d'API:

2021-08-01

Mises à jour la valeur nommée spécifique.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
namedValueId	path	True	string	Identificateur de NamedValue. Modèle d’expression régulière: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	Nom du groupe de ressources.
serviceName	path	True	string	Nom du service Gestion des API. Modèle d’expression régulière: ^[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 l’abonnement Microsoft Azure. 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

Nom	Obligatoire	Type	Description
If-Match	True	string	ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

Corps de la demande

Nom	Type	Description
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	KeyVaultContractCreateProperties	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. La valeur par défaut est false.
properties.tags	string[]	Les 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.

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 de création ou de mise à jour d’une valeur nommée a été acceptée.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

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

ApiManagementUpdateNamedValue

Exemple de requête

HTTP

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


{
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar2"
    ],
    "secret": false
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.NamedValueContract;
import java.util.Arrays;

/** Samples for NamedValue Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateNamedValue.json
     */
    /**
     * Sample code: ApiManagementUpdateNamedValue.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateNamedValue(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        NamedValueContract resource =
            manager.namedValues().getWithResponse("rg1", "apimService1", "testprop2", Context.NONE).getValue();
        resource
            .update()
            .withTags(Arrays.asList("foo", "bar2"))
            .withDisplayName("prop3name")
            .withValue("propValue")
            .withSecret(false)
            .withIfMatch("*")
            .apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_named_value.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.named_value.begin_update(
        resource_group_name="rg1",
        service_name="apimService1",
        named_value_id="testprop2",
        if_match="*",
        parameters={
            "properties": {"displayName": "prop3name", "secret": False, "tags": ["foo", "bar2"], "value": "propValue"}
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateNamedValue.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateNamedValue.json
func ExampleNamedValueClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewNamedValueClient().BeginUpdate(ctx, "rg1", "apimService1", "testprop2", "*", armapimanagement.NamedValueUpdateParameters{
		Properties: &armapimanagement.NamedValueUpdateParameterProperties{
			Secret: to.Ptr(false),
			Tags: []*string{
				to.Ptr("foo"),
				to.Ptr("bar2")},
			DisplayName: to.Ptr("prop3name"),
			Value:       to.Ptr("propValue"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.NamedValueContract = armapimanagement.NamedValueContract{
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/namedValues"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2"),
	// 	Properties: &armapimanagement.NamedValueContractProperties{
	// 		Secret: to.Ptr(false),
	// 		Tags: []*string{
	// 			to.Ptr("foo"),
	// 			to.Ptr("bar2")},
	// 			DisplayName: to.Ptr("prop3name"),
	// 			Value: to.Ptr("propValue"),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates the specific named value.
 *
 * @summary Updates the specific named value.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateNamedValue.json
 */
async function apiManagementUpdateNamedValue() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const namedValueId = "testprop2";
  const ifMatch = "*";
  const parameters = {
    displayName: "prop3name",
    secret: false,
    tags: ["foo", "bar2"],
    value: "propValue",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.namedValue.beginUpdateAndWait(
    resourceGroupName,
    serviceName,
    namedValueId,
    ifMatch,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateNamedValue.json
// this example is just showing the usage of "NamedValue_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementNamedValueResource created on azure
// for more information of creating ApiManagementNamedValueResource, please refer to the document of ApiManagementNamedValueResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string namedValueId = "testprop2";
ResourceIdentifier apiManagementNamedValueResourceId = ApiManagementNamedValueResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, namedValueId);
ApiManagementNamedValueResource apiManagementNamedValue = client.GetApiManagementNamedValueResource(apiManagementNamedValueResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementNamedValuePatch patch = new ApiManagementNamedValuePatch()
{
    Tags =
    {
    "foo","bar2"
    },
    IsSecret = false,
    DisplayName = "prop3name",
    Value = "propValue",
};
ArmOperation<ApiManagementNamedValueResource> lro = await apiManagementNamedValue.UpdateAsync(WaitUntil.Completed, ifMatch, patch);
ApiManagementNamedValueResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementNamedValueData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2021-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=204

Code d’état:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar2"
    ],
    "secret": false
  }
}

Définitions

Nom	Description
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	Émettre les propriétés de mise à jour du contrat.
NamedValueContract	Détails de NamedValue.
NamedValueUpdateParameters	Paramètres de mise à jour NamedValue.

ErrorFieldContract

Contrat de champ d’erreur.

Nom	Type	Description
code	string	Code d'erreur de niveau propriété.
message	string	Représentation lisible par l’homme de l’erreur au niveau des propriétés.
target	string	Nom de 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 contrôlable de visu de l’erreur.

KeyVaultContractCreateProperties

Créez les détails du contrat KeyVault.

Nom	Type	Description
identityClientId	string	Null pour SystemAssignedIdentity ou ID client pour UserAssignedIdentity , qui sera utilisé pour accéder au secret du coffre de clés.
secretIdentifier	string	Identificateur du secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Pour cela, Gestion des API service doit être configuré avec aka.ms/apimmsi

KeyVaultContractProperties

Détails du contrat KeyVault.

Nom	Type	Description
identityClientId	string	Null pour SystemAssignedIdentity ou ID client pour UserAssignedIdentity , qui sera utilisé pour accéder au secret du coffre de clés.
lastStatus	KeyVaultLastAccessStatusContractProperties	Dernière synchronisation et actualisation status de secret à partir du coffre de clés.
secretIdentifier	string	Identificateur du secret du coffre de clés pour l’extraction du secret. La fourniture d’un secret avec version empêche l’actualisation automatique. Pour cela, Gestion des API service doit être configuré avec aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

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

Nom	Type	Description
code	string	Dernier status code pour la synchronisation et l’actualisation du secret à partir du coffre de clés.
message	string	Les détails de l’erreur sont sinon vides.
timeStampUtc	string	Dernière fois que le secret a été accédé. 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.

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	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. La valeur par défaut est false.
properties.tags	string[]	Les 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 « 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 »

NamedValueUpdateParameters

Paramètres de mise à jour NamedValue.

Nom	Type	Description
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	KeyVaultContractCreateProperties	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. La valeur par défaut est false.
properties.tags	string[]	Les 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.