Api Operation - Get

  • Başvuru
Service:
API Management
API Version:
2022-08-01

Tanımlayıcısı tarafından belirtilen API İşleminin ayrıntılarını alır.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
apiId
 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: ^[^*#&+:<>?]+$
operationId
 path True

string

API içindeki işlem tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
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ü.

Yanıtlar

Name Tür Description
200 OK

OperationContract

Yanıt gövdesi belirtilen İşlem varlığını içerir.

Headers

ETag: string
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

ApiManagementGetApiOperation
ApiManagementGetApiOperationPetStore

ApiManagementGetApiOperation

Sample Request

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

Sample Response

Status code:
200 
{
  "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",
    "templateParameters": [],
    "request": {
      "description": "IFazioService_CancelOrder_InputMessage",
      "queryParameters": [],
      "headers": [],
      "representations": [
        {
          "contentType": "text/xml",
          "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8",
          "typeName": "CancelOrder"
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "IFazioService_CancelOrder_OutputMessage",
        "representations": [
          {
            "contentType": "text/xml",
            "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8",
            "typeName": "CancelOrderResponse"
          }
        ],
        "headers": []
      }
    ]
  }
}

ApiManagementGetApiOperationPetStore

Sample Request

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/swagger-petstore/operations/loginUser",
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "name": "loginUser",
  "properties": {
    "displayName": "Logs user into the system",
    "method": "GET",
    "urlTemplate": "/user/login?username={username}&password={password}",
    "templateParameters": [
      {
        "name": "username",
        "description": "The user name for login",
        "type": "string",
        "required": true,
        "values": []
      },
      {
        "name": "password",
        "description": "The password for login in clear text",
        "type": "string",
        "required": true,
        "values": []
      }
    ],
    "description": "",
    "request": {
      "queryParameters": [],
      "headers": [],
      "representations": []
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "successful operation",
        "representations": [
          {
            "contentType": "application/xml",
            "schemaId": "5ba91a35f373b513a0bf31c6",
            "typeName": "UserLoginGet200ApplicationXmlResponse"
          },
          {
            "contentType": "application/json",
            "schemaId": "5ba91a35f373b513a0bf31c6",
            "typeName": "UserLoginGet200ApplicationJsonResponse"
          }
        ],
        "headers": [
          {
            "name": "X-Rate-Limit",
            "description": "calls per hour allowed by the user",
            "type": "integer",
            "values": []
          },
          {
            "name": "X-Expires-After",
            "description": "date in UTC when token expires",
            "type": "string",
            "values": []
          }
        ]
      },
      {
        "statusCode": 400,
        "description": "Invalid username/password supplied",
        "representations": [
          {
            "contentType": "application/xml"
          },
          {
            "contentType": "application/json"
          }
        ],
        "headers": []
      }
    ]
  }
}

Tanımlar

Name Description
ErrorFieldContract

Hata Alanı sözleşmesi.
ErrorResponse

Hata Yanıtı.
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ı.

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.

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 etiketlerini 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

RequestContract

İstek ayrıntılarını içeren varlık.
properties.responses

ResponseContract[]

İşlem yanıtları dizisi.
properties.templateParameters

ParameterContract[]

URL şablonu parametreleri koleksiyonu.
properties.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}
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,  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

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,  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

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

Name Tür Description
description

string

İşlem isteği açıklaması.
headers

ParameterContract[]

İşlem isteği üst bilgilerinin koleksiyonu.
queryParameters

ParameterContract[]

İşlem isteği sorgu parametrelerinin koleksiyonu.
representations

RepresentationContract[]

İş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

ParameterContract[]

İşlem yanıtı üst bilgileri koleksiyonu.
representations

RepresentationContract[]

İşlem yanıtı gösterimlerinin koleksiyonu.
statusCode

integer

İşlem yanıtı HTTP durum kodu.