Get Snapshot - Get Snapshot

Serviço:: App Configuration

Versão da API:: 2024-09-01

Obtém um instantâneo de chave-valor único.

GET {endpoint}/snapshots/{name}?api-version=2024-09-01

Com parâmetros opcionais:

GET {endpoint}/snapshots/{name}?api-version=2024-09-01&$Select={$Select}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)
name	path	True	string	O nome do instantâneo.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$Select	query		SnapshotFields[]	Usado para selecionar quais campos estão presentes nos recursos retornados.

Cabeçalho da solicitação

Nome	Tipo	Description
Sync-Token	string	Usado para garantir a consistência em tempo real entre solicitações.
If-Match	string	Usado para executar uma operação somente se a etag do recurso de destino corresponder ao valor fornecido.
If-None-Match	string	Usado para executar uma operação somente se a etag do recurso de destino não corresponder ao valor fornecido.
x-ms-client-request-id	string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Nome	Tipo	Description
200 OK	Snapshot	A solicitação foi bem-sucedida. Media Types: "application/vnd.microsoft.appconfig.snapshot+json", "application/problem+json", "application/json" Cabeçalhos ETag: string Link: string Sync-Token: string x-ms-request-id: string
Other Status Codes	Error	Uma resposta de erro inesperada. Media Types: "application/vnd.microsoft.appconfig.snapshot+json", "application/problem+json", "application/json"

Nome

Tipo

Description

200 OK

Snapshot

A solicitação foi bem-sucedida.

Media Types: "application/vnd.microsoft.appconfig.snapshot+json", "application/problem+json", "application/json"

Cabeçalhos

ETag: string
Link: string
Sync-Token: string
x-ms-request-id: string

Other Status Codes

Error

Uma resposta de erro inesperada.

Media Types: "application/vnd.microsoft.appconfig.snapshot+json", "application/problem+json", "application/json"

Segurança

Connection String

Tipo: apiKey
Em: header

OAuth2Auth

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

Escopos

Nome	Description
https://azconfig.io/.default

Exemplos

Gets a single key-value snapshot failed.

Gets a single key-value snapshot using If-Match header.

Gets a single key-value snapshot using If-None-Match header.

Gets a single key-value snapshot.

Gets a single key-value snapshot failed.

Solicitação de exemplo

HTTP

GET https://{exampleAppConfigurationName}.azconfig.io/snapshots/Prod-2022-08-01?api-version=2024-09-01

Resposta de exemplo

Código de status:: 200

Content-Type: application/vnd.microsoft.appconfig.snapshot+json
ETag: W/"4f6dd610dd5e4deebc7fbaef685fb903"
Last-Modified: Tue, 01 Aug 2022 16:52:32 GMT
Sync-Token: zAJw6V16=NjotMSM3ODk3NjM=;sn=789763
Link: ; rel="items"

{
  "etag": "4f6dd610dd5e4deebc7fbaef685fb903",
  "name": "Prod-2022-08-01",
  "status": "failed",
  "filters": [
    {
      "key": "app1/*",
      "label": "Production"
    }
  ],
  "composition_type": "all",
  "created": "2022-08-01T22:19:40+00:00",
  "size": 0,
  "items_count": 0,
  "retention_period": 2592000,
  "tags": {
    "release": "{link/id}"
  }
}

Gets a single key-value snapshot using If-Match header.

Solicitação de exemplo

HTTP

GET https://{exampleAppConfigurationName}.azconfig.io/snapshots/Prod-2022-08-01?api-version=2024-09-01

Resposta de exemplo

Código de status:: 200

Content-Type: application/vnd.microsoft.appconfig.snapshot+json
ETag: W/"4f6dd610dd5e4deebc7fbaef685fb903"
Last-Modified: Tue, 01 Aug 2022 16:52:32 GMT
Sync-Token: zAJw6V16=NjotMSM3ODk3NjM=;sn=789763
Link: ; rel="items"

{
  "etag": "4f6dd610dd5e4deebc7fbaef685fb903",
  "name": "Prod-2022-08-01",
  "status": "ready",
  "filters": [
    {
      "key": "app1/*",
      "label": "Production"
    }
  ],
  "composition_type": "all",
  "created": "2022-08-01T22:19:40+00:00",
  "size": 100000,
  "items_count": 71,
  "retention_period": 2592000,
  "tags": {
    "release": "{link/id}"
  }
}

Gets a single key-value snapshot using If-None-Match header.

Solicitação de exemplo

HTTP

GET https://{exampleAppConfigurationName}.azconfig.io/snapshots/Prod-2022-08-01?api-version=2024-09-01

Resposta de exemplo

Código de status:: 200

Content-Type: application/vnd.microsoft.appconfig.snapshot+json
ETag: W/"4f6dd610dd5e4deebc7fbaef685fb903"
Last-Modified: Tue, 01 Aug 2022 16:52:32 GMT
Sync-Token: zAJw6V16=NjotMSM3ODk3NjM=;sn=789763
Link: ; rel="items"

