Backend - List By Service

Reference

Služba:: API Management

Verze rozhraní API:: 2022-08-01

Vypíše kolekci back-endů v zadané instanci služby.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serviceName	path	True	string	Název služby API Management. Vzor regulárního výrazu: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
$filter	query		string	\| Pole \| Využití \| Podporované operátory \| Podporované funkce \| \|-------------\|-------------\|-------------\|-------------\| \| name \| filtr \| ge, le, eq, ne, gt, lt \| podřetězce, obsahuje, startswith, endswith \| \| title \| filtr \| ge, le, eq, ne, gt, lt \| podřetězce, obsahuje, startswith, endswith \| \| url \| filtr \| ge, le, eq, ne, gt, lt \| podřetězce, obsahuje, startswith, endswith \|
$skip	query		integer int32	Počet záznamů, které se mají přeskočit
$top	query		integer int32	Počet vrácených záznamů.

Odpovědi

Name	Typ	Description
200 OK	BackendCollection	Vypíše kolekci entit back-endu.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementListBackends

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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": ""
}

Definice

Name	Description
BackendAuthorizationHeaderCredentials	Informace o autorizační hlavičce.
BackendCollection	Reprezentace stránkovaného back-endového seznamu
BackendContract	Podrobnosti o back-endu
BackendCredentialsContract	Podrobnosti o přihlašovacích údajích použitých pro připojení k back-endu
BackendProperties	Vlastnosti specifické pro typ back-endu.
BackendProtocol	Komunikační protokol back-endu.
BackendProxyContract	Podrobnosti o serveru WebProxy back-endu, který se použije v požadavku na back-end.
BackendServiceFabricClusterProperties	Vlastnosti back-endu typu Service Fabric.
BackendTlsProperties	Vlastnosti, které řídí ověřování certifikátu TLS.
ErrorFieldContract	Chybový kontrakt pole.
ErrorResponse	Odpověď na chybu.
X509CertificateName	Vlastnosti serveru X509Names.

BackendAuthorizationHeaderCredentials

Informace o autorizační hlavičce.

Name	Typ	Description
parameter	string	Hodnota parametru ověřování
scheme	string	Název schématu ověřování.

BackendCollection

Reprezentace stránkovaného back-endového seznamu

Name	Typ	Description
count	integer	Celkový počet záznamů na všech stránkách
nextLink	string	Odkaz na další stránku, pokud existuje.
value	BackendContract[]	Back-endové hodnoty.

BackendContract

Podrobnosti o back-endu

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
name	string	Název prostředku
properties.credentials	BackendCredentialsContract	Vlastnosti kontraktu přihlašovacích údajů back-endu
properties.description	string	Popis back-endu
properties.properties	BackendProperties	Kontrakt vlastností back-endu
properties.protocol	BackendProtocol	Komunikační protokol back-endu.
properties.proxy	BackendProxyContract	Vlastnosti kontraktu back-endové brány
properties.resourceId	string	Identifikátor URI správy prostředku v externím systému. Tato adresa URL může být ID prostředku ARM pro Logic Apps, Function Apps nebo API Apps.
properties.title	string	Název back-endu.
properties.tls	BackendTlsProperties	Vlastnosti protokolu TLS back-endu
properties.url	string	Adresa URL modulu runtime back-endu.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

BackendCredentialsContract

Podrobnosti o přihlašovacích údajích použitých pro připojení k back-endu

Name	Typ	Description
authorization	BackendAuthorizationHeaderCredentials	Ověřování pomocí autorizační hlavičky
certificate	string[]	Seznam kryptografických otisků klientských certifikátů Pokud jsou k dispozici identifikátory certificatesId, budou ignorovány.
certificateIds	string[]	Seznam ID klientských certifikátů
header	object	Popis parametru hlavičky.
query	object	Popis parametru dotazu

BackendProperties

Vlastnosti specifické pro typ back-endu.

Name	Typ	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Vlastnosti back-endového clusteru Service Fabric

BackendProtocol

Komunikační protokol back-endu.

Name	Typ	Description
http	string	Back-end je služba RESTful.
soap	string	Back-end je služba SOAP.

BackendProxyContract

Podrobnosti o serveru WebProxy back-endu, který se použije v požadavku na back-end.

Name	Typ	Description
password	string	Heslo pro připojení k serveru WebProxy
url	string	Vlastnost AbsoluteUri serveru WebProxy, která zahrnuje celý identifikátor URI uložený v instanci Uri, včetně všech fragmentů a řetězců dotazu.
username	string	Uživatelské jméno pro připojení k serveru WebProxy

BackendServiceFabricClusterProperties

Vlastnosti back-endu typu Service Fabric.

Name	Typ	Description
clientCertificateId	string	ID klientského certifikátu pro koncový bod správy.
clientCertificatethumbprint	string	Kryptografický otisk klientského certifikátu pro koncový bod správy. Pokud jsou k dispozici identifikátory certificatesId, bude se ignorovat.
managementEndpoints	string[]	Koncový bod správy clusteru.
maxPartitionResolutionRetries	integer	Maximální počet opakování při pokusu o překlad oddílu
serverCertificateThumbprints	string[]	Kryptografické otisky certifikátů, které služba pro správu clusteru používá ke komunikaci tls
serverX509Names	X509CertificateName[]	Kolekce názvů certifikátů serveru X509

BackendTlsProperties

Vlastnosti, které řídí ověřování certifikátu TLS.

Name	Typ	Default value	Description
validateCertificateChain	boolean	True	Příznak určující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření řetězu certifikátů SSL.
validateCertificateName	boolean	True	Příznak určující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření názvu certifikátu SSL.

ErrorFieldContract

Chybový kontrakt pole.

Name	Typ	Description
code	string	Kód chyby na úrovni vlastnosti.
message	string	Pro člověka čitelná reprezentace chyby na úrovni vlastností.
target	string	Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error.code	string	Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
error.details	ErrorFieldContract[]	Seznam neplatných polí se odešle v požadavku v případě chyby ověření.
error.message	string	Pro člověka čitelná reprezentace chyby.

X509CertificateName

Vlastnosti serveru X509Names.

Name	Typ	Description
issuerCertificateThumbprint	string	Kryptografický otisk vystavitele certifikátu.
name	string	Běžný název certifikátu.

Sdílet prostřednictvím

Backend - List By Service

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ApiManagementListBackends

Ukázkový požadavek

Ukázková odpověď

Definice

BackendAuthorizationHeaderCredentials

BackendCollection

BackendContract

BackendCredentialsContract

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

ErrorFieldContract

ErrorResponse

X509CertificateName

Další materiály