Api Version Set - Update

Служба:

API Management

Версия API:

2021-08-01

Обновляет сведения о наборе версий API, заданном его идентификатором.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
versionSetId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Идентификатор набора версий API. Должен быть уникальным в текущем экземпляре службы управления API.
api-version	query	True	string	Версия API для использования с клиентским запросом.

Заголовок запроса

Имя	Обязательно	Тип	Описание
If-Match	True	string	ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или оно должно быть * для безусловного обновления.

Текст запроса

Имя	Тип	Описание
properties.description	string	Описание набора версий API.
properties.displayName	string minLength: 1 maxLength: 100	Имя набора версий API
properties.versionHeaderName	string minLength: 1 maxLength: 100	Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query.
properties.versioningScheme	versioningScheme	Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

Ответы

Имя	Тип	Описание
200 OK	ApiVersionSetContract	Набор версий API успешно обновлен. Заголовки ETag: string
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementUpdateApiVersionSet

Образец запроса

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
ApiVersionSetContract	Сведения о контракте набора версий API.
ApiVersionSetUpdateParameters	Параметры для обновления или создания контракта набора версий API.
ErrorFieldContract	Контракт поля ошибки.
ErrorResponse	Ответ на ошибку.
versioningScheme	Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

ApiVersionSetContract

Object

Сведения о контракте набора версий API.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.description	string	Описание набора версий API.
properties.displayName	string minLength: 1 maxLength: 100	Имя набора версий API
properties.versionHeaderName	string minLength: 1 maxLength: 100	Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query.
properties.versioningScheme	versioningScheme	Значение, определяющее расположение идентификатора версии API в HTTP-запросе.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ApiVersionSetUpdateParameters

Object

Параметры для обновления или создания контракта набора версий API.

Имя	Тип	Описание
properties.description	string	Описание набора версий API.
properties.displayName	string minLength: 1 maxLength: 100	Имя набора версий API
properties.versionHeaderName	string minLength: 1 maxLength: 100	Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query.
properties.versioningScheme	versioningScheme	Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

ErrorFieldContract

Object

Контракт поля ошибки.

Имя	Тип	Описание
code	string	Код ошибки уровня свойств.
message	string	Удобочитаемое пользователем представление ошибки уровня свойств.
target	string	Имя свойства.

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
error.code	string	Код ошибки, определенный службой. Этот код служит вложенным состоянием для кода ошибки HTTP, указанного в ответе.
error.details	ErrorFieldContract[]	Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.
error.message	string	Читаемое человеком представление ошибки.

versioningScheme

Перечисление

Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

Значение	Описание
Header	Версия API передается в заголовке HTTP.
Query	Версия API передается в параметре запроса.
Segment	Версия API передается в сегмент пути.