Backend - List By Service

Başvuru

Hizmet:: API Management

API Sürümü:: 2022-08-01

Belirtilen hizmet örneğindeki bir arka uç koleksiyonunu listeler.

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

İsteğe bağlı parametrelerle:

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
serviceName	path	True	string	API Management hizmetinin adı. Normal ifade deseni: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
$filter	query		string	\| Alan \| Kullanım \| Desteklenen işleçler \| Desteklenen işlevler \| \|-------------\|-------------\|-------------\|-------------\| \| ad \| filtre \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| title \| filtre \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| url \| filtre \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer int32	Atacak kayıt sayısı.
$top	query		integer int32	Döndürülecek kayıt sayısı.

Yanıtlar

Name	Tür	Description
200 OK	BackendCollection	Arka uç varlıklarından oluşan bir koleksiyonu listeler.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementListBackends

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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": ""
}

Tanımlar

Name	Description
BackendAuthorizationHeaderCredentials	Yetkilendirme üst bilgisi bilgileri.
BackendCollection	Sayfalanmış Arka uç listesi gösterimi.
BackendContract	Arka uç ayrıntıları.
BackendCredentialsContract	Arka Uç'a bağlanmak için kullanılan Kimlik Bilgilerinin ayrıntıları.
BackendProperties	Arka Uç Türüne özgü özellikler.
BackendProtocol	Arka uç iletişim protokolü.
BackendProxyContract	Arka Uç İsteğinde kullanılacak Arka Uç WebProxy Sunucusunun ayrıntıları.
BackendServiceFabricClusterProperties	Service Fabric Türü Arka Ucu özellikleri.
BackendTlsProperties	TLS Sertifika Doğrulamasını denetleen özellikler.
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.
X509CertificateName	X509Names sunucusunun özellikleri.

BackendAuthorizationHeaderCredentials

Yetkilendirme üst bilgisi bilgileri.

Name	Tür	Description
parameter	string	Kimlik Doğrulama Parametresi değeri.
scheme	string	Kimlik Doğrulama Düzeni adı.

BackendCollection

Sayfalanmış Arka uç listesi gösterimi.

Name	Tür	Description
count	integer	Tüm sayfalardaki toplam kayıt sayısı.
nextLink	string	Varsa sonraki sayfa bağlantısı.
value	BackendContract[]	Arka uç değerleri.

BackendContract

Arka uç ayrıntıları.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.credentials	BackendCredentialsContract	Arka Uç Kimlik Bilgileri Sözleşme Özellikleri
properties.description	string	Arka Uç Açıklaması.
properties.properties	BackendProperties	Arka Uç Özellikleri sözleşmesi
properties.protocol	BackendProtocol	Arka uç iletişim protokolü.
properties.proxy	BackendProxyContract	Arka uç ağ geçidi Sözleşme Özellikleri
properties.resourceId	string	Dış Sistemdeki Kaynağın Yönetim Uri'si. Bu URL Logic Apps, İşlev Uygulamaları veya API Uygulamalarının Arm Kaynak Kimliği olabilir.
properties.title	string	Arka Uç Başlığı.
properties.tls	BackendTlsProperties	Arka Uç TLS Özellikleri
properties.url	string	Arka Ucun Çalışma Zamanı Url'si.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Arka Uç'a bağlanmak için kullanılan Kimlik Bilgilerinin ayrıntıları.

Name	Tür	Description
authorization	BackendAuthorizationHeaderCredentials	Yetkilendirme üst bilgisi kimlik doğrulaması
certificate	string[]	İstemci Sertifikası Parmak İzleri listesi. CertificatesId'ler sağlanırsa yoksayılır.
certificateIds	string[]	İstemci Sertifika Kimliklerinin listesi.
header	object	Üst Bilgi Parametresi açıklaması.
query	object	Sorgu Parametresi açıklaması.

BackendProperties

Arka Uç Türüne özgü özellikler.

Name	Tür	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Arka Uç Service Fabric Küme Özellikleri

BackendProtocol

Arka uç iletişim protokolü.

Name	Tür	Description
http	string	Arka uç bir RESTful hizmetidir.
soap	string	Arka Uç bir SOAP hizmetidir.

BackendProxyContract

Arka Uç İsteğinde kullanılacak Arka Uç WebProxy Sunucusunun ayrıntıları.

Name	Tür	Description
password	string	WebProxy Sunucusuna bağlanmak için parola
url	string	Tüm parçalar ve sorgu dizeleri dahil olmak üzere Uri örneğinde depolanan URI'nin tamamını içeren WebProxy Server AbsoluteUri özelliği.
username	string	WebProxy sunucusuna bağlanmak için kullanıcı adı

BackendServiceFabricClusterProperties

Service Fabric Türü Arka Ucu özellikleri.

Name	Tür	Description
clientCertificateId	string	Yönetim uç noktası için istemci sertifika kimliği.
clientCertificatethumbprint	string	Yönetim uç noktası için istemci sertifikası parmak izi. CertificatesId'ler sağlanırsa yoksayılır
managementEndpoints	string[]	Küme yönetimi uç noktası.
maxPartitionResolutionRetries	integer	Bölümü çözümlemeye çalışırken en fazla yeniden deneme sayısı.
serverCertificateThumbprints	string[]	Küme yönetim hizmetinin tls iletişimi için kullandığı sertifikaların parmak izleri
serverX509Names	X509CertificateName[]	Sunucu X509 Sertifika Adları Koleksiyonu

BackendTlsProperties

TLS Sertifika Doğrulamasını denetleen özellikler.

Name	Tür	Default value	Description
validateCertificateChain	boolean	True	Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika zinciri doğrulamasının yapılıp yapılmayacağını belirten bayrak.
validateCertificateName	boolean	True	Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika adı doğrulamasının yapılıp yapılmayacağını belirten bayrak.

ErrorFieldContract

Hata Alanı sözleşmesi.

Name	Tür	Description
code	string	Özellik düzeyi hata kodu.
message	string	Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target	string	Özellik adı.

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
error.code	string	Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details	ErrorFieldContract[]	Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message	string	Hatanın insan tarafından okunabilir gösterimi.

X509CertificateName

X509Names sunucusunun özellikleri.

Name	Tür	Description
issuerCertificateThumbprint	string	Sertifikayı Veren için parmak izi.
name	string	Sertifikanın Ortak Adı.

Aracılığıyla paylaş

Backend - List By Service

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

ApiManagementListBackends

Örnek isteği

Örnek yanıt

Tanımlar

BackendAuthorizationHeaderCredentials

BackendCollection

BackendContract

BackendCredentialsContract

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

ErrorFieldContract

ErrorResponse

X509CertificateName

Ek kaynaklar