Backend - List By Service
Listet eine Auflistung von Back-Ends in der angegebenen Dienstinstanz auf
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
service
|
path | True |
string |
Der Name des API Management-Diensts. Regex pattern: |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
$filter
|
query |
string |
| Feld | Nutzung | Unterstützte Operatoren | Unterstützte Funktionen | |
|
$skip
|
query |
integer int32 |
Die Anzahl der zu überspringenden Datensätze. |
|
$top
|
query |
integer int32 |
Die Anzahl der zurückzugebenden Datensätze. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Listet eine Auflistung von Back-End-Entitäten auf. |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
ApiManagementListBackends
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends?api-version=2022-08-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend",
"type": "Microsoft.ApiManagement/service/backends",
"name": "proxybackend",
"properties": {
"description": "description5308",
"url": "https://backendname2644/",
"protocol": "http",
"credentials": {
"query": {
"sv": [
"xx",
"bb",
"cc"
]
},
"header": {
"x-my-1": [
"val1",
"val2"
]
},
"authorization": {
"scheme": "Basic",
"parameter": "opensesma"
}
},
"proxy": {
"url": "http://192.168.1.1:8080",
"username": "Contoso\\admin",
"password": "<password>"
},
"tls": {
"validateCertificateChain": false,
"validateCertificateName": false
}
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
"type": "Microsoft.ApiManagement/service/backends",
"name": "sfbackend",
"properties": {
"description": "Service Fabric Test App 1",
"url": "fabric:/mytestapp/mytestservice",
"protocol": "http",
"properties": {
"serviceFabricCluster": {
"managementEndpoints": [
"https://somecluster.com"
],
"clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"serverX509Names": [
{
"name": "ServerCommonName1",
"issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
}
],
"maxPartitionResolutionRetries": 5
}
}
}
}
],
"count": 2,
"nextLink": ""
}
Definitionen
Name | Beschreibung |
---|---|
Backend |
Informationen zum Autorisierungsheader. |
Backend |
Darstellung der ausgelagerten Back-End-Liste. |
Backend |
Back-End-Details. |
Backend |
Details zu den Anmeldeinformationen, die zum Herstellen einer Verbindung mit dem Back-End verwendet werden. |
Backend |
Eigenschaften, die für den Back-End-Typ spezifisch sind. |
Backend |
Back-End-Kommunikationsprotokoll. |
Backend |
Details zum Back-End-WebProxy-Server, der in der Anforderung an das Back-End verwendet werden soll. |
Backend |
Eigenschaften des Service Fabric-Typ-Back-Ends. |
Backend |
Eigenschaften, die die TLS-Zertifikatüberprüfung steuern. |
Error |
Fehlerfeldvertrag. |
Error |
Fehlerantwort. |
X509Certificate |
Eigenschaften von Server X509Names. |
BackendAuthorizationHeaderCredentials
Informationen zum Autorisierungsheader.
Name | Typ | Beschreibung |
---|---|---|
parameter |
string |
Authentifizierungsparameterwert. |
scheme |
string |
Name des Authentifizierungsschemas. |
BackendCollection
Darstellung der ausgelagerten Back-End-Liste.
Name | Typ | Beschreibung |
---|---|---|
count |
integer |
Gesamtzahl der Datensätze auf allen Seiten. |
nextLink |
string |
Link zur nächsten Seite, falls vorhanden. |
value |
Back-End-Werte. |
BackendContract
Back-End-Details.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Der Name der Ressource |
properties.credentials |
Vertragseigenschaften für Back-End-Anmeldeinformationen |
|
properties.description |
string |
Back-End-Beschreibung. |
properties.properties |
Back-End-Eigenschaften-Vertrag |
|
properties.protocol |
Back-End-Kommunikationsprotokoll. |
|
properties.proxy |
Vertragseigenschaften des Back-End-Gateways |
|
properties.resourceId |
string |
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 |
Back-End-Titel. |
properties.tls |
Back-End-TLS-Eigenschaften |
|
properties.url |
string |
Laufzeit-URL des Back-Ends. |
type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
BackendCredentialsContract
Details zu den Anmeldeinformationen, die zum Herstellen einer Verbindung mit dem Back-End verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
authorization |
Authentifizierung des Autorisierungsheaders |
|
certificate |
string[] |
Liste der Clientzertifikatfingerabdrücke. Wird ignoriert, wenn certificatesIds angegeben werden. |
certificateIds |
string[] |
Liste der Clientzertifikat-IDs. |
header |
object |
Beschreibung des Headerparameters. |
query |
object |
Beschreibung des Abfrageparameters. |
BackendProperties
Eigenschaften, die für den Back-End-Typ spezifisch sind.
Name | Typ | Beschreibung |
---|---|---|
serviceFabricCluster |
Back-End Service Fabric-Clustereigenschaften |
BackendProtocol
Back-End-Kommunikationsprotokoll.
Name | Typ | Beschreibung |
---|---|---|
http |
string |
Das Back-End ist ein RESTful-Dienst. |
soap |
string |
Das Back-End ist ein SOAP-Dienst. |
BackendProxyContract
Details zum Back-End-WebProxy-Server, der in der Anforderung an das Back-End verwendet werden soll.
Name | Typ | Beschreibung |
---|---|---|
password |
string |
Kennwort zum Herstellen einer Verbindung mit dem WebProxy-Server |
url |
string |
WebProxy Server AbsoluteUri-Eigenschaft, die den gesamten URI enthält, der im Uri instance gespeichert ist, einschließlich aller Fragmente und Abfragezeichenfolgen. |
username |
string |
Benutzername zum Herstellen einer Verbindung mit dem WebProxy-Server |
BackendServiceFabricClusterProperties
Eigenschaften des Service Fabric-Typ-Back-Ends.
Name | Typ | Beschreibung |
---|---|---|
clientCertificateId |
string |
Die Clientzertifikat-ID für den Verwaltungsendpunkt. |
clientCertificatethumbprint |
string |
Der Clientzertifikatfingerabdruck für den Verwaltungsendpunkt. Wird ignoriert, wenn certificatesIds angegeben werden. |
managementEndpoints |
string[] |
Der Clusterverwaltungsendpunkt. |
maxPartitionResolutionRetries |
integer |
Maximale Anzahl von Wiederholungsversuchen beim Auflösen der Partition. |
serverCertificateThumbprints |
string[] |
Fingerabdrucke von Zertifikaten, die der Clusterverwaltungsdienst für die TLS-Kommunikation verwendet |
serverX509Names |
Server X509-Zertifikatnamensammlung |
BackendTlsProperties
Eigenschaften, die die TLS-Zertifikatüberprüfung steuern.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
validateCertificateChain |
boolean |
True |
Flag, das angibt, ob die SSL-Zertifikatkettenüberprüfung durchgeführt werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden. |
validateCertificateName |
boolean |
True |
Flag, das angibt, ob die SSL-Zertifikatnamenüberprüfung durchgeführt werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen. |
ErrorFieldContract
Fehlerfeldvertrag.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode auf Eigenschaftsebene. |
message |
string |
Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene. |
target |
string |
Der Eigenschaftsname. |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode. |
error.details |
Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden. |
|
error.message |
string |
Lesbare Darstellung des Fehlers. |
X509CertificateName
Eigenschaften von Server X509Names.
Name | Typ | Beschreibung |
---|---|---|
issuerCertificateThumbprint |
string |
Fingerabdruck für den Aussteller des Zertifikats. |
name |
string |
Allgemeiner Name des Zertifikats. |