Soft Deleted Resource - List By Artifact Name

Servizio:

Compute

Versione API:

2024-03-03

Elencare le risorse eliminate soft di un artefatto nella raccolta, ad esempio la versione dell'immagine della raccolta eliminata temporanea di un'immagine.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/softdeletedartifacttypes/{artifactType}/artifacts/{artifactName}/versions?api-version=2024-03-03

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
artifactName	path	True	string pattern: ^[a-zA-Z0-9]+([_]?[a-zA-Z0-9]+)*$	Nome dell'artefatto da elencare. Se il tipo di artefatto è Images, il nome dell'artefatto deve essere il nome dell'immagine della raccolta.
artifactType	path	True	string pattern: ^[a-zA-Z0-9]+([_]?[a-zA-Z0-9]+)*$	Tipo dell'artefatto da elencare, ad esempio la versione dell'immagine della raccolta.
galleryName	path	True	string	Nome della raccolta immagini condivise.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	GallerySoftDeletedResourceList	Operazione di Azure completata correttamente.
Other Status Codes	CloudError	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List soft-deleted resources of an artifact in the gallery.

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/softdeletedartifacttypes/images/artifacts/myGalleryImageName/versions?api-version=2024-03-03

Java

/**
 * Samples for SoftDeletedResource ListByArtifactName.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/
     * GallerySoftDeletedResource_ListByArtifactName.json
     */
    /**
     * Sample code: List soft-deleted resources of an artifact in the gallery.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listSoftDeletedResourcesOfAnArtifactInTheGallery(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getSoftDeletedResources().listByArtifactName(
            "myResourceGroup", "myGalleryName", "images", "myGalleryImageName", 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

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/250861bb6a886b75255edfa0aa5ee2dd0d6e7a11/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/GallerySoftDeletedResource_ListByArtifactName.json
func ExampleSoftDeletedResourceClient_NewListByArtifactNamePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSoftDeletedResourceClient().NewListByArtifactNamePager("myResourceGroup", "myGalleryName", "images", "myGalleryImageName", 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.GallerySoftDeletedResourceList = armcompute.GallerySoftDeletedResourceList{
		// 	Value: []*armcompute.GallerySoftDeletedResource{
		// 		{
		// 			Name: to.Ptr("1.0.0"),
		// 			Type: to.Ptr("Microsoft.Compute/galleries/softDeletedArtifactTypes/artifacts/versions"),
		// 			ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/softDeletedArtifactTypes/Images/artifacts/myGalleryImageName/versions/1.0.0"),
		// 			Location: to.Ptr("West US"),
		// 			Properties: &armcompute.GallerySoftDeletedResourceProperties{
		// 				ResourceArmID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName/versions/1.0.0"),
		// 				SoftDeletedArtifactType: to.Ptr(armcompute.SoftDeletedArtifactTypesImages),
		// 				SoftDeletedTime: to.Ptr("2024-10-17T13:01:05+00:00"),
		// 			},
		// 	}},
		// }
	}
}

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 { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to List soft-deleted resources of an artifact in the gallery, such as soft-deleted gallery image version of an image.
 *
 * @summary List soft-deleted resources of an artifact in the gallery, such as soft-deleted gallery image version of an image.
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/GallerySoftDeletedResource_ListByArtifactName.json
 */
async function listSoftDeletedResourcesOfAnArtifactInTheGallery() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const galleryName = "myGalleryName";
  const artifactType = "images";
  const artifactName = "myGalleryImageName";
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.softDeletedResource.listByArtifactName(
    resourceGroupName,
    galleryName,
    artifactType,
    artifactName,
  )) {
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/examples/galleryExamples/GallerySoftDeletedResource_ListByArtifactName.json
// this example is just showing the usage of "SoftDeletedResource_ListByArtifactName" 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 GalleryResource created on azure
// for more information of creating GalleryResource, please refer to the document of GalleryResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "myResourceGroup";
string galleryName = "myGalleryName";
ResourceIdentifier galleryResourceId = GalleryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, galleryName);
GalleryResource gallery = client.GetGalleryResource(galleryResourceId);

// invoke the operation and iterate over the result
string artifactType = "images";
string artifactName = "myGalleryImageName";
await foreach (GallerySoftDeletedResourceDetails item in gallery.GetSoftDeletedResourcesByArtifactNameAsync(artifactType, artifactName))
{
    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

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "name": "1.0.0",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/softDeletedArtifactTypes/Images/artifacts/myGalleryImageName/versions/1.0.0",
      "type": "Microsoft.Compute/galleries/softDeletedArtifactTypes/artifacts/versions",
      "location": "West US",
      "properties": {
        "resourceArmId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName/versions/1.0.0",
        "softDeletedTime": "2024-10-17T13:01:05+00:00",
        "softDeletedArtifactType": "Images"
      }
    }
  ],
  "nextLink": "http://svchost:99/subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/softDeletedArtifactTypes/images/artifacts/myGalleryImageName/versions?$skiptoken=token/Subscriptions/subscriptionId/ResourceGroups/myResourceGroup/galleries/myGalleryName/softDeletedArtifactTypes/images/artifacts/myGalleryImageName/versions/myGalleryImageVersionName"
}

Definizioni

Nome	Descrizione
ApiError	Errore dell'API.
ApiErrorBase	Base degli errori api.
CloudError	Risposta di errore dal servizio di calcolo.
createdByType	Tipo di identità che ha creato la risorsa.
GallerySoftDeletedResource	Informazioni dettagliate sulla risorsa eliminata temporanea.
GallerySoftDeletedResourceList	Risposta dell'operazione Elenco risorse eliminate soft-delete.
InnerError	Dettagli dell'errore interno.
SoftDeletedArtifactTypes	tipo di artefatto della risorsa eliminata temporanea
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

ApiError

Object

Errore dell'API.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	ApiErrorBase[]	Dettagli dell'errore dell'API
innererror	InnerError	Errore interno dell'API
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

ApiErrorBase

Object

Base degli errori api.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore specifico.

CloudError

Object

Risposta di errore dal servizio di calcolo.

Nome	Tipo	Descrizione
error	ApiError	Errore dell'API.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

GallerySoftDeletedResource

Object

Informazioni dettagliate sulla risorsa eliminata temporanea.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.resourceArmId	string (arm-id)	ARM ID della risorsa eliminata temporanea
properties.softDeletedArtifactType	SoftDeletedArtifactTypes	tipo di artefatto della risorsa eliminata temporanea
properties.softDeletedTime	string	Timestamp per il momento in cui la risorsa viene eliminata temporaneamente. In formato offset dateTime.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

GallerySoftDeletedResourceList

Object

Risposta dell'operazione Elenco risorse eliminate soft-delete.

Nome	Tipo	Descrizione
nextLink	string (uri)	Collegamento alla pagina successiva di elementi
value	GallerySoftDeletedResource[]	Gli elementi GallerySoftDeletedResource in questa pagina

InnerError

Object

Dettagli dell'errore interno.

Nome	Tipo	Descrizione
errordetail	string	Messaggio di errore interno o dump delle eccezioni.
exceptiontype	string	Tipo di eccezione.

SoftDeletedArtifactTypes

Enumerazione

tipo di artefatto della risorsa eliminata temporanea

Valore	Descrizione
Images

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.