Api Management Service Skus - List Available Service Skus

Référence

Service:: API Management

Version d'API:: 2024-05-01

Obtient les références SKU disponibles pour le service Gestion des API
Obtient toutes les références SKU disponibles pour un service Gestion des API donné

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ResourceSkuResults	Succès. La réponse décrit la liste des références SKU.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

ApiManagementListSKUs-Consumption

ApiManagementListSKUs-Dedicated

ApiManagementListSKUs-Consumption

Exemple de requête

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/skus?api-version=2024-05-01


/**
 * Samples for ApiManagementServiceSkus ListAvailableServiceSkus.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListSKUs-Consumption.json
     */
    /**
     * Sample code: ApiManagementListSKUs-Consumption.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListSKUsConsumption(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiManagementServiceSkus().listAvailableServiceSkus("rg1", "apimService1",
            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

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_sk_us_consumption.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.api_management_service_skus.list_available_service_skus(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListSKUs-Consumption.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

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListSKUs-Consumption.json
func ExampleServiceSKUsClient_NewListAvailableServiceSKUsPager_apiManagementListSkUsConsumption() {
	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.NewServiceSKUsClient().NewListAvailableServiceSKUsPager("rg1", "apimService1", 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.ResourceSKUResults = armapimanagement.ResourceSKUResults{
		// 	Value: []*armapimanagement.ResourceSKUResult{
		// 		{
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypeConsumption),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Gets all available SKU for a given API Management service
 *
 * @summary Gets all available SKU for a given API Management service
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListSKUs-Consumption.json
 */
async function apiManagementListSkUsConsumption() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  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 (const item of client.apiManagementServiceSkus.listAvailableServiceSkus(
    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

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

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListSKUs-Consumption.json
// this example is just showing the usage of "ApiManagementServiceSkus_ListAvailableServiceSkus" 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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation and iterate over the result
await foreach (AvailableApiManagementServiceSkuResult item in apiManagementService.GetAvailableApiManagementServiceSkusAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Consumption"
      },
      "capacity": null
    }
  ],
  "nextLink": null
}

ApiManagementListSKUs-Dedicated

Exemple de requête

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/skus?api-version=2024-05-01


/**
 * Samples for ApiManagementServiceSkus ListAvailableServiceSkus.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListSKUs-Dedicated.json
     */
    /**
     * Sample code: ApiManagementListSKUs-Dedicated.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListSKUsDedicated(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiManagementServiceSkus().listAvailableServiceSkus("rg1", "apimService1",
            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

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_sk_us_dedicated.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.api_management_service_skus.list_available_service_skus(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListSKUs-Dedicated.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

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListSKUs-Dedicated.json
func ExampleServiceSKUsClient_NewListAvailableServiceSKUsPager_apiManagementListSkUsDedicated() {
	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.NewServiceSKUsClient().NewListAvailableServiceSKUsPager("rg1", "apimService1", 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.ResourceSKUResults = armapimanagement.ResourceSKUResults{
		// 	Value: []*armapimanagement.ResourceSKUResult{
		// 		{
		// 			Capacity: &armapimanagement.ResourceSKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](1),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.ResourceSKUCapacityScaleTypeNone),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypeDeveloper),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armapimanagement.ResourceSKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](2),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.ResourceSKUCapacityScaleTypeManual),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypeBasic),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armapimanagement.ResourceSKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](4),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.ResourceSKUCapacityScaleTypeAutomatic),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypeStandard),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armapimanagement.ResourceSKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](10),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.ResourceSKUCapacityScaleTypeAutomatic),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypePremium),
		// 			},
		// 		},
		// 		{
		// 			Capacity: &armapimanagement.ResourceSKUCapacity{
		// 				Default: to.Ptr[int32](1),
		// 				Maximum: to.Ptr[int32](1),
		// 				Minimum: to.Ptr[int32](1),
		// 				ScaleType: to.Ptr(armapimanagement.ResourceSKUCapacityScaleTypeAutomatic),
		// 			},
		// 			ResourceType: to.Ptr("Microsoft.ApiManagement/service"),
		// 			SKU: &armapimanagement.ResourceSKU{
		// 				Name: to.Ptr(armapimanagement.SKUTypeIsolated),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Gets all available SKU for a given API Management service
 *
 * @summary Gets all available SKU for a given API Management service
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListSKUs-Dedicated.json
 */