{
  "etag": "4f6dd610dd5e4deebc7fbaef685fb903",
  "name": "Prod-2022-08-01",
  "status": "ready",
  "filters": [
    {
      "key": "app1/*",
      "label": "Production"
    }
  ],
  "composition_type": "all",
  "created": "2022-08-01T22:19:40+00:00",
  "size": 100000,
  "items_count": 71,
  "retention_period": 2592000,
  "tags": {
    "release": "{link/id}"
  }
}

Gets a single key-value snapshot.

Solicitação de exemplo

HTTP

GET https://{exampleAppConfigurationName}.azconfig.io/snapshots/Prod-2022-08-01?api-version=2024-09-01

Resposta de exemplo

Código de status:: 200

Content-Type: application/vnd.microsoft.appconfig.snapshot+json
ETag: W/"4f6dd610dd5e4deebc7fbaef685fb903"
Last-Modified: Tue, 01 Aug 2022 16:52:32 GMT
Sync-Token: zAJw6V16=NjotMSM3ODk3NjM=;sn=789763
Link: ; rel="items"

{
  "etag": "4f6dd610dd5e4deebc7fbaef685fb903",
  "name": "Prod-2022-08-01",
  "status": "ready",
  "filters": [
    {
      "key": "app1/*",
      "label": "Production"
    }
  ],
  "composition_type": "all",
  "created": "2022-08-01T22:19:40+00:00",
  "size": 100000,
  "items_count": 71,
  "retention_period": 2592000,
  "tags": {
    "release": "{link/id}"
  }
}

Definições

Nome	Description
CompositionType	Tipos de composição.
Error	Objeto de erro da Configuração de Aplicativo do Azure.
KeyValueFilter	Habilita a filtragem de chave-valor. Referência de sintaxe: https://aka.ms/azconfig/docs/restapisnapshots
Snapshot	Um instantâneo é um subconjunto nomeado e imutável de um Configuração de Aplicativos valores-chave do repositório.
SnapshotFields	Campos de instantâneo.
SnapshotStatus	Status do instantâneo.

CompositionType

Enumeração

Tipos de composição.

Valor	Description
key	O tipo de composição 'key'.
key_label	O tipo de composição 'key_label'.

Error

Objeto

Objeto de erro da Configuração de Aplicativo do Azure.

Nome	Tipo	Description
detail	string	Uma descrição detalhada do erro.
name	string	O nome do parâmetro que resultou no erro.
status	integer (int32)	O código de status HTTP para o qual o erro é mapeado.
title	string	Um breve resumo do erro.
type	string	O tipo do erro.

KeyValueFilter

Objeto

Habilita a filtragem de chave-valor. Referência de sintaxe: https://aka.ms/azconfig/docs/restapisnapshots

Nome	Tipo	Description
key	string	Filtra os valores-chave por seu campo de chave.
label	string	Filtra os valores-chave por seu campo de rótulo.
tags	string[]	Filtra os valores-chave por seu campo de marcas.

Snapshot

Objeto

Um instantâneo é um subconjunto nomeado e imutável de um Configuração de Aplicativos valores-chave do repositório.

Nome	Tipo	Description
composition_type	CompositionType	O tipo de composição descreve como os valores-chave dentro do instantâneo são compostos. O tipo de composição 'key' garante que não haja dois valores de chave contendo a mesma chave. O tipo de composição 'key_label' garante que não haja dois valores-chave contendo a mesma chave e rótulo.
created	string (date-time)	A hora em que o instantâneo foi criado.
etag	string	Um valor que representa o estado atual do instantâneo.
expires	string (date-time)	A hora em que o instantâneo expirará.
filters	KeyValueFilter[]	Uma lista de filtros usados para filtrar os valores de chave incluídos no instantâneo.
items_count	integer (int64)	A quantidade de valores-chave no instantâneo.
name	string	O nome do instantâneo.
retention_period	integer (int64) minimum: 3600 maximum: 7776000	A quantidade de tempo, em segundos, que um instantâneo permanecerá no estado arquivado antes de expirar. Essa propriedade só é gravável durante a criação de um instantâneo. Se não for especificado, o tempo de vida padrão das revisões chave-valor será usado.
size	integer (int64)	O tamanho em bytes do instantâneo.
status	SnapshotStatus	O status atual do instantâneo.
tags	object	As marcas do instantâneo.

SnapshotFields

Enumeração

Campos de instantâneo.

Valor	Description
name	Campo de nome.
status	Campo Status.
filters	Campo Filtros.
composition_type	Campo tipo de composição.
created	Campo criado.
expires	Expira o campo.
retention_period	Campo período de retenção.
size	Campo de tamanho.
items_count	Campo contagem de itens.
tags	Campo Marcas.
etag	Campo Etag.

SnapshotStatus

Enumeração

Status do instantâneo.

Valor	Description
provisioning	Provisionamento
ready	Pronto
archived	Arquivados
failed	Falha