Workspaces - List Keys

Tjänst:

Azure Quantum

API-version:

2025-12-15-preview

Hämta nycklarna som ska användas med Quantum-API:erna. En nyckel används för att autentisera och auktorisera åtkomst till Quantum REST API:er. Endast en nyckel behövs i taget. två ges för att ge sömlös nyckelregenerering.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/listKeys?api-version=2025-12-15-preview

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	Namnet på kvantarbetsytans resurs.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svaren

Namn	Typ	Beskrivning
200 OK	ListKeysResult	Azure-åtgärden har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Rinna: implicit
URL för auktorisering: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	personifiera ditt användarkonto

Exempel

Workspaces_ListKeys

Exempel på begäran

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/quantumResourcegroup/providers/Microsoft.Quantum/workspaces/quantumworkspace1/listKeys?api-version=2025-12-15-preview

Exempel på svar

Status kod:

200

{
  "apiKeyEnabled": true,
  "primaryKey": {
    "createdAt": "2023-11-13T23:06:09.147165Z",
    "key": "<primaryKey>"
  },
  "secondaryKey": {
    "createdAt": "2023-11-13T23:06:09.147165Z",
    "key": "<secondaryKey>"
  },
  "primaryConnectionString": "<primaryConnectionString>",
  "secondaryConnectionString": "<secondaryConnectionString>"
}

Definitioner

Namn	Beskrivning
ApiKey	Nyckelinformation om API:et för Azure Quantum-arbetsytan.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Detaljerna om felet.
ErrorResponse	Felsvar
ListKeysResult	Resultatet av listan API-nycklar och anslutningssträngar.

ApiKey

Objekt

Nyckelinformation om API:et för Azure Quantum-arbetsytan.

Namn	Typ	Beskrivning
createdAt	string (date-time)	Skapandetiden för API-nyckeln.
key	string	API-nyckeln.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Namn	Typ	Beskrivning
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Detaljerna om felet.

Namn	Typ	Beskrivning
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Namn	Typ	Beskrivning
error	ErrorDetail	Felobjektet.

ListKeysResult

Objekt

Resultatet av listan API-nycklar och anslutningssträngar.

Namn	Typ	Beskrivning
apiKeyEnabled	boolean	Indikator för aktivering av Api-nycklar för Kvantarbetsyta.
primaryConnectionString	string	Συμβολοσειρά σύν
primaryKey	ApiKey	Den primära API-nyckeln för kvantarbetsytan.
secondaryConnectionString	string	Συμβολοσειρά σύν
secondaryKey	ApiKey	Den sekundära API-nyckeln för kvantarbetsytan.