async function apiManagementListSkUsDedicated() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  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 (const item of client.apiManagementServiceSkus.listAvailableServiceSkus(
    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

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

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListSKUs-Dedicated.json
// this example is just showing the usage of "ApiManagementServiceSkus_ListAvailableServiceSkus" 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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation and iterate over the result
await foreach (AvailableApiManagementServiceSkuResult item in apiManagementService.GetAvailableApiManagementServiceSkusAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Developer"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 1,
        "default": 1,
        "scaleType": "none"
      }
    },
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Basic"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 2,
        "default": 1,
        "scaleType": "manual"
      }
    },
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Standard"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 4,
        "default": 1,
        "scaleType": "automatic"
      }
    },
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Premium"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 10,
        "default": 1,
        "scaleType": "automatic"
      }
    },
    {
      "resourceType": "Microsoft.ApiManagement/service",
      "sku": {
        "name": "Isolated"
      },
      "capacity": {
        "minimum": 1,
        "maximum": 1,
        "default": 1,
        "scaleType": "automatic"
      }
    }
  ],
  "nextLink": null
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ResourceSku	Décrit une référence SKU Gestion des API disponible.
ResourceSkuCapacity	Décrit les informations de mise à l’échelle d’une référence SKU.
ResourceSkuCapacityScaleType	Type d’échelle applicable à la référence SKU.
ResourceSkuResult	Décrit une référence SKU du service Gestion des API disponible.
ResourceSkuResults	Réponse de l’opération de service Gestion des API.
SkuType	Nom de la référence SKU.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ResourceSku

Object

Décrit une référence SKU Gestion des API disponible.

Nom	Type	Description
name	SkuType	Nom de la référence SKU.

ResourceSkuCapacity

Object

Décrit les informations de mise à l’échelle d’une référence SKU.

Nom	Type	Description
default	integer (int32)	Capacité par défaut.
maximum	integer (int32)	Capacité maximale pouvant être définie.
minimum	integer (int32)	Capacité minimale.
scaleType	ResourceSkuCapacityScaleType	Type d’échelle applicable à la référence SKU.

ResourceSkuCapacityScaleType

Énumération

Type d’échelle applicable à la référence SKU.

Valeur	Description
automatic	Type d’échelle pris en charge automatique.
manual	Manuel du type d’échelle pris en charge.
none	Mise à l’échelle non prise en charge.

ResourceSkuResult

Object

Décrit une référence SKU du service Gestion des API disponible.

Nom	Type	Description
capacity	ResourceSkuCapacity	Spécifie le nombre d’unités gestion des API.
resourceType	string	Type de ressource auquel la référence SKU s’applique.
sku	ResourceSku	Spécifie la référence SKU Gestion des API.

ResourceSkuResults

Object

Réponse de l’opération de service Gestion des API.

Nom	Type	Description
nextLink	string	URI permettant d’extraire la page suivante des références SKU du service Gestion des API.
value	ResourceSkuResult[]	Liste des références SKU disponibles pour le service.

SkuType

Énumération

Nom de la référence SKU.

Valeur	Description
Basic	Référence SKU de base de Gestion des API.
BasicV2	Référence SKU BasicV2 de Gestion des API.
Consumption	Référence SKU consommation de Gestion des API.
Developer	Référence SKU du développeur de gestion des API.
Isolated	Référence SKU isolée de Gestion des API.
Premium	Référence SKU Premium de Gestion des API.
Standard	Référence SKU standard de gestion des API.
StandardV2	Référence SKU StandardV2 de Gestion des API.

Partager via

Api Management Service Skus - List Available Service Skus

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

ApiManagementListSKUs-Consumption

Exemple de requête

Exemple de réponse

ApiManagementListSKUs-Dedicated

Exemple de requête

Exemple de réponse

Définitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ResourceSku

ResourceSkuCapacity

ResourceSkuCapacityScaleType

ResourceSkuResult

ResourceSkuResults

SkuType