Location - List Cached Images

Référence

Service:: Container Instances

Version d'API:: 2023-05-01

Obtenez la liste des images mises en cache sur un type de système d’exploitation spécifique pour un abonnement dans une région.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages?api-version=2023-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
location	path	True	string	Identificateur de l’emplacement azure physique.
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 de chaque appel de service.
api-version	query	True	string	Version de l’API cliente

Réponses

Nom	Type	Description
200 OK	CachedImagesListResult	D’ACCORD
Other Status Codes	CloudError	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	Usurper votre compte d'utilisateur

Exemples

CachedImages

Exemple de requête

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.ContainerInstance/locations/westcentralus/cachedImages?api-version=2023-05-01


/**
 * Samples for Location ListCachedImages.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/
     * CachedImagesList.json
     */
    /**
     * Sample code: CachedImages.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cachedImages(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.containerGroups().manager().serviceClient().getLocations().listCachedImages("westcentralus",
            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.containerinstance import ContainerInstanceManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerinstance
# USAGE
    python cached_images_list.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 = ContainerInstanceManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.location.list_cached_images(
        location="westcentralus",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/CachedImagesList.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 armcontainerinstance_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerinstance/armcontainerinstance/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e60df62e9e0d88462e6abba81a76d94eab000f0d/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/CachedImagesList.json
func ExampleLocationClient_NewListCachedImagesPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcontainerinstance.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewLocationClient().NewListCachedImagesPager("westcentralus", 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.CachedImagesListResult = armcontainerinstance.CachedImagesListResult{
		// 	Value: []*armcontainerinstance.CachedImages{
		// 		{
		// 			Image: to.Ptr("ubuntu:16.04"),
		// 			OSType: to.Ptr("Linux"),
		// 		},
		// 		{
		// 			Image: to.Ptr("alpine:3.6"),
		// 			OSType: to.Ptr("Linux"),
		// 		},
		// 		{
		// 			Image: to.Ptr("microsoft/nanoserver:10.0.14393.2485"),
		// 			OSType: to.Ptr("Windows"),
		// 	}},
		// }
	}
}

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

const { ContainerInstanceManagementClient } = require("@azure/arm-containerinstance");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the list of cached images on specific OS type for a subscription in a region.
 *
 * @summary Get the list of cached images on specific OS type for a subscription in a region.
 * x-ms-original-file: specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/CachedImagesList.json
 */
async function cachedImages() {
  const subscriptionId = process.env["CONTAINERINSTANCE_SUBSCRIPTION_ID"] || "subid";
  const location = "westcentralus";
  const credential = new DefaultAzureCredential();
  const client = new ContainerInstanceManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.location.listCachedImages(location)) {
    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 Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ContainerInstance.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ContainerInstance;

// Generated from example definition: specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2023-05-01/examples/CachedImagesList.json
// this example is just showing the usage of "Location_ListCachedImages" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
AzureLocation location = new AzureLocation("westcentralus");
await foreach (CachedImages item in subscriptionResource.GetCachedImagesWithLocationAsync(location))
{
    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": [
    {
      "osType": "Linux",
      "image": "ubuntu:16.04"
    },
    {
      "osType": "Linux",
      "image": "alpine:3.6"
    },
    {
      "osType": "Windows",
      "image": "microsoft/nanoserver:10.0.14393.2485"
    }
  ]
}

Définitions

Nom	Description
cachedImages	Image mise en cache et type de système d’exploitation.
CachedImagesListResult	Réponse contenant des images mises en cache.
CloudError	Réponse d’erreur du service Container Instance.
CloudErrorBody	Réponse d’erreur du service Container Instance.

cachedImages

Object

Image mise en cache et type de système d’exploitation.

Nom	Type	Description
image	string	Nom de l’image mise en cache.
osType	string	Type de système d’exploitation de l’image mise en cache.

CachedImagesListResult

Object

Réponse contenant des images mises en cache.

Nom	Type	Description
nextLink	string	URI permettant d’extraire la page suivante d’images mises en cache.
value	cachedImages[]	Liste des images mises en cache.

CloudError

Object

Réponse d’erreur du service Container Instance.

Nom	Type	Description
error	CloudErrorBody	Réponse d’erreur du service Container Instance.

CloudErrorBody

Object

Réponse d’erreur du service Container Instance.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.