Dela via

Configuration Stores - List Keys

Tjänst:
App Configuration
API-version:
2024-06-01

Visar en lista över åtkomstnyckeln för det angivna konfigurationsarkivet.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01
Med valfria parametrar: 
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01&$skipToken={$skipToken}

URI-parametrar

Name I Obligatorisk Typ Description
configStoreName
 path True

string

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

Namnet på konfigurationsarkivet.
resourceGroupName
 path True

string

Namnet på resursgruppen som containerregistret tillhör.
subscriptionId
 path True

string

Prenumerations-ID för Microsoft Azure.
api-version
 query True

string

Klient-API-versionen.
$skipToken
 query

string

En hopptoken används för att fortsätta hämta objekt när en åtgärd returnerar ett partiellt resultat. Om ett tidigare svar innehåller ett nextLink-element innehåller värdet för nextLink-elementet en skipToken-parameter som anger en startpunkt som ska användas för efterföljande anrop.

Svar

Name Typ Description
200 OK

ApiKeyListResult

Begäran lyckades. begäran var väl utformad och mottogs korrekt.
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ConfigurationStores_ListKeys

Exempelbegäran

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

Exempelsvar

Statuskod:
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
    }
  ]
}

Definitioner

Name Description
ApiKey

En API-nyckel som används för autentisering med en slutpunkt för konfigurationsarkivet.
ApiKeyListResult

Resultatet av en begäran om att lista API-nycklar.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetails

Information om felet.
ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

ApiKey

Objekt

En API-nyckel som används för autentisering med en slutpunkt för konfigurationsarkivet.

Name Typ Description
connectionString

string

En anslutningssträng som kan användas av klienter som stöder autentisering.
id

string

Nyckel-ID:t.
lastModified

string (date-time)

Senaste gången någon av nyckelns egenskaper ändrades.
name

string

Ett namn på nyckeln som beskriver dess användning.
readOnly

boolean

Om den här nyckeln bara kan användas för läsåtgärder.
value

string

Värdet för nyckeln som används i autentiseringssyfte.

ApiKeyListResult

Objekt

Resultatet av en begäran om att lista API-nycklar.

Name Typ Description
nextLink

string

Den URI som kan användas för att begära nästa uppsättning sidiga resultat.
value

ApiKey[]

Samlingsvärdet.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetails

Objekt

Information om felet.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkod.
message

string

Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Objekt

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name Typ Description
error

ErrorDetails

Information om felet.