Api Version Set - Update

Service:

API Management

Version d'API:

2021-08-01

Mises à jour les détails de l’Api VersionSet spécifié par son identificateur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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.
versionSetId	path	True	string	Identificateur de l’ensemble de versions de l’API. Doit être unique dans le instance de service Gestion des API actuel. Modèle d’expression régulière: ^[^*#&+:<>?]+$
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.description	string	Description de l’ensemble de versions d’API.
properties.displayName	string	Nom de l’ensemble de versions d’API
properties.versionHeaderName	string	Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header.
properties.versionQueryName	string	Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query.
properties.versioningScheme	versioningScheme	Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.

Réponses

Nom	Type	Description
200 OK	ApiVersionSetContract	L’ensemble de versions de l’API a été correctement mis à jour. En-têtes ETag: string
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

ApiManagementUpdateApiVersionSet

Exemple de requête

HTTP

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


{
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.ApiVersionSetContract;
import com.azure.resourcemanager.apimanagement.models.VersioningScheme;

/** Samples for ApiVersionSet Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiVersionSet.json
     */
    /**
     * Sample code: ApiManagementUpdateApiVersionSet.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateApiVersionSet(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        ApiVersionSetContract resource =
            manager.apiVersionSets().getWithResponse("rg1", "apimService1", "vs1", Context.NONE).getValue();
        resource
            .update()
            .withDisplayName("api set 1")
            .withVersioningScheme(VersioningScheme.SEGMENT)
            .withDescription("Version configuration")
            .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_api_version_set.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.api_version_set.update(
        resource_group_name="rg1",
        service_name="apimService1",
        version_set_id="vs1",
        if_match="*",
        parameters={
            "properties": {
                "description": "Version configuration",
                "displayName": "api set 1",
                "versioningScheme": "Segment",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiVersionSet.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/ApiManagementUpdateApiVersionSet.json
func ExampleAPIVersionSetClient_Update() {
	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)
	}
	res, err := clientFactory.NewAPIVersionSetClient().Update(ctx, "rg1", "apimService1", "vs1", "*", armapimanagement.APIVersionSetUpdateParameters{
		Properties: &armapimanagement.APIVersionSetUpdateParametersProperties{
			Description:      to.Ptr("Version configuration"),
			DisplayName:      to.Ptr("api set 1"),
			VersioningScheme: to.Ptr(armapimanagement.VersioningSchemeSegment),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.APIVersionSetContract = armapimanagement.APIVersionSetContract{
	// 	Name: to.Ptr("vs1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/api-version-sets"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1"),
	// 	Properties: &armapimanagement.APIVersionSetContractProperties{
	// 		Description: to.Ptr("Version configuration"),
	// 		DisplayName: to.Ptr("api set 1"),
	// 		VersioningScheme: to.Ptr(armapimanagement.VersioningSchemeSegment),
	// 	},
	// }
}

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 details of the Api VersionSet specified by its identifier.
 *
 * @summary Updates the details of the Api VersionSet specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiVersionSet.json
 */
async function apiManagementUpdateApiVersionSet() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const versionSetId = "vs1";
  const ifMatch = "*";
  const parameters = {
    description: "Version configuration",
    displayName: "api set 1",
    versioningScheme: "Segment",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiVersionSet.update(
    resourceGroupName,
    serviceName,
    versionSetId,
    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/ApiManagementUpdateApiVersionSet.json
// this example is just showing the usage of "ApiVersionSet_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 ApiVersionSetResource created on azure
// for more information of creating ApiVersionSetResource, please refer to the document of ApiVersionSetResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string versionSetId = "vs1";
ResourceIdentifier apiVersionSetResourceId = ApiVersionSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, versionSetId);
ApiVersionSetResource apiVersionSet = client.GetApiVersionSetResource(apiVersionSetResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiVersionSetPatch patch = new ApiVersionSetPatch()
{
    Description = "Version configuration",
    DisplayName = "api set 1",
    VersioningScheme = VersioningScheme.Segment,
};
ApiVersionSetResource result = await apiVersionSet.UpdateAsync(ifMatch, patch);

// 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
ApiVersionSetData 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:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "vs1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Définitions

Nom	Description
ApiVersionSetContract	Détails du contrat de l’ensemble de versions de l’API.
ApiVersionSetUpdateParameters	Paramètres pour mettre à jour ou créer un contrat d’ensemble de versions d’API.
ErrorFieldContract	Contrat de champ d’erreur.
ErrorResponse	Réponse d’erreur.
versioningScheme	Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.

ApiVersionSetContract

Détails du contrat de l’ensemble de versions de l’API.

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.description	string	Description de l’ensemble de versions d’API.
properties.displayName	string	Nom de l’ensemble de versions d’API
properties.versionHeaderName	string	Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header.
properties.versionQueryName	string	Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query.
properties.versioningScheme	versioningScheme	Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ApiVersionSetUpdateParameters

Paramètres pour mettre à jour ou créer un contrat d’ensemble de versions d’API.

Nom	Type	Description
properties.description	string	Description de l’ensemble de versions d’API.
properties.displayName	string	Nom de l’ensemble de versions d’API
properties.versionHeaderName	string	Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header.
properties.versionQueryName	string	Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query.
properties.versioningScheme	versioningScheme	Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.

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.

versioningScheme

Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.

Nom	Type	Description
Header	string	La version de l’API est passée dans un en-tête HTTP.
Query	string	La version de l’API est passée dans un paramètre de requête.
Segment	string	La version de l’API est passée dans un segment de chemin d’accès.