Workspace Backend - Get

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Ruft die Details des durch seinen Bezeichner angegebenen Back-End ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
backendId	path	True	string minLength: 1 maxLength: 80	Bezeichner der Back-End-Entität. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
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	BackendContract	Der Antworttext enthält die angegebene Back-End-Entität. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

BackendContract

Der Antworttext enthält die angegebene Back-End-Entität.

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

ApiManagementGetWorkspaceBackend

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/backends/sfbackend?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/backends/sfbackend",
  "type": "Microsoft.ApiManagement/service/workspaces/backends",
  "name": "sfbackend",
  "properties": {
    "description": "Service Fabric Test App 1",
    "url": "fabric:/mytestapp/mytestservice",
    "protocol": "http",
    "properties": {
      "serviceFabricCluster": {
        "managementEndpoints": [
          "https://somecluster.com"
        ],
        "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}

Definitionen

Name	Beschreibung
BackendAuthorizationHeaderCredentials	Autorisierungsheaderinformationen.
BackendCircuitBreaker	Die Konfiguration des Back-End-Schaltkreisschalters
BackendContract	Back-End-Details.
BackendCredentialsContract	Details zu den Anmeldeinformationen, die zum Herstellen einer Verbindung mit dem Back-End verwendet werden.
BackendPoolItem	Informationen zum Back-End-Pooldienst
BackendProperties	Eigenschaften, die für den Back-End-Typ spezifisch sind.
BackendProtocol	Back-End-Kommunikationsprotokoll.
BackendProxyContract	Details zum Back-End-WebProxy-Server, der in der Anforderung zum Back-End verwendet werden soll.
BackendServiceFabricClusterProperties	Eigenschaften des Service Fabric-Typ-Back-End.
BackendTlsProperties	Eigenschaften, die die TLS-Zertifikatüberprüfung steuern.
BackendType	Typ des Back-End- Ein Back-End kann entweder ein einzelnes oder ein Pool sein.
CircuitBreakerFailureCondition	Die Reisebedingungen des Schaltkreisschalters
CircuitBreakerRule	Regelkonfiguration, um das Back-End zu durchreisen.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
FailureStatusCodeRange	Der Http-Statuscodebereich des Fehlers
Pool
X509CertificateName	Eigenschaften von Server X509Names.

BackendAuthorizationHeaderCredentials

Objekt

Autorisierungsheaderinformationen.

Name	Typ	Beschreibung
parameter	string minLength: 1 maxLength: 300	Authentifizierungsparameterwert.
scheme	string minLength: 1 maxLength: 100	Name des Authentifizierungsschemas.

BackendCircuitBreaker

Objekt

Die Konfiguration des Back-End-Schaltkreisschalters

Name	Typ	Beschreibung
rules	CircuitBreakerRule[]	Die Regeln für das Durchblättern des Back-Ends.

BackendContract

Objekt

Back-End-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.circuitBreaker	BackendCircuitBreaker	Konfiguration des Back-End-Schaltkreisschalters
properties.credentials	BackendCredentialsContract	Eigenschaften des Back-End-Anmeldeinformationsvertrags
properties.description	string minLength: 1 maxLength: 2000	Back-End-Beschreibung.
properties.pool	Pool
properties.properties	BackendProperties	Vertrag für Back-End-Eigenschaften
properties.protocol	BackendProtocol	Back-End-Kommunikationsprotokoll.
properties.proxy	BackendProxyContract	Eigenschaften des Back-End-Gatewayvertrags
properties.resourceId	string minLength: 1 maxLength: 2000	Verwaltungs-URI der Ressource im externen System. Diese URL kann die Arm-Ressourcen-ID von Logik-Apps, Funktions-Apps oder API-Apps sein.
properties.title	string minLength: 1 maxLength: 300	Back-End-Titel.
properties.tls	BackendTlsProperties	Back-End-TLS-Eigenschaften
properties.type	BackendType	Typ des Back-End- Ein Back-End kann entweder ein einzelnes oder ein Pool sein.
properties.url	string minLength: 1 maxLength: 2000	Laufzeit-URL des Back-End.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Objekt

Details zu den Anmeldeinformationen, die zum Herstellen einer Verbindung mit dem Back-End verwendet werden.

Name	Typ	Beschreibung
authorization	BackendAuthorizationHeaderCredentials	Autorisierungsheaderauthentifizierung
certificate	string[]	Liste der Clientzertifikatfingerabdrücke. Wird ignoriert, wenn zertifikateIds bereitgestellt werden.
certificateIds	string[]	Liste der Clientzertifikat-IDs.
header	object	Beschreibung des Headerparameters.
query	object	Beschreibung des Abfrageparameters.

BackendPoolItem

Objekt

Informationen zum Back-End-Pooldienst

Name	Typ	Beschreibung
id	string (arm-id)	Die eindeutige ARM-ID der Back-End-Entität. Die ARM-ID sollte auf eine bereits vorhandene Back-End-Entität verweisen.
priority	integer (int32) minimum: 0 maximum: 100	Die Priorität der Back-End-Entität im Back-End-Pool. Muss zwischen 0 und 100 sein. Er kann auch NULL sein, wenn der wert nicht angegeben wurde.
weight	integer (int32) minimum: 0 maximum: 100	Die Gewichtung der Back-End-Entität im Back-End-Pool. Muss zwischen 0 und 100 sein. Er kann auch NULL sein, wenn der wert nicht angegeben wurde.

BackendProperties

Objekt

Eigenschaften, die für den Back-End-Typ spezifisch sind.

Name	Typ	Beschreibung
serviceFabricCluster	BackendServiceFabricClusterProperties	Back-End Service Fabric-Clustereigenschaften

BackendProtocol

Enumeration

Back-End-Kommunikationsprotokoll.

Wert	Beschreibung
http	Das Back-End ist ein RESTful-Dienst.
soap	Das Back-End ist ein SOAP-Dienst.

BackendProxyContract

Objekt

Details zum Back-End-WebProxy-Server, der in der Anforderung zum Back-End verwendet werden soll.

Name	Typ	Beschreibung
password	string	Kennwort zum Herstellen einer Verbindung mit dem WebProxy-Server
url	string minLength: 1 maxLength: 2000	WebProxy Server AbsoluteUri-Eigenschaft, die den gesamten URI enthält, der in der URI-Instanz gespeichert ist, einschließlich aller Fragmente und Abfragezeichenfolgen.
username	string	Benutzername zum Herstellen einer Verbindung mit dem WebProxy-Server

BackendServiceFabricClusterProperties

Objekt

Eigenschaften des Service Fabric-Typ-Back-End.

Name	Typ	Beschreibung
clientCertificateId	string	Die Clientzertifikat-ID für den Verwaltungsendpunkt.
clientCertificatethumbprint	string	Der Clientzertifikatfingerabdruck für den Verwaltungsendpunkt. Wird ignoriert, wenn zertifikateIds bereitgestellt werden
managementEndpoints	string[]	Der Clusterverwaltungsendpunkt.
maxPartitionResolutionRetries	integer (int32)	Maximale Anzahl von Wiederholungen beim Auflösen der Partition.
serverCertificateThumbprints	string[]	Fingerabdruck von Zertifikaten, die für die Tls-Kommunikation verwendet werden
serverX509Names	X509CertificateName[]	Server X509-Zertifikatnamensammlung

BackendTlsProperties

Objekt

Eigenschaften, die die TLS-Zertifikatüberprüfung steuern.

Name	Typ	Standardwert	Beschreibung
validateCertificateChain	boolean	True	Flag, das angibt, ob die ÜBERPRÜFUNG der SSL-Zertifikatkette erfolgen soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen.
validateCertificateName	boolean	True	Flag, das angibt, ob die ÜBERPRÜFUNG des SSL-Zertifikatnamens bei Verwendung von selbstsignierten Zertifikaten für diesen Back-End-Host erfolgen soll.

BackendType

Enumeration

Typ des Back-End- Ein Back-End kann entweder ein einzelnes oder ein Pool sein.

Wert	Beschreibung
Pool	unterstützt Pool-Back-End
Single	unterstützt ein einzelnes Back-End

CircuitBreakerFailureCondition

Objekt

Die Reisebedingungen des Schaltkreisschalters

Name	Typ	Beschreibung
count	integer (int64)	Der Schwellenwert zum Öffnen des Schaltkreises.
errorReasons	string[] maxLength: 200	Die Fehlergründe, die als Fehler betrachtet werden.
interval	string (duration)	Das Intervall, in dem die Fehler gezählt werden.
percentage	integer (int64)	Der Schwellenwert zum Öffnen des Schaltkreises.
statusCodeRanges	FailureStatusCodeRange[]	Die Statuscodebereiche, die als Fehler betrachtet werden.

CircuitBreakerRule

Objekt

Regelkonfiguration, um das Back-End zu durchreisen.

Name	Typ	Beschreibung
acceptRetryAfter	boolean	flag to accept Retry-After header from the backend.
failureCondition	CircuitBreakerFailureCondition	Die Bedingungen für das Durchblättern des Schaltkreisschalters.
name	string	Der Regelname.
tripDuration	string (duration)	Die Dauer, für die der Schaltkreis übersprungen wird.

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.

FailureStatusCodeRange

Objekt

Der Http-Statuscodebereich des Fehlers

Name	Typ	Beschreibung
max	integer (int32) minimum: 200 maximum: 599	Der maximale HTTP-Statuscode.
min	integer (int32) minimum: 200 maximum: 599	Der minimale HTTP-Statuscode.

Pool

Objekt

Name	Typ	Beschreibung
services	BackendPoolItem[]	Die Liste der Back-End-Entitäten, die zu einem Pool gehören.

X509CertificateName

Objekt

Eigenschaften von Server X509Names.

Name	Typ	Beschreibung
issuerCertificateThumbprint	string	Fingerabdruck für den Aussteller des Zertifikats.
name	string	Allgemeiner Name des Zertifikats.

Freigeben über

Workspace Backend - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementGetWorkspaceBackend

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

Zusätzliche Ressourcen