Partilhar via

Configuration Stores - List Keys

Serviço:
App Configuration
Versão da API:
2024-06-01

Lista a chave de acesso para o repositório de configuração especificado.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01
Com parâmetros opcionais: 
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01&$skipToken={$skipToken}

Parâmetros do URI

Name Em Necessário Tipo Description
configStoreName
 path True

string

minLength: 5
maxLength: 50
pattern: ^[a-zA-Z0-9_-]*$

O nome do repositório de configuração.
resourceGroupName
 path True

string

O nome do grupo de recursos ao qual o registro de contêiner pertence.
subscriptionId
 path True

string

A ID de assinatura do Microsoft Azure.
api-version
 query True

string

A versão da API do cliente.
$skipToken
 query

string

Um token de pulo é usado para continuar recuperando itens depois que uma operação retorna um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro skipToken que especifica um ponto de partida a ser usado para chamadas subsequentes.

Respostas

Name Tipo Description
200 OK

ApiKeyListResult

O pedido foi bem-sucedido; O pedido foi bem formado e recebido adequadamente.
Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

ConfigurationStores_ListKeys

Pedido de amostra

POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/listKeys?api-version=2024-06-01

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "439AD01B4BE67DB1",
      "name": "Primary",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": false
    },
    {
      "id": "CB45E100456857B9",
      "name": "Secondary",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": false
    },
    {
      "id": "B3AC55B7E71431A9",
      "name": "Primary Read Only",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": true
    },
    {
      "id": "E2AF6A9A89DCC177",
      "name": "Secondary Read Only",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": true
    }
  ]
}

Definições

Name Description
ApiKey

Uma chave de API usada para autenticação com um ponto de extremidade de armazenamento de configuração.
ApiKeyListResult

O resultado de uma solicitação para listar chaves de API.
ErrorAdditionalInfo

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

Os detalhes do erro.
ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

ApiKey

Object

Uma chave de API usada para autenticação com um ponto de extremidade de armazenamento de configuração.

Name Tipo Description
connectionString

string

Uma cadeia de conexão que pode ser usada dando suporte a clientes para autenticação.
id

string

O ID da chave.
lastModified

string (date-time)

A última vez que qualquer uma das propriedades da chave foi modificada.
name

string

Um nome para a chave que descreve seu uso.
readOnly

boolean

Se essa chave só pode ser usada para operações de leitura.
value

string

O valor da chave usada para fins de autenticação.

ApiKeyListResult

Object

O resultado de uma solicitação para listar chaves de API.

Name Tipo Description
nextLink

string

O URI que pode ser usado para solicitar o próximo conjunto de resultados paginados.
value

ApiKey[]

O valor da coleção.

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.

ErrorDetails

Object

Os detalhes do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

Código de erro.
message

string

Mensagem de erro indicando por que a operação falhou.

ErrorResponse

Object

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Name Tipo Description
error

ErrorDetails

Os detalhes do erro.