Api Version Set - Update

Service:

API Management

API Version:

2022-08-01

Novedades los detalles del objeto Api VersionSet especificado por su identificador.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName	path	True	string	Nombre del servicio API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Identificador de la suscripción de destino.
versionSetId	path	True	string	Identificador del conjunto de versiones de api. Debe ser único en la instancia de servicio de API Management actual. Regex pattern: ^[^*#&+:<>?]+$
api-version	query	True	string	Versión de API que se usará para la operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match	True	string	ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta de encabezado de la solicitud GET o debe ser * para la actualización incondicional.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.description	string	Descripción del conjunto de versiones de API.
properties.displayName	string	Nombre del conjunto de versiones de API
properties.versionHeaderName	string	Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido headeren .
properties.versionQueryName	string	Nombre del parámetro de consulta que indica la versión de la API si versioningScheme está establecido queryen .
properties.versioningScheme	versioningScheme	Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP.

Respuestas

Nombre	Tipo	Description
200 OK	ApiVersionSetContract	El conjunto de versiones de api se actualizó correctamente. Headers ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ApiManagementUpdateApiVersionSet

Sample Request

HTTP

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


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

Java

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/2022-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", com.azure.core.util.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 typing import Any, IO, Union

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/2022-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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-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/2022-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

Sample Response

Status code:

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

Definiciones

Nombre	Description
ApiVersionSetContract	Detalles del contrato del conjunto de versiones de la API.
ApiVersionSetUpdateParameters	Parámetros para actualizar o crear un contrato de conjunto de versiones de API.
ErrorFieldContract	Contrato de campo de error.
ErrorResponse	Respuesta de error.
versioningScheme	Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP.

ApiVersionSetContract

Detalles del contrato del conjunto de versiones de la API.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.description	string	Descripción del conjunto de versiones de API.
properties.displayName	string	Nombre del conjunto de versiones de API
properties.versionHeaderName	string	Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido headeren .
properties.versionQueryName	string	Nombre del parámetro de consulta que indica la versión de la API si versioningScheme está establecido queryen .
properties.versioningScheme	versioningScheme	Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ApiVersionSetUpdateParameters

Parámetros para actualizar o crear un contrato de conjunto de versiones de API.

Nombre	Tipo	Description
properties.description	string	Descripción del conjunto de versiones de API.
properties.displayName	string	Nombre del conjunto de versiones de API
properties.versionHeaderName	string	Nombre del parámetro de encabezado HTTP que indica la versión de la API si versioningScheme está establecido headeren .
properties.versionQueryName	string	Nombre del parámetro de consulta que indica la versión de la API si versioningScheme está establecido queryen .
properties.versioningScheme	versioningScheme	Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP.

ErrorFieldContract

Contrato de campo de error.

Nombre	Tipo	Description
code	string	Código de error de nivel de propiedad.
message	string	Representación legible del error de nivel de propiedad.
target	string	Nombre de propiedad.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error.code	string	Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.
error.details	ErrorFieldContract[]	La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.
error.message	string	Representación legible del error.

versioningScheme

Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP.

Nombre	Tipo	Description
Header	string	La versión de la API se pasa en un encabezado HTTP.
Query	string	La versión de la API se pasa en un parámetro de consulta.
Segment	string	La versión de la API se pasa en un segmento de ruta de acceso.