Backend - List By Service

Szolgáltatás:

API Management

API-verzió:

2022-08-01

A megadott szolgáltatáspéldány háttérrendszereinek gyűjteményét sorolja fel.

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

Opcionális paraméterekkel:

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-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string	A API Management szolgáltatás neve. Reguláris kifejezési minta: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.
$filter	query		string	| Mező | Használat | Támogatott operátorok | Támogatott függvények | |-------------|-------------|-------------|-------------| | név | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswithwith | | cím | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswithwith | | url | szűrő | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip	query		integer int32	Kihagyandó rekordok száma.
$top	query		integer int32	A visszaadandó rekordok száma.

Válaszok

Name	Típus	Description
200 OK	BackendCollection	A háttérbeli entitások gyűjteményét sorolja fel.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

ApiManagementListBackends

Mintakérelem

HTTP

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

Java

/** 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

Python

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

Go

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

JavaScript

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListBackends.json
// this example is just showing the usage of "Backend_ListByService" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementBackendResource
ApiManagementBackendCollection collection = apiManagementService.GetApiManagementBackends();

// invoke the operation and iterate over the result
await foreach (ApiManagementBackendResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ApiManagementBackendData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Mintaválasz

Állapotkó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": ""
}

Definíciók

Name	Description
BackendAuthorizationHeaderCredentials	Engedélyezési fejléc adatai.
BackendCollection	Lapozott háttérlista-ábrázolás.
BackendContract	Háttéradatok.
BackendCredentialsContract	A háttérrendszerhez való csatlakozáshoz használt hitelesítő adatok részletei.
BackendProperties	A háttértípusra jellemző tulajdonságok.
BackendProtocol	Háttérbeli kommunikációs protokoll.
BackendProxyContract	A Háttérbeli WebProxy-kiszolgáló részletei, amelyet a Háttéralkalmazás kérésében használhat.
BackendServiceFabricClusterProperties	A Service Fabric-típus háttérrendszerének tulajdonságai.
BackendTlsProperties	A TLS-tanúsítványérvényesítést vezérlő tulajdonságok.
ErrorFieldContract	Hibamező-szerződés.
ErrorResponse	Hibaválasz.
X509CertificateName	Az X509Names kiszolgáló tulajdonságai.

BackendAuthorizationHeaderCredentials

Engedélyezési fejléc adatai.

Name	Típus	Description
parameter	string	Hitelesítési paraméter értéke.
scheme	string	Hitelesítési séma neve.

BackendCollection

Lapozott háttérlista-ábrázolás.

Name	Típus	Description
count	integer	Összes rekordszám az összes oldalon.
nextLink	string	Ha van ilyen, a következő oldal hivatkozása.
value	BackendContract[]	Háttérértékek.

BackendContract

Háttéradatok.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.credentials	BackendCredentialsContract	Háttérbeli hitelesítő adatok szerződésének tulajdonságai
properties.description	string	Háttér leírása.
properties.properties	BackendProperties	Háttértulajdonságok szerződése
properties.protocol	BackendProtocol	Háttérbeli kommunikációs protokoll.
properties.proxy	BackendProxyContract	Háttérátjáró szerződésének tulajdonságai
properties.resourceId	string	Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Függvényalkalmazások vagy az API-alkalmazások ARM-erőforrás-azonosítója.
properties.title	string	Háttércím.
properties.tls	BackendTlsProperties	Háttérbeli TLS-tulajdonságok
properties.url	string	A háttérrendszer futtatókörnyezeti URL-címe.
type	string	Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

A háttérrendszerhez való csatlakozáshoz használt hitelesítő adatok részletei.

Name	Típus	Description
authorization	BackendAuthorizationHeaderCredentials	Engedélyezési fejléc hitelesítése
certificate	string[]	Ügyféltanúsítvány ujjlenyomatainak listája. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva.
certificateIds	string[]	Ügyféltanúsítvány-azonosítók listája.
header	object	Fejlécparaméter leírása.
query	object	Lekérdezési paraméter leírása.

BackendProperties

A háttértípusra jellemző tulajdonságok.

Name	Típus	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Háttérszolgáltatás-hálófürt tulajdonságai

BackendProtocol

Háttérbeli kommunikációs protokoll.

Name	Típus	Description
http	string	A háttérrendszer egy RESTful szolgáltatás.
soap	string	A háttérrendszer egy SOAP szolgáltatás.

BackendProxyContract

A Háttérbeli WebProxy-kiszolgáló részletei, amelyet a Háttéralkalmazás kérésében használhat.

Name	Típus	Description
password	string	Jelszó a WebProxy-kiszolgálóhoz való csatlakozáshoz
url	string	WebProxy Server AbsoluteUri tulajdonság, amely tartalmazza az URI-példányban tárolt teljes URI-t, beleértve az összes töredéket és lekérdezési sztringet.
username	string	Felhasználónév a WebProxy-kiszolgálóhoz való csatlakozáshoz

BackendServiceFabricClusterProperties

A Service Fabric-típus háttérrendszerének tulajdonságai.

Name	Típus	Description
clientCertificateId	string	A felügyeleti végpont ügyféltanúsítvány-azonosítója.
clientCertificatethumbprint	string	A felügyeleti végpont ügyféltanúsítványának ujjlenyomata. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva
managementEndpoints	string[]	A fürtkezelési végpont.
maxPartitionResolutionRetries	integer	A partíció feloldása során az újrapróbálkozások maximális száma.
serverCertificateThumbprints	string[]	A tanúsítványfürt-felügyeleti szolgáltatás tls-kommunikációhoz használt ujjlenyomatai
serverX509Names	X509CertificateName[]	Kiszolgáló X509-tanúsítványnevek gyűjteménye

BackendTlsProperties

A TLS-tanúsítványérvényesítést vezérlő tulajdonságok.

Name	Típus	Alapértelmezett érték	Description
validateCertificateChain	boolean	True	Jelző, amely azt jelzi, hogy az SSL-tanúsítványlánc érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez.
validateCertificateName	boolean	True	Jelző, amely azt jelzi, hogy az SSL-tanúsítvány nevének érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez.

ErrorFieldContract

Hibamező-szerződés.

Name	Típus	Description
code	string	Tulajdonságszintű hibakód.
message	string	A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.
target	string	Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name	Típus	Description
error.code	string	Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.
error.details	ErrorFieldContract[]	Érvényesítési hiba esetén az érvénytelen mezők listája küldi el a kérést.
error.message	string	A hiba emberi olvasásra alkalmas ábrázolása.

X509CertificateName

Az X509Names kiszolgáló tulajdonságai.

Name	Típus	Description
issuerCertificateThumbprint	string	A tanúsítvány kiállítójának ujjlenyomata.
name	string	A tanúsítvány általános neve.