Condividi tramite


Backend - List By Service

Elenca una raccolta di back-end nell'istanza del servizio specificata.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName
path True

string

Nome del servizio di Gestione API.

Criterio di espressione regolare: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

$filter
query

string

| Campo | Utilizzo | Operatori supportati | Funzioni supportate |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query

integer

int32

Numero di record da ignorare.

$top
query

integer

int32

Numero di record da restituire.

Risposte

Nome Tipo Descrizione
200 OK

BackendCollection

Elenca una raccolta di entità back-end.

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ApiManagementListBackends

Esempio di richiesta

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends?api-version=2022-08-01

Risposta di esempio

{
  "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": ""
}

Definizioni

Nome Descrizione
BackendAuthorizationHeaderCredentials

Informazioni sull'intestazione dell'autorizzazione.

BackendCollection

Rappresentazione dell'elenco back-end di paging.

BackendContract

Dettagli back-end.

BackendCredentialsContract

Dettagli delle credenziali usate per connettersi al back-end.

BackendProperties

Proprietà specifiche del tipo back-end.

BackendProtocol

Protocollo di comunicazione back-end.

BackendProxyContract

Dettagli del server WebProxy back-end da usare nella richiesta al back-end.

BackendServiceFabricClusterProperties

Proprietà del back-end del tipo di Service Fabric.

BackendTlsProperties

Proprietà che controllano la convalida del certificato TLS.

ErrorFieldContract

Contratto campo di errore.

ErrorResponse

Risposta errore.

X509CertificateName

Proprietà del server X509Names.

BackendAuthorizationHeaderCredentials

Informazioni sull'intestazione dell'autorizzazione.

Nome Tipo Descrizione
parameter

string

Valore del parametro di autenticazione.

scheme

string

Nome schema di autenticazione.

BackendCollection

Rappresentazione dell'elenco back-end di paging.

Nome Tipo Descrizione
count

integer

Numero totale di conteggio record in tutte le pagine.

nextLink

string

Collegamento alla pagina successiva, se disponibile.

value

BackendContract[]

Valori back-end.

BackendContract

Dettagli back-end.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nome della risorsa.

properties.credentials

BackendCredentialsContract

Proprietà del contratto credenziali back-end

properties.description

string

Descrizione back-end.

properties.properties

BackendProperties

Contratto proprietà back-end

properties.protocol

BackendProtocol

Protocollo di comunicazione back-end.

properties.proxy

BackendProxyContract

Proprietà del contratto del gateway back-end

properties.resourceId

string

URI di gestione della risorsa nel sistema esterno. Questo URL può essere l'ID risorsa Arm di App per la logica, app per le funzioni o app per le API.

properties.title

string

Titolo back-end.

properties.tls

BackendTlsProperties

Proprietà TLS back-end

properties.url

string

URL di runtime del back-end.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Dettagli delle credenziali usate per connettersi al back-end.

Nome Tipo Descrizione
authorization

BackendAuthorizationHeaderCredentials

Autenticazione dell'intestazione dell'autorizzazione

certificate

string[]

Elenco delle identificazioni personali del certificato client. Verrà ignorato se vengono forniti certificatesId.

certificateIds

string[]

Elenco di ID certificato client.

header

object

Descrizione del parametro di intestazione.

query

object

Descrizione del parametro di query.

BackendProperties

Proprietà specifiche del tipo back-end.

Nome Tipo Descrizione
serviceFabricCluster

BackendServiceFabricClusterProperties

Proprietà del cluster back-end di Service Fabric

BackendProtocol

Protocollo di comunicazione back-end.

Nome Tipo Descrizione
http

string

Il back-end è un servizio RESTful.

soap

string

Il back-end è un servizio SOAP.

BackendProxyContract

Dettagli del server WebProxy back-end da usare nella richiesta al back-end.

Nome Tipo Descrizione
password

string

Password per la connessione al server WebProxy

url

string

Proprietà AbsoluteUri del server WebProxy che include l'intero URI archiviato nell'istanza Uri, inclusi tutti i frammenti e le stringhe di query.

username

string

Nome utente per connettersi al server WebProxy

BackendServiceFabricClusterProperties

Proprietà del back-end del tipo di Service Fabric.

Nome Tipo Descrizione
clientCertificateId

string

ID certificato client per l'endpoint di gestione.

clientCertificatethumbprint

string

Identificazione personale del certificato client per l'endpoint di gestione. Verrà ignorato se vengono forniti certificatesId

managementEndpoints

string[]

Endpoint di gestione del cluster.

maxPartitionResolutionRetries

integer

Numero massimo di tentativi durante il tentativo di risolvere la partizione.

serverCertificateThumbprints

string[]

Identificazioni personali del servizio di gestione del cluster certificati usati per la comunicazione tls

serverX509Names

X509CertificateName[]

Raccolta dei nomi dei certificati server X509

BackendTlsProperties

Proprietà che controllano la convalida del certificato TLS.

Nome Tipo Valore predefinito Descrizione
validateCertificateChain

boolean

True

Flag che indica se la convalida della catena di certificati SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end.

validateCertificateName

boolean

True

Flag che indica se la convalida del nome del certificato SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end.

ErrorFieldContract

Contratto campo di errore.

Nome Tipo Descrizione
code

string

Codice di errore a livello di proprietà.

message

string

Rappresentazione leggibile dell'errore a livello di proprietà.

target

string

Nome della proprietà.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
error.code

string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.

error.details

ErrorFieldContract[]

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message

string

Rappresentazione leggibile dell'errore.

X509CertificateName

Proprietà del server X509Names.

Nome Tipo Descrizione
issuerCertificateThumbprint

string

Identificazione personale per l'autorità emittente del certificato.

name

string

Nome comune del certificato.