Workspace Named Value - Get

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Ruft die Details des benannten Werts ab, der durch seinen Bezeichner angegeben wird.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namedValueId	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Bezeichner des NamedValue-Werts.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	NamedValueContract	Der Antworttext enthält die angegebene benannte Wertentität. Keine geheimen Schlüssel enthalten Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

NamedValueContract

Der Antworttext enthält die angegebene benannte Wertentität. Keine geheimen Schlüssel enthalten

Header

ETag: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementGetWorkspaceNamedValue

ApiManagementGetWorkspaceNamedValueWithKeyVault

ApiManagementGetWorkspaceNamedValue

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2",
  "type": "Microsoft.ApiManagement/service/workspaces/namedValues",
  "name": "testarmTemplateproperties2",
  "properties": {
    "displayName": "propName",
    "value": "propValue",
    "tags": [
      "foo",
      "bar"
    ],
    "secret": false
  }
}

ApiManagementGetWorkspaceNamedValueWithKeyVault

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testprop6?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/namedValues/testarmTemplateproperties2",
  "type": "Microsoft.ApiManagement/service/workspaces/namedValues",
  "name": "testprop6",
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
      "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
KeyVaultContractProperties	KeyVault-Vertragsdetails.
KeyVaultLastAccessStatusContractProperties	Vertragsaktualisierungseigenschaften ausstellen.
NamedValueContract	NamedValue-Details.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

KeyVaultContractProperties

Objekt

KeyVault-Vertragsdetails.

Name	Typ	Beschreibung
identityClientId	string	Null für SystemAssignedIdentity oder Client-ID für UserAssignedIdentity, die für den Zugriff auf den Schlüsseltresorschlüssel verwendet wird.
lastStatus	KeyVaultLastAccessStatusContractProperties	Beim letzten Synchronisieren und Aktualisieren des Status des geheimen Schlüssels aus dem Schlüsseltresor.
secretIdentifier	string	Schlüsseltresorschlüsselbezeichner zum Abrufen des geheimen Schlüssels. Durch die Bereitstellung eines versionsbasierten Schlüssels wird die automatische Aktualisierung verhindert. Dazu muss der API-Verwaltungsdienst mit aka.ms/apimmsi konfiguriert werden.

KeyVaultLastAccessStatusContractProperties

Objekt

Vertragsaktualisierungseigenschaften ausstellen.

Name	Typ	Beschreibung
code	string	Letzter Statuscode für die Synchronisierung und Aktualisierung des geheimen Schlüssels aus dem Schlüsseltresor.
message	string	Details zu dem Fehler, der sonst leer ist.
timeStampUtc	string (date-time)	Letzter Zugriff auf den geheimen Schlüssel. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.

NamedValueContract

Objekt

NamedValue-Details.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Eindeutiger Name von NamedValue. Sie darf nur Buchstaben, Ziffern, Punkt, Gedankenstrich und Unterstriche enthalten.
properties.keyVault	KeyVaultContractProperties	KeyVault-Standortdetails des namedValue.KeyVault location details of the namedValue.
properties.provisioningState	string	Der Bereitstellungsstatus
properties.secret	boolean	Bestimmt, ob der Wert ein Geheimschlüssel ist und verschlüsselt werden soll. Der Standardwert ist "false".
properties.tags	string[]	Optionale Tags, die verwendet werden können, um die NamedValue-Liste zu filtern.
properties.value	string maxLength: 4096	Der Wert des NamedValue-Werts. Kann Richtlinienausdrücke enthalten. Es darf nicht leer sein oder nur aus Leerzeichen bestehen. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

Freigeben über

Workspace Named Value - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementGetWorkspaceNamedValue

Beispielanforderung

Beispiel für eine Antwort

ApiManagementGetWorkspaceNamedValueWithKeyVault

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

NamedValueContract

Zusätzliche Ressourcen