Api Operation - List By Api

Hizmet:: API Management

API Sürümü:: 2024-05-01

Belirtilen API için işlem koleksiyonunu listeler.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?api-version=2024-05-01

İsteğe bağlı parametrelerle:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?$filter={$filter}&$top={$top}&$skip={$skip}&tags={tags}&api-version=2024-05-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management hizmetinin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	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 \| \| yöntem \| filtre \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| açıklama \| filtre \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| urlTemplate \| filtre \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer (int32) minimum: 0	Atlana kayıt sayısı.
$top	query		integer (int32) minimum: 1	Döndürülecek kayıt sayısı.
tags	query		string	Yanıta etiket ekleyin.

Yanıtlar

Name	Tür	Description
200 OK	OperationCollection	API düzeyinde işlem özeti varlıkları koleksiyonu.
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 Akışı.

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

ApiManagementListApiOperations

Örnek isteği

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations?api-version=2024-05-01

Örnek yanıt

Durum kodu:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cdc",
      "properties": {
        "displayName": "CancelOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cda",
      "properties": {
        "displayName": "GetMostRecentOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cd9",
      "properties": {
        "displayName": "GetOpenOrders",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cdb",
      "properties": {
        "displayName": "GetOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cd8",
      "properties": {
        "displayName": "submitOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder"
      }
    }
  ],
  "count": 5,
  "nextLink": ""
}

Tanımlar

Name	Description
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
OperationCollection	Disk Belleği İşlem listesi gösterimi.
OperationContract	API İşlem ayrıntıları.
ParameterContract	İşlem parametreleri ayrıntıları.
ParameterExampleContract	Parametre örneği.
RepresentationContract	İşlem isteği/yanıt gösterimi ayrıntıları.
RequestContract	İşlem isteği ayrıntıları.
ResponseContract	İşlem yanıtı ayrıntıları.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

OperationCollection

Object

Disk Belleği İşlem listesi gösterimi.

Name	Tür	Description
count	integer (int64)	Tüm sayfalardaki toplam kayıt sayısı.
nextLink	string	Varsa sonraki sayfa bağlantısı.
value	OperationContract[]	Sayfa değerleri.

OperationContract

Object

API İşlem ayrıntıları.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.description	string maxLength: 1000	İşlemin açıklaması. HTML biçimlendirme etiketleri içerebilir.
properties.displayName	string minLength: 1 maxLength: 300	İşlem Adı.
properties.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.
properties.policies	string	İşlem İlkeleri
properties.request	RequestContract	İstek ayrıntılarını içeren bir varlık.
properties.responses	ResponseContract[]	İşlem yanıtları dizisi.
properties.templateParameters	ParameterContract[]	URL şablonu parametrelerinin koleksiyonu.
properties.urlTemplate	string minLength: 1 maxLength: 1000	Bu işlem için hedef kaynağı tanımlayan göreli URL şablonu. Parametreleri içerebilir. Örnek: /customers/{cid}/orders/{oid}/?date={date}
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

ParameterContract

Object

İşlem parametreleri ayrıntıları.

Name	Tür	Description
defaultValue	string	Varsayılan parametre değeri.
description	string	Parametre açıklaması.
examples	<string, ParameterExampleContract>	Parametresi için tanımlanan örnek.
name	string	Parametre adı.
required	boolean	Parametrenin gerekli olup olmadığını belirtir.
schemaId	string	Şema tanımlayıcısı.
type	string	Parametre türü.
typeName	string	Şema tarafından tanımlanan tür adı.
values	string[]	Parametre değerleri.

ParameterExampleContract

Object

Parametre örneği.

Name	Tür	Description
description	string	Örnek için uzun açıklama
externalValue	string	Değişmez değer örneğine işaret eden BIR URL
summary	string	Örnek için kısa açıklama
value		Örnek değer. İlkel bir değer veya nesne olabilir.

RepresentationContract

Object

İşlem isteği/yanıt gösterimi ayrıntıları.

Name	Tür	Description
contentType	string	Bu gösterim için kayıtlı veya özel içerik türünü belirtir; örneğin, uygulama/xml.
examples	<string, ParameterExampleContract>	Gösterim için tanımlanan örnek.
formParameters	ParameterContract[]	Form parametreleri koleksiyonu. 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' ise gereklidir...
schemaId	string	Şema tanımlayıcısı. Yalnızca 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' değilse geçerlidir.
typeName	string	Şema tarafından tanımlanan tür adı. Yalnızca 'contentType' değeri 'application/x-www-form-urlencoded' veya 'multipart/form-data' değilse geçerlidir.

RequestContract

Object

İşlem isteği ayrıntıları.

Name	Tür	Description
description	string	İşlem isteği açıklaması.
headers	ParameterContract[]	İşlem isteği üst bilgileri koleksiyonu.
queryParameters	ParameterContract[]	İşlem isteği sorgu parametrelerinin koleksiyonu.
representations	RepresentationContract[]	İşlem isteği gösterimlerinin koleksiyonu.

ResponseContract

Object

İşlem yanıtı ayrıntıları.

Name	Tür	Description
description	string	İşlem yanıtı açıklaması.
headers	ParameterContract[]	İşlem yanıtı üst bilgileri koleksiyonu.
representations	RepresentationContract[]	İşlem yanıtı gösterimlerinin koleksiyonu.
statusCode	integer (int32)	İşlem yanıtı HTTP durum kodu.