Compartilhar 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 de URI

Nome Em Obrigató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 da assinatura do Microsoft Azure.
api-version
 query True

string

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

string

Um token de ignorar é 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

Nome Tipo Description
200 OK

ApiKeyListResult

A solicitação foi bem-sucedida; a solicitação foi bem formada e recebida corretamente.
Other Status Codes

ErrorResponse

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ConfigurationStores_ListKeys

Solicitação de exemplo

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 de exemplo

Código de status:
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

Nome Description
ApiKey

Uma chave de API usada para autenticação com um ponto de extremidade do repositório de configuração.
ApiKeyListResult

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

As informações adicionais do erro de gerenciamento de recursos.
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

Objeto

Uma chave de API usada para autenticação com um ponto de extremidade do repositório de configuração.

Nome Tipo Description
connectionString

string

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

string

A 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

Objeto

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

Nome Tipo Description
nextLink

string

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

ApiKey[]

O valor da coleção.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetails

Objeto

Os detalhes do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

Código de erro.
message

string

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

ErrorResponse

Objeto

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.

Nome Tipo Description
error

ErrorDetails

Os detalhes do erro.