Snapshots - List All

Serviço:: Azure Stack HCI

Versão da API:: 2026-04-01-preview

Lista todos os snapshots na subscrição especificada. Use a propriedade nextLink na resposta para obter a página seguinte de instantâneos.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/snapshots?api-version=2026-04-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	SnapshotListResult	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

List all snapshots in a subscription

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/providers/Microsoft.AzureStackHCI/snapshots?api-version=2026-04-01-preview

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "name": "test-snapshot-1",
      "type": "Microsoft.AzureStackHCI/snapshots",
      "extendedLocation": {
        "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        "type": "CustomLocation"
      },
      "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/snapshots/test-snapshot-1",
      "location": "West US2",
      "tags": {
        "environment": "test"
      },
      "properties": {
        "creationData": {
          "createOption": "Copy",
          "sourceResourceId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/virtualHardDisks/source-vhd",
          "sourceUniqueId": "b99c94ca-e43d-4282-9c78-84d58e5ce81a"
        },
        "provisioningState": "Succeeded",
        "timeCreated": "2023-11-15T10:30:00Z",
        "diskSizeBytes": 68719476736,
        "uniqueId": "f9e8d7c6-b5a4-9382-7160-5948372615a3",
        "status": {
          "provisioningStatus": {
            "status": "Succeeded"
          }
        }
      }
    },
    {
      "name": "test-snapshot-2",
      "type": "Microsoft.AzureStackHCI/snapshots",
      "extendedLocation": {
        "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location",
        "type": "CustomLocation"
      },
      "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/other-rg/providers/Microsoft.AzureStackHCI/snapshots/test-snapshot-2",
      "location": "East US",
      "properties": {
        "creationData": {
          "createOption": "Copy",
          "sourceResourceId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/other-rg/providers/Microsoft.AzureStackHCI/virtualHardDisks/another-vhd",
          "sourceUniqueId": "c11a94ca-e43d-4282-9c78-84d58e5ce81b"
        },
        "provisioningState": "Succeeded",
        "timeCreated": "2023-11-16T08:30:00Z",
        "diskSizeBytes": 137438953472,
        "uniqueId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
        "status": {
          "provisioningStatus": {
            "status": "Succeeded"
          }
        }
      }
    }
  ]
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
CreationData	Dados usados na criação de um disco ou snapshot
DiskCreateOption	Valores de opção de criação de disco [Copiar, Esvaziar]
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ExtendedLocation	O tipo complexo do local estendido.
ExtendedLocationTypes	O tipo de extendedLocation.
ProvisioningStateEnum	Estado de provisionamento do recurso.
Snapshot	A definição de recurso snapshot.
SnapshotListResult	A resposta de uma operação de lista Snapshot.
SnapshotProperties	Propriedades sob o recurso snapshot
SnapshotStatus	O estado observado dos instantâneos
SnapshotStatusProvisioningStatus	Estado de provisão do estado do instantâneo
Status	O status da operação executada no recurso [Succeeded, Failed, InProgress]
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

CreationData

Object

Dados usados na criação de um disco ou snapshot

Name	Tipo	Description
createOption	DiskCreateOption	Isto enumera as possíveis fontes da criação de um disco
sourceResourceId	string (arm-id)	ID ARM do recurso de origem usado para a criação do disco. É obrigatório quando createOption é Copy
sourceUniqueId	string	ID único do recurso de origem usado para a criação do disco. Só leitura e não é obrigatório para criação de disco.

DiskCreateOption

Enumeração

Valores de opção de criação de disco [Copiar, Esvaziar]

Valor	Description
Copy	Crie um disco copiando a partir de um recurso de origem
Empty	Criar um disco vazio

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ExtendedLocation

Object

O tipo complexo do local estendido.

Name	Tipo	Description
name	string	O nome do local estendido.
type	ExtendedLocationTypes	O tipo de localização ampliada.

ExtendedLocationTypes

Enumeração

O tipo de extendedLocation.

Valor	Description
CustomLocation	Tipo de local estendido personalizado

ProvisioningStateEnum

Enumeração

Estado de provisionamento do recurso.

Valor	Description
Succeeded	O provisionamento foi bem-sucedido
Failed	O provisionamento falhou
InProgress	O provisionamento está em andamento
Accepted	O provisionamento foi aceito
Deleting	A supressão do recurso está em curso
Canceled	O provisionamento foi cancelado

Snapshot

Object

A definição de recurso snapshot.

Name	Tipo	Description
extendedLocation	ExtendedLocation	O extendedLocation do recurso.
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties	SnapshotProperties	As propriedades específicas do recurso para este recurso.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SnapshotListResult

Object

A resposta de uma operação de lista Snapshot.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	Snapshot[]	Os itens de instantâneo nesta página

SnapshotProperties

Object

Propriedades sob o recurso snapshot

Name	Tipo	Description
creationData	CreationData	Dados usados na criação de um snapshot
diskSizeBytes	integer (int64)	O tamanho do disco em bytes.
provisioningState	ProvisioningStateEnum	Estado de provisionamento do snapshot.
status	SnapshotStatus	O estado observado dos instantâneos
timeCreated	string (date-time)	A hora em que o instantâneo foi criado.
uniqueId	string	Identificador único para o instantâneo.

SnapshotStatus

Object

O estado observado dos instantâneos

Name	Tipo	Description
errorCode	string	Código de erro de provisão de snapshots
errorMessage	string	Mensagem de erro descritiva
provisioningStatus	SnapshotStatusProvisioningStatus	Estado de provisionamento do snapshot

SnapshotStatusProvisioningStatus

Object

Estado de provisão do estado do instantâneo

Name	Tipo	Description
operationId	string	O ID da operação realizada no snapshot
status	Status	O estado da operação realizada no snapshot [Sucesso, Falhado, Em Progresso]

Status

Enumeração

O status da operação executada no recurso [Succeeded, Failed, InProgress]

Valor	Description
Succeeded	Operação bem sucedida
Failed	Falha na operação
InProgress	Operação está em curso

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Snapshots - List All

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

List all snapshots in a subscription

Pedido de amostra

Resposta da amostra

Definições

createdByType

CreationData

DiskCreateOption

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedLocation

ExtendedLocationTypes

ProvisioningStateEnum

Snapshot

SnapshotListResult

SnapshotProperties

SnapshotStatus

SnapshotStatusProvisioningStatus

Status

systemData