Api Version Set - List By Service

Service:

API Management

API Version:

2022-08-01

Wyświetla listę kolekcji zestawów wersji interfejsu API w określonym wystąpieniu usługi.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
serviceName	path	True	string	Nazwa usługi API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje | |-------------|-------------|-------------|-------------|
$skip	query		integer int32	Liczba rekordów do pominięcia.
$top	query		integer int32	Liczba rekordów do zwrócenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApiVersionSetCollection	Wyświetla listę kolekcji jednostek zestawu wersji interfejsu API.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementListApiVersionSets

Sample Request

HTTP

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

Java

/** Samples for ApiVersionSet ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApiVersionSets.json
     */
    /**
     * Sample code: ApiManagementListApiVersionSets.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListApiVersionSets(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiVersionSets()
            .listByService("rg1", "apimService1", null, null, null, com.azure.core.util.Context.NONE);
    }
}

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_list_api_version_sets.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.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApiVersionSets.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/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/ApiManagementListApiVersionSets.json
func ExampleAPIVersionSetClient_NewListByServicePager() {
	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)
	}
	pager := clientFactory.NewAPIVersionSetClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.APIVersionSetClientListByServiceOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.APIVersionSetCollection = armapimanagement.APIVersionSetCollection{
		// 	Count: to.Ptr[int64](2),
		// 	Value: []*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),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("vs2"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/api-version-sets"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs2"),
		// 			Properties: &armapimanagement.APIVersionSetContractProperties{
		// 				Description: to.Ptr("Version configuration 2"),
		// 				DisplayName: to.Ptr("api set 2"),
		// 				VersioningScheme: to.Ptr(armapimanagement.VersioningSchemeQuery),
		// 			},
		// 	}},
		// }
	}
}

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 Lists a collection of API Version Sets in the specified service instance.
 *
 * @summary Lists a collection of API Version Sets in the specified service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApiVersionSets.json
 */
async function apiManagementListApiVersionSets() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.apiVersionSet.listByService(resourceGroupName, serviceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "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"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs2",
      "type": "Microsoft.ApiManagement/service/api-version-sets",
      "name": "vs2",
      "properties": {
        "displayName": "api set 2",
        "versioningScheme": "Query",
        "description": "Version configuration 2"
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

Definicje

Nazwa	Opis
ApiVersionSetCollection	Reprezentacja listy zestawów wersji interfejsu API stronicowanego.
ApiVersionSetContract	Szczegóły kontraktu zestawu wersji interfejsu API.
ErrorFieldContract	Błąd Kontrakt pola.
ErrorResponse	Odpowiedź na błąd.
versioningScheme	Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.

ApiVersionSetCollection

Reprezentacja listy zestawów wersji interfejsu API stronicowanego.

Nazwa	Typ	Opis
count	integer	Łączna liczba rekordów na wszystkich stronach.
nextLink	string	Jeśli istnieje, łącze następnej strony.
value	ApiVersionSetContract[]	Wartości stron.

ApiVersionSetContract

Szczegóły kontraktu zestawu wersji interfejsu API.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.description	string	Opis zestawu wersji interfejsu API.
properties.displayName	string	Nazwa zestawu wersji interfejsu API
properties.versionHeaderName	string	Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme ma wartość header.
properties.versionQueryName	string	Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli opcja VersioningScheme jest ustawiona na querywartość .
properties.versioningScheme	versioningScheme	Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa	Typ	Opis
code	string	Kod błędu poziomu właściwości.
message	string	Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.
target	string	Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error.code	string	Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
error.details	ErrorFieldContract[]	Lista nieprawidłowych pól wysyłanych w żądaniu w przypadku błędu walidacji.
error.message	string	Czytelna dla człowieka reprezentacja błędu.

versioningScheme

Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.

Nazwa	Typ	Opis
Header	string	Wersja interfejsu API jest przekazywana w nagłówku HTTP.
Query	string	Wersja interfejsu API jest przekazywana w parametrze zapytania.
Segment	string	Wersja interfejsu API jest przekazywana w segmencie ścieżki.