Api - List By Tags

Service:

API Management

API Version:

2022-08-01

Etiketlerle ilişkili api koleksiyonunu listeler.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags?$filter={$filter}&$top={$top}&$skip={$skip}&includeNotTaggedApis={includeNotTaggedApis}&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ı. Regex pattern: ^[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 | | displayName | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiRevision | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | yol | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | açıklama | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | isCurrent | filtre | eq | |
$skip	query		integer int32	Atacak kayıt sayısı.
$top	query		integer int32	Döndürülecek kayıt sayısı.
includeNotTaggedApis	query		boolean	Etiketli OLMAYAN API'leri ekleyin.

Yanıtlar

Name	Tür	Description
200 OK	TagResourceCollection	TagResource 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.

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

Scopes

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

Örnekler

ApiManagementListApisByTags

Sample Request

HTTP

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

Java

/** Samples for Api ListByTags. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApisByTags.json
     */
    /**
     * Sample code: ApiManagementListApisByTags.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListApisByTags(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apis().listByTags("rg1", "apimService1", null, 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_apis_by_tags.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.api.list_by_tags(
        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/ApiManagementListApisByTags.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/ApiManagementListApisByTags.json
func ExampleAPIClient_NewListByTagsPager() {
	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.NewAPIClient().NewListByTagsPager("rg1", "apimService1", &armapimanagement.APIClientListByTagsOptions{Filter: nil,
		Top:                  nil,
		Skip:                 nil,
		IncludeNotTaggedApis: 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.TagResourceCollection = armapimanagement.TagResourceCollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.TagResourceContract{
		// 		{
		// 			API: &armapimanagement.APITagResourceContractProperties{
		// 				APIRevision: to.Ptr("1"),
		// 				IsCurrent: to.Ptr(true),
		// 				Name: to.Ptr("Echo API"),
		// 				Path: to.Ptr("echo"),
		// 				ID: to.Ptr("/apis/echo-api"),
		// 				ServiceURL: to.Ptr("http://echoapi.cloudapp.net/api"),
		// 			},
		// 			Tag: &armapimanagement.TagResourceContractProperties{
		// 				Name: to.Ptr("awesomeTag"),
		// 				ID: to.Ptr("/tags/apitag123"),
		// 			},
		// 	}},
		// }
	}
}

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 apis associated with tags.
 *
 * @summary Lists a collection of apis associated with tags.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApisByTags.json
 */
async function apiManagementListApisByTags() {
  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.api.listByTags(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": [
    {
      "tag": {
        "id": "/tags/apitag123",
        "name": "awesomeTag"
      },
      "api": {
        "id": "/apis/echo-api",
        "name": "Echo API",
        "apiRevision": "1",
        "serviceUrl": "http://echoapi.cloudapp.net/api",
        "path": "echo",
        "isCurrent": true
      }
    }
  ],
  "count": 1
}

Tanımlar

Name	Description
ApiContactInformation	API iletişim bilgileri
ApiLicenseInformation	API lisans bilgileri
ApiTagResourceContractProperties	Etiket Kaynakları için API sözleşmesi özellikleri.
ApiType	API türü.
AuthenticationSettingsContract	API Kimlik Doğrulama Ayarları.
bearerTokenSendingMethods	Sunucuya belirteç gönderme.
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.
OAuth2AuthenticationSettingsContract	API OAuth2 Kimlik Doğrulaması ayarları ayrıntıları.
OpenIdAuthenticationSettingsContract	API OAuth2 Kimlik Doğrulaması ayarları ayrıntıları.
OperationTagResourceContractProperties	İşlem Varlığı sözleşmesi Özellikleri.
ProductState	ürünün yayımlanıp yayımlanmadığı. Yayımlanan ürünler geliştirici portalı kullanıcıları tarafından bulunabilir. Yayımlanmayan ürünler yalnızca yöneticiler tarafından görülebilir. Ürün'ün varsayılan durumu Yayımlanmadı.
ProductTagResourceContractProperties	Ürün profili.
Protocol	Bu API'deki işlemlerin hangi protokollerin çağrılabileceğini açıklar.
SubscriptionKeyParameterNamesContract	Abonelik anahtarı parametre adları ayrıntıları.
TagResourceCollection	Sayfalanmış Etiket listesi gösterimi.
TagResourceContract	TagResource sözleşme özellikleri.
TagTagResourceContractProperties	Etiket Kaynağı Sözleşmesi'nde Tag özelliğini tanımlayan sözleşme

ApiContactInformation

API iletişim bilgileri

Name	Tür	Description
email	string	İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde OLMALıDıR
name	string	İlgili kişinin/kuruluşun tanımlayıcı adı
url	string	Kişi bilgilerine işaret eden URL. URL biçiminde olmalıdır

ApiLicenseInformation

API lisans bilgileri

Name	Tür	Description
name	string	API için kullanılan lisans adı
url	string	API için kullanılan lisansın URL'si. URL biçiminde olmalıdır

ApiTagResourceContractProperties

Etiket Kaynakları için API sözleşmesi özellikleri.

Name	Tür	Description
apiRevision	string	API'nin düzeltmesini açıklar. Değer sağlanmazsa varsayılan düzeltme 1 oluşturulur
apiRevisionDescription	string	API Düzeltmesi'nin açıklaması.
apiVersion	string	API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir
apiVersionDescription	string	API Sürümünün Açıklaması.
apiVersionSetId	string	İlgili ApiVersionSet için kaynak tanımlayıcısı.
authenticationSettings	AuthenticationSettingsContract	Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu.
contact	ApiContactInformation	API için iletişim bilgileri.
description	string	API'nin açıklaması. HTML biçimlendirme etiketlerini içerebilir.
id	string	/apis/{apiId} biçimindeKI API tanımlayıcısı.
isCurrent	boolean	API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir.
isOnline	boolean	API düzeltmesine ağ geçidi üzerinden erişilip erişilmediğini gösterir.
license	ApiLicenseInformation	API için lisans bilgileri.
name	string	API adı.
path	string	Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL. Bu API'nin genel URL'sini oluşturmak için hizmet örneği oluşturma sırasında belirtilen API uç noktası temel URL'sine eklenir.
protocols	Protocol[]	Bu API'deki işlemlerin hangi protokollerin çağrılabileceğini açıklar.
serviceUrl	string	Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si.
subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API'nin kullanılabilir hale getirildiği protokoller.
subscriptionRequired	boolean	API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir.
termsOfServiceUrl	string	API için Hizmet Koşulları'nın URL'si. URL biçiminde OLMALıDıR.
type	ApiType	API türü.

ApiType

API türü.

Name	Tür	Description
graphql	string
http	string
soap	string
websocket	string

AuthenticationSettingsContract

API Kimlik Doğrulama Ayarları.

Name	Tür	Description
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 Kimlik Doğrulama ayarları
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Bu API'ye dahil edilen OAuth2 kimlik doğrulama ayarlarının koleksiyonu.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect Kimlik Doğrulama Ayarları
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Bu API'ye dahil edilen Open ID Connect kimlik doğrulama ayarlarının koleksiyonu.

bearerTokenSendingMethods

Sunucuya belirteç gönderme.

Name	Tür	Description
authorizationHeader	string	Erişim belirteci, Taşıyıcı şeması kullanılarak Yetkilendirme üst bilgisinde iletilir
query	string	Erişim belirteci sorgu parametreleri olarak iletilir.

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 okunabilen gösterimi.

OAuth2AuthenticationSettingsContract

API OAuth2 Kimlik Doğrulaması ayarları ayrıntıları.

Name	Tür	Description
authorizationServerId	string	OAuth yetkilendirme sunucusu tanımlayıcısı.
scope	string	işlem kapsamı.

OpenIdAuthenticationSettingsContract

API OAuth2 Kimlik Doğrulaması ayarları ayrıntıları.

Name	Tür	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Sunucuya belirteç gönderme.
openidProviderId	string	OAuth yetkilendirme sunucusu tanımlayıcısı.

OperationTagResourceContractProperties

İşlem Varlığı sözleşmesi Özellikleri.

Name	Tür	Description
apiName	string	API Adı.
apiRevision	string	API Düzeltmesi.
apiVersion	string	API Sürümü.
description	string	İşlem Açıklaması.
id	string	/operations/{operationId} biçimindeki işlemin tanımlayıcısı.
method	string	Geçerli bir HTTP İşlem Yöntemi. GET, PUT, POST gibi tipik Http Yöntemleri ancak yalnızca bunlarla sınırlı değildir.
name	string	İşlem adı.
urlTemplate	string	Bu işlem için hedef kaynağı tanımlayan göreli URL şablonu. Parametreler içerebilir. Örnek: /customers/{cid}/orders/{oid}/?date={date}

ProductState

ürünün yayımlanıp yayımlanmadığı. Yayımlanan ürünler geliştirici portalı kullanıcıları tarafından bulunabilir. Yayımlanmayan ürünler yalnızca yöneticiler tarafından görülebilir. Ürün'ün varsayılan durumu Yayımlanmadı.

Name	Tür	Description
notPublished	string
published	string

ProductTagResourceContractProperties

Ürün profili.

Name	Tür	Description
approvalRequired	boolean	abonelik onayı gerekip gerekmediği. Yanlışsa, yeni abonelikler otomatik olarak onaylanır ve geliştiriciler abone olduktan hemen sonra ürünün API'lerini çağırabilir. Doğruysa, geliştiricinin ürünün API'lerinden birini kullanabilmesi için önce yöneticilerin aboneliği el ile onaylaması gerekir. Yalnızca subscriptionRequired özelliği varsa ve false değerine sahipse mevcut olabilir.
description	string	Ürün açıklaması. HTML biçimlendirme etiketlerini içerebilir.
id	string	Ürünün /products/{productId} biçimindeki tanımlayıcısı
name	string	Ürün adı.
state	ProductState	ürünün yayımlanıp yayımlanmadığı. Yayımlanan ürünler geliştirici portalı kullanıcıları tarafından bulunabilir. Yayımlanmayan ürünler yalnızca yöneticiler tarafından görülebilir. Ürün'ün varsayılan durumu Yayımlanmadı.
subscriptionRequired	boolean	Bu ürüne dahil edilen API'lere erişmek için bir ürün aboneliği gerekip gerekmediği. True ise, ürün "korumalı" olarak adlandırılır ve ürüne dahil edilen bir API'ye yapılan isteğin başarılı olması için geçerli bir abonelik anahtarı gerekir. False ise ürün "açık" olarak adlandırılır ve ürüne dahil edilen API'ye yönelik istekler abonelik anahtarı olmadan yapılabilir. Yeni bir ürün oluşturulurken özellik atlanırsa değerin true olduğu varsayılır.
subscriptionsLimit	integer	Bir kullanıcının bu ürüne aynı anda sahip olabileceği abonelik sayısının olup olmadığı. Kullanıcı başına sınırsız aboneliğe izin vermek için null veya atla olarak ayarlayın. Yalnızca subscriptionRequired özelliği varsa ve false değerine sahipse mevcut olabilir.
terms	string	Ürün kullanım koşulları. Ürüne abone olmaya çalışan geliştiriciler sunulur ve abonelik işlemini tamamlamadan önce bu koşulları kabul etmeleri gerekir.

Protocol

Bu API'deki işlemlerin hangi protokollerin çağrılabileceğini açıklar.

Name	Tür	Description
http	string
https	string
ws	string
wss	string

SubscriptionKeyParameterNamesContract

Abonelik anahtarı parametre adları ayrıntıları.

Name	Tür	Description
header	string	Abonelik anahtarı üst bilgi adı.
query	string	Abonelik anahtarı sorgu dizesi parametre adı.

TagResourceCollection

Sayfalanmış Etiket 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	TagResourceContract[]	Sayfa değerleri.

TagResourceContract

TagResource sözleşme özellikleri.

Name	Tür	Description
api	ApiTagResourceContractProperties	Etiketle ilişkili API.
operation	OperationTagResourceContractProperties	etiketle ilişkili işlem.
product	ProductTagResourceContractProperties	Etiketle ilişkili ürün.
tag	TagTagResourceContractProperties	Kaynakla ilişkili etiket.

TagTagResourceContractProperties

Etiket Kaynağı Sözleşmesi'nde Tag özelliğini tanımlayan sözleşme

Name	Tür	Description
id	string	Etiket tanımlayıcısı
name	string	Etiket Adı