Product Api - List By Product

Bir ürünle ilişkili API koleksiyonunu listeler.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis?api-version=2021-12-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-12-01-preview

URI Parametreleri

Name In Required Type Description
productId
path True
  • string

Ürün tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

resourceGroupName
path True
  • string

Kaynak grubunun adı.

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

Microsoft Azure aboneliği benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.

api-version
query True
  • string

İstemci isteğiyle 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 |
| 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 |
| yol | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query
  • integer
int32

Atacak kayıt sayısı.

$top
query
  • integer
int32

Döndürülecek kayıt sayısı.

Yanıtlar

Name Type Description
200 OK

Yanıt gövdesi, üründeki Api varlıklarından oluşan bir koleksiyon içerir.

Other Status Codes

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

OAuth2 Flow Azure Active Directory.

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

ApiManagementListProductApis

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis?api-version=2021-12-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca",
      "type": "Microsoft.ApiManagement/service/products/apis",
      "name": "57681820a40f7eb6c49f6aca",
      "properties": {
        "displayName": "api_57681820a40f7eb6c49f6acb",
        "apiRevision": "1",
        "description": "description_57681820a40f7eb6c49f6acc",
        "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd",
        "path": "suffix_57681820a40f7eb6c49f6ace",
        "protocols": [
          "https"
        ],
        "isCurrent": true
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Tanımlar

ApiCollection

Sayfalanmış API listesi gösterimi.

ApiContactInformation

API iletişim bilgileri

ApiContract

API ayrıntıları.

ApiLicenseInformation

API lisans bilgileri

ApiType

API türü.

ApiVersionSetContractDetails

API Sürüm Kümesi, ilgili API Sürümleri kümesi için ortak yapılandırmayı içerir

AuthenticationSettingsContract

API Kimlik Doğrulaması Ayarlar.

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ı.

SubscriptionKeyParameterNamesContract

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

ApiCollection

Sayfalanmış API listesi gösterimi.

Name Type Description
count
  • integer

Tüm sayfalardaki toplam kayıt sayısı.

nextLink
  • string

Varsa sonraki sayfa bağlantısı.

value

Sayfa değerleri.

ApiContactInformation

API iletişim bilgileri

Name Type Description
email
  • string

İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde OLMALI

name
  • string

İlgili kişinin/kuruluşun tanımlayıcı adı

url
  • string

Kişi bilgilerini gösteren URL. URL biçiminde olmalıdır

ApiContract

API ayrıntıları.

Name Type Description
id
  • string

Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Kaynağın adı

properties.apiRevision
  • string

API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur

properties.apiRevisionDescription
  • string

API Düzeltmesi'nin açıklaması.

properties.apiVersion
  • string

API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir

properties.apiVersionDescription
  • string

API Sürümünün açıklaması.

properties.apiVersionSet

Sürüm kümesi ayrıntıları

properties.apiVersionSetId
  • string

İlgili ApiVersionSet için kaynak tanımlayıcısı.

properties.authenticationSettings

Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu.

properties.contact

API için iletişim bilgileri.

properties.description
  • string

API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir.

properties.displayName
  • string

API adı. 1 ile 300 karakter uzunluğunda olmalıdır.

properties.isCurrent
  • boolean

API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir.

properties.isOnline
  • boolean

API düzeltmesine ağ geçidi üzerinden erişilip erişilmediğini gösterir.

properties.license

API için lisans bilgileri.

properties.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ç nokta temel URL'sine eklenir.

properties.protocols
  • string[]

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

properties.serviceUrl
  • string

Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz.

properties.sourceApiId
  • string

Kaynak API'nin API tanımlayıcısı.

properties.subscriptionKeyParameterNames

API'nin kullanılabilir hale getirildiği protokoller.

properties.subscriptionRequired
  • boolean

API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir.

properties.termsOfServiceUrl
  • string

API için Hizmet Koşulları'nın URL'si. URL biçiminde olmalıdır.

properties.type

API türü.

type
  • string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft. Depolama/storageAccounts"

ApiLicenseInformation

API lisans bilgileri

Name Type 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

ApiType

API türü.

Name Type Description
graphql
  • string
http
  • string
soap
  • string
websocket
  • string

ApiVersionSetContractDetails

API Sürüm Kümesi, ilgili API Sürümleri kümesi için ortak yapılandırmayı içerir

Name Type Description
description
  • string

API Sürüm Kümesi'nin açıklaması.

id
  • string

Mevcut API Sürüm Kümesi tanımlayıcısı. Yeni bir Sürüm Kümesi oluşturmak için bu değeri atla.

name
  • string

API Sürüm Kümesinin görünen Adı.

versionHeaderName
  • string

versioningScheme olarak ayarlandıysa headerAPI Sürümünü gösteren HTTP üst bilgi parametresinin adı.

versionQueryName
  • string

versioningScheme olarak ayarlandıysa queryAPI Sürümünü gösteren sorgu parametresinin adı.

versioningScheme enum:
  • Header
  • Query
  • Segment

API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer.

AuthenticationSettingsContract

API Kimlik Doğrulaması Ayarlar.

Name Type Description
oAuth2

OAuth2 Kimlik Doğrulama ayarları

openid

OpenID Bağlan Kimlik Doğrulaması Ayarlar

ErrorFieldContract

Hata Alanı sözleşmesi.

Name Type 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 Type 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.

OAuth2AuthenticationSettingsContract

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

Name Type 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 Type Description
bearerTokenSendingMethods
  • string[]

Sunucuya belirteç gönderme.

openidProviderId
  • string

OAuth yetkilendirme sunucusu tanımlayıcısı.

SubscriptionKeyParameterNamesContract

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

Name Type Description
header
  • string

Abonelik anahtarı üst bilgi adı.

query
  • string

Abonelik anahtarı sorgu dizesi parametre adı.