Api Operation - List By Api
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=2022-08-01
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=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. Regex pattern: |
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ı. Regex pattern: |
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 |
Atacak kayıt sayısı. |
|
$top
|
query |
integer int32 |
Döndürülecek kayıt sayısı. |
|
tags
|
query |
string |
Yanıta etiket ekleyin. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
API düzeyinde işlem özeti varlıkları koleksiyonu. |
|
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.
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
ApiManagementListApiOperations
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations?api-version=2022-08-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/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/subid/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/subid/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/subid/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/subid/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 |
---|---|
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Operation |
Sayfalanmış İşlem listesi gösterimi. |
Operation |
API İşlem ayrıntıları. |
Parameter |
İşlem parametreleri ayrıntıları. |
Parameter |
Parametre örneği. |
Representation |
İşlem isteği/yanıt gösterimi ayrıntıları. |
Request |
İşlem isteği ayrıntıları. |
Response |
İşlem yanıtı ayrıntıları. |
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 okunabilir gösterimi. |
OperationCollection
Sayfalanmış İşlem 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. |
OperationContract
API İşlem 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.description |
string |
İşlemin açıklaması. HTML biçimlendirme etiketleri içerebilir. |
properties.displayName |
string |
İş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 |
İstek ayrıntılarını içeren varlık. |
|
properties.responses |
İşlem yanıtları dizisi. |
|
properties.templateParameters |
URL şablonu parametreleri koleksiyonu. |
|
properties.urlTemplate |
string |
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
İşlem parametreleri ayrıntıları.
Name | Tür | Description |
---|---|---|
defaultValue |
string |
Varsayılan parametre değeri. |
description |
string |
Parametre açıklaması. |
examples |
<string,
Parameter |
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
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
İş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,
Parameter |
Gösterim için tanımlanan örnek. |
formParameters |
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
İşlem isteği ayrıntıları.
Name | Tür | Description |
---|---|---|
description |
string |
İşlem isteği açıklaması. |
headers |
İşlem isteği üst bilgileri koleksiyonu. |
|
queryParameters |
İşlem isteği sorgu parametrelerinin toplanması. |
|
representations |
İşlem isteği gösterimleri koleksiyonu. |
ResponseContract
İşlem yanıtı ayrıntıları.
Name | Tür | Description |
---|---|---|
description |
string |
İşlem yanıtı açıklaması. |
headers |
İşlem yanıtı üst bilgileri koleksiyonu. |
|
representations |
İşlem yanıtı gösterimleri koleksiyonu. |
|
statusCode |
integer |
İşlem yanıtı HTTP durum kodu. |