Operation - List By Tags
Etiketlerle ilişkili işlem koleksiyonunu listeler.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags?$filter={$filter}&$top={$top}&$skip={$skip}&includeNotTaggedOperations={includeNotTaggedOperations}&api-version=2022-08-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
api
|
path | True |
string |
API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltmede ; rev=n sonek olarak, burada n düzeltme numarasıdır. Normal ifade deseni: |
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Normal ifade deseni: |
subscription
|
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 | |
|
$skip
|
query |
integer int32 |
At edilecek kayıt sayısı. |
|
$top
|
query |
integer int32 |
Döndürülecek kayıt sayısı. |
|
include
|
query |
boolean |
Etiketli olmayan İşlemleri dahil et. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
TagResource varlıklarından oluşan bir koleksiyonu listeler. |
|
Other Status Codes |
İş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
ApiManagementListApiOperationsByTags
Örnek isteği
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/operationsByTags?api-version=2022-08-01
Örnek yanıt
{
"value": [
{
"tag": {
"id": "/tags/apitag123",
"name": "awesomeTag"
},
"operation": {
"id": "/apis/echo-api/operations/create-resource",
"apiName": "Echo API",
"apiRevision": "1",
"name": "Create resource",
"method": "POST",
"urlTemplate": "/resource",
"description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend."
}
}
],
"count": 1
}
Tanımlar
Name | Description |
---|---|
Api |
API iletişim bilgileri |
Api |
API lisans bilgileri |
Api |
Etiket Kaynakları için API sözleşmesi özellikleri. |
Api |
API türü. |
Authentication |
API Kimlik Doğrulama Ayarları. |
bearer |
Sunucuya belirteç gönderme. |
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
OAuth2Authentication |
API OAuth2 Kimlik Doğrulama ayarları ayrıntıları. |
Open |
API OAuth2 Kimlik Doğrulama ayarları ayrıntıları. |
Operation |
İşlem Varlığı sözleşmesi Özellikleri. |
Product |
ü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ı. |
Product |
Ürün profili. |
Protocol |
Bu API'deki işlemlerin hangi protokollerin çağrılabileceğini açıklar. |
Subscription |
Abonelik anahtarı parametre adları ayrıntıları. |
Tag |
Sayfalanmış Etiket listesi gösterimi. |
Tag |
TagResource sözleşme özellikleri. |
Tag |
Etiket Kaynağı Sözleşmesi'nde Tag özelliğini tanımlayan sözleşme |
ApiContactInformation
API iletişim bilgileri
Name | Tür | Description |
---|---|---|
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 |
Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu. |
|
contact |
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 |
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 |
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 |
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 |
OAuth2 Kimlik Doğrulama ayarları |
|
oAuth2AuthenticationSettings |
Bu API'ye dahil edilen OAuth2 kimlik doğrulama ayarlarının koleksiyonu. |
|
openid |
OpenID Connect Kimlik Doğrulama Ayarları |
|
openidAuthenticationSettings |
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 |
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ğrulama 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ğrulama ayarları ayrıntıları.
Name | Tür | Description |
---|---|---|
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 |
ü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 |
Sayfa değerleri. |
TagResourceContract
TagResource sözleşme özellikleri.
Name | Tür | Description |
---|---|---|
api |
Etiketle ilişkili API. |
|
operation |
etiketle ilişkili işlem. |
|
product |
Etiketle ilişkili ürün. |
|
tag |
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ı |