Backend - List By Service

Referens

Service:: API Management

API Version:: 2022-08-01

Visar en samling serverdelar i den angivna tjänstinstansen.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends?api-version=2022-08-01

With optional parameters:

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-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string	Namnet på API Management-tjänsten. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
$filter	query		string	\| Fält \| Användning \| Operatorer som stöds \| Funktioner som stöds \| \|-------------\|-------------\|-------------\|-------------\| \| namn \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| rubrik \| 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	Antal poster att hoppa över.
$top	query		integer int32	Antal poster som ska returneras.

Svar

Name	Typ	Description
200 OK	BackendCollection	Visar en samling serverdelsentiteter.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementListBackends

Sample Request

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

/** Samples for Backend ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListBackends.json
     */
    /**
     * Sample code: ApiManagementListBackends.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListBackends(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.backends().listByService("rg1", "apimService1", null, null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_backends.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.backend.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListBackends.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListBackends.json
func ExampleBackendClient_NewListByServicePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBackendClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.BackendClientListByServiceOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BackendCollection = armapimanagement.BackendCollection{
		// 	Count: to.Ptr[int64](2),
		// 	Value: []*armapimanagement.BackendContract{
		// 		{
		// 			Name: to.Ptr("proxybackend"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/backends"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend"),
		// 			Properties: &armapimanagement.BackendContractProperties{
		// 				Description: to.Ptr("description5308"),
		// 				Credentials: &armapimanagement.BackendCredentialsContract{
		// 					Authorization: &armapimanagement.BackendAuthorizationHeaderCredentials{
		// 						Parameter: to.Ptr("opensesma"),
		// 						Scheme: to.Ptr("Basic"),
		// 					},
		// 					Header: map[string][]*string{
		// 						"x-my-1": []*string{
		// 							to.Ptr("val1"),
		// 							to.Ptr("val2")},
		// 						},
		// 						Query: map[string][]*string{
		// 							"sv": []*string{
		// 								to.Ptr("xx"),
		// 								to.Ptr("bb"),
		// 								to.Ptr("cc")},
		// 							},
		// 						},
		// 						Proxy: &armapimanagement.BackendProxyContract{
		// 							Password: to.Ptr("<password>"),
		// 							URL: to.Ptr("http://192.168.1.1:8080"),
		// 							Username: to.Ptr("Contoso\\admin"),
		// 						},
		// 						TLS: &armapimanagement.BackendTLSProperties{
		// 							ValidateCertificateChain: to.Ptr(false),
		// 							ValidateCertificateName: to.Ptr(false),
		// 						},
		// 						URL: to.Ptr("https://backendname2644/"),
		// 						Protocol: to.Ptr(armapimanagement.BackendProtocolHTTP),
		// 					},
		// 				},
		// 				{
		// 					Name: to.Ptr("sfbackend"),
		// 					Type: to.Ptr("Microsoft.ApiManagement/service/backends"),
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend"),
		// 					Properties: &armapimanagement.BackendContractProperties{
		// 						Description: to.Ptr("Service Fabric Test App 1"),
		// 						Properties: &armapimanagement.BackendProperties{
		// 							ServiceFabricCluster: &armapimanagement.BackendServiceFabricClusterProperties{
		// 								ClientCertificateID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1"),
		// 								ManagementEndpoints: []*string{
		// 									to.Ptr("https://somecluster.com")},
		// 									MaxPartitionResolutionRetries: to.Ptr[int32](5),
		// 									ServerX509Names: []*armapimanagement.X509CertificateName{
		// 										{
		// 											Name: to.Ptr("ServerCommonName1"),
		// 											IssuerCertificateThumbprint: to.Ptr("IssuerCertificateThumbprint1"),
		// 									}},
		// 								},
		// 							},
		// 							URL: to.Ptr("fabric:/mytestapp/mytestservice"),
		// 							Protocol: to.Ptr(armapimanagement.BackendProtocolHTTP),
		// 						},
		// 				}},
		// 			}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists a collection of backends in the specified service instance.
 *
 * @summary Lists a collection of backends in the specified service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListBackends.json
 */
async function apiManagementListBackends() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.backend.listByService(resourceGroupName, serviceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

Definitioner

Name	Description
BackendAuthorizationHeaderCredentials	Information om auktoriseringshuvud.
BackendCollection	Växlingslistrepresentation för serverdel.
BackendContract	Serverdelsinformation.
BackendCredentialsContract	Information om de autentiseringsuppgifter som används för att ansluta till serverdelen.
BackendProperties	Egenskaper som är specifika för serverdelstypen.
BackendProtocol	Protokoll för serverdelskommunikation.
BackendProxyContract	Information om serverdelens WebProxy-server som ska användas i begäran till serverdelen.
BackendServiceFabricClusterProperties	Egenskaper för serverdelen av Service Fabric-typ.
BackendTlsProperties	Egenskaper som styr TLS-certifikatverifiering.
ErrorFieldContract	Fel fältkontrakt.
ErrorResponse	Felsvar.
X509CertificateName	Egenskaper för servern X509Names.

BackendAuthorizationHeaderCredentials

Information om auktoriseringshuvud.

Name	Typ	Description
parameter	string	Värdet för autentiseringsparametern.
scheme	string	Namn på autentiseringsschema.

BackendCollection

Växlingslistrepresentation för serverdel.

Name	Typ	Description
count	integer	Totalt antal poster på alla sidor.
nextLink	string	Länk till nästa sida om det finns någon.
value	BackendContract[]	Serverdelsvärden.

BackendContract

Serverdelsinformation.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.credentials	BackendCredentialsContract	Egenskaper för kontrakt för serverdelsautentiseringsuppgifter
properties.description	string	Beskrivning av serverdelen.
properties.properties	BackendProperties	Kontrakt för serverdelsegenskaper
properties.protocol	BackendProtocol	Protokoll för serverdelskommunikation.
properties.proxy	BackendProxyContract	Egenskaper för serverdelsgatewaykontrakt
properties.resourceId	string	Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Funktionsappar eller API Apps.
properties.title	string	Serverdelsrubrik.
properties.tls	BackendTlsProperties	Egenskaper för serverdels-TLS
properties.url	string	Körnings-URL för serverdelen.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Information om de autentiseringsuppgifter som används för att ansluta till serverdelen.

Name	Typ	Description
authorization	BackendAuthorizationHeaderCredentials	Autentisering med auktoriseringshuvud
certificate	string[]	Lista över tumavtryck för klientcertifikat. Ignoreras om certificatesIds tillhandahålls.
certificateIds	string[]	Lista över klientcertifikat-ID:t.
header	object	Beskrivning av rubrikparameter.
query	object	Beskrivning av frågeparameter.

BackendProperties

Egenskaper som är specifika för serverdelstypen.

Name	Typ	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Egenskaper för Service Fabric-kluster i serverdelen

BackendProtocol

Protokoll för serverdelskommunikation.

Name	Typ	Description
http	string	Serverdelen är en RESTful-tjänst.
soap	string	Serverdelen är en SOAP-tjänst.

BackendProxyContract

Information om serverdelens WebProxy-server som ska användas i begäran till serverdelen.

Name	Typ	Description
password	string	Lösenord för att ansluta till WebProxy-servern
url	string	Egenskapen WebProxy Server AbsoluteUri som innehåller hela URI:n som lagras i URI-instansen, inklusive alla fragment och frågesträngar.
username	string	Användarnamn för att ansluta till WebProxy-servern

BackendServiceFabricClusterProperties

Egenskaper för serverdelen av Service Fabric-typ.

Name	Typ	Description
clientCertificateId	string	Klientcertifikat-ID för hanteringsslutpunkten.
clientCertificatethumbprint	string	Tumavtrycket för klientcertifikatet för hanteringsslutpunkten. Ignoreras om certificatesIds tillhandahålls
managementEndpoints	string[]	Slutpunkten för klusterhantering.
maxPartitionResolutionRetries	integer	Maximalt antal återförsök vid försök att lösa partitionen.
serverCertificateThumbprints	string[]	Tumavtryck för certifikat som klusterhanteringstjänsten använder för TLS-kommunikation
serverX509Names	X509CertificateName[]	Server X509-certifikatnamnsamling

BackendTlsProperties

Egenskaper som styr TLS-certifikatverifiering.

Name	Typ	Standardvärde	Description
validateCertificateChain	boolean	True	Flagga som anger om SSL-certifikatkedjans validering ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.
validateCertificateName	boolean	True	Flagga som anger om SSL-certifikatets namnverifiering ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.

ErrorFieldContract

Fel fältkontrakt.

Name	Typ	Description
code	string	Felkod på egenskapsnivå.
message	string	Mänsklig läsbar representation av fel på egenskapsnivå.
target	string	Egenskapsnamn.

ErrorResponse

Felsvar.

Name	Typ	Description
error.code	string	Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
error.details	ErrorFieldContract[]	Listan över ogiltiga fält som skickas i begäran, vid valideringsfel.
error.message	string	Mänsklig läsbar representation av felet.

X509CertificateName

Egenskaper för servern X509Names.

Name	Typ	Description
issuerCertificateThumbprint	string	Tumavtryck för certifikatutfärdaren.
name	string	Eget namn på certifikatet.

Dela via

Backend - List By Service

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

ApiManagementListBackends

Sample Request

Sample Response

Definitioner

BackendAuthorizationHeaderCredentials

BackendCollection

BackendContract

BackendCredentialsContract

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

ErrorFieldContract

ErrorResponse

X509CertificateName

Ytterligare resurser