Apis - Get

Başvuru

Hizmet:: API Management

API Sürümü:: 2022-08-01

Tanımlayıcısı tarafından belirtilen API'nin ayrıntılarını alır.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?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. Normal ifade deseni: `^[^*#&+:<>?]+$`
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ı. Normal ifade deseni: `^[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	ApiContract	Yanıt gövdesi belirtilen API varlığını içerir. Üst Bilgiler ETag: string
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Name

Tür

Description

200 OK

ApiContract

Yanıt gövdesi belirtilen API varlığını içerir.

Üst Bilgiler

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.

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

ApiManagementGetApiContract

ApiManagementGetApiRevisionContract

ApiManagementGetApiContract

Örnek isteği

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

/** Samples for Api Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiContract.json
     */
    /**
     * Sample code: ApiManagementGetApiContract.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetApiContract(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apis()
            .getWithResponse("rg1", "apimService1", "57d1f7558aa04f15146d9d8a", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_get_api_contract.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.api.get(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="57d1f7558aa04f15146d9d8a",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiContract.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiContract.json
func ExampleAPIClient_Get_apiManagementGetApiContract() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAPIClient().Get(ctx, "rg1", "apimService1", "57d1f7558aa04f15146d9d8a", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.APIContract = armapimanagement.APIContract{
	// 	Name: to.Ptr("57d1f7558aa04f15146d9d8a"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/apis"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a"),
	// 	Properties: &armapimanagement.APIContractProperties{
	// 		APIType: to.Ptr(armapimanagement.APITypeSoap),
	// 		APIRevision: to.Ptr("1"),
	// 		AuthenticationSettings: &armapimanagement.AuthenticationSettingsContract{
	// 			OAuth2: &armapimanagement.OAuth2AuthenticationSettingsContract{
	// 				AuthorizationServerID: to.Ptr("authorizationServerId2283"),
	// 				Scope: to.Ptr("oauth2scope2580"),
	// 			},
	// 			OAuth2AuthenticationSettings: []*armapimanagement.OAuth2AuthenticationSettingsContract{
	// 				{
	// 					AuthorizationServerID: to.Ptr("authorizationServerId2283"),
	// 					Scope: to.Ptr("oauth2scope2580"),
	// 				},
	// 				{
	// 					AuthorizationServerID: to.Ptr("authorizationServerId2284"),
	// 					Scope: to.Ptr("oauth2scope2581"),
	// 			}},
	// 		},
	// 		IsCurrent: to.Ptr(true),
	// 		IsOnline: to.Ptr(true),
	// 		SubscriptionKeyParameterNames: &armapimanagement.SubscriptionKeyParameterNamesContract{
	// 			Header: to.Ptr("Ocp-Apim-Subscription-Key"),
	// 			Query: to.Ptr("subscription-key"),
	// 		},
	// 		Path: to.Ptr("schulte"),
	// 		DisplayName: to.Ptr("Service"),
	// 		Protocols: []*armapimanagement.Protocol{
	// 			to.Ptr(armapimanagement.ProtocolHTTPS)},
	// 			ServiceURL: to.Ptr("https://api.plexonline.com/DataSource/Service.asmx"),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the details of the API specified by its identifier.
 *
 * @summary Gets the details of the API specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiContract.json
 */
async function apiManagementGetApiContract() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "57d1f7558aa04f15146d9d8a";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.api.get(resourceGroupName, serviceName, apiId);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Örnek yanıt

Durum kodu:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "displayName": "Service",
    "apiRevision": "1",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        },
        {
          "authorizationServerId": "authorizationServerId2284",
          "scope": "oauth2scope2581"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "type": "soap",
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementGetApiRevisionContract

Örnek isteği

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3?api-version=2022-08-01

/** Samples for Api Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiRevision.json
     */
    /**
     * Sample code: ApiManagementGetApiRevisionContract.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetApiRevisionContract(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apis().getWithResponse("rg1", "apimService1", "echo-api;rev=3", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_get_api_revision.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.api.get(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="echo-api;rev=3",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiRevision.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiRevision.json
func ExampleAPIClient_Get_apiManagementGetApiRevisionContract() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAPIClient().Get(ctx, "rg1", "apimService1", "echo-api;rev=3", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.APIContract = armapimanagement.APIContract{
	// 	Name: to.Ptr("echo-api;rev=3"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/apis"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3"),
	// 	Properties: &armapimanagement.APIContractProperties{
	// 		APIRevision: to.Ptr("3"),
	// 		APIRevisionDescription: to.Ptr("fixed bug in contract"),
	// 		AuthenticationSettings: &armapimanagement.AuthenticationSettingsContract{
	// 			OAuth2: &armapimanagement.OAuth2AuthenticationSettingsContract{
	// 				AuthorizationServerID: to.Ptr("authorizationServerId2283"),
	// 				Scope: to.Ptr("oauth2scope2580"),
	// 			},
	// 			OAuth2AuthenticationSettings: []*armapimanagement.OAuth2AuthenticationSettingsContract{
	// 				{
	// 					AuthorizationServerID: to.Ptr("authorizationServerId2283"),
	// 					Scope: to.Ptr("oauth2scope2580"),
	// 				},
	// 				{
	// 					AuthorizationServerID: to.Ptr("authorizationServerId2284"),
	// 					Scope: to.Ptr("oauth2scope2581"),
	// 			}},
	// 		},
	// 		SubscriptionKeyParameterNames: &armapimanagement.SubscriptionKeyParameterNamesContract{
	// 			Header: to.Ptr("Ocp-Apim-Subscription-Key"),
	// 			Query: to.Ptr("subscription-key"),
	// 		},
	// 		Path: to.Ptr("schulte"),
	// 		DisplayName: to.Ptr("Service"),
	// 		Protocols: []*armapimanagement.Protocol{
	// 			to.Ptr(armapimanagement.ProtocolHTTPS)},
	// 			ServiceURL: to.Ptr("https://api.plexonline.com/DataSource/Service.asmx"),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the details of the API specified by its identifier.
 *
 * @summary Gets the details of the API specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiRevision.json
 */
async function apiManagementGetApiRevisionContract() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "echo-api;rev=3";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.api.get(resourceGroupName, serviceName, apiId);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Örnek yanıt

Durum kodu:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echo-api;rev=3",
  "properties": {
    "displayName": "Service",
    "apiRevision": "3",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        },
        {
          "authorizationServerId": "authorizationServerId2284",
          "scope": "oauth2scope2581"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "fixed bug in contract"
  }
}

Tanımlar

Name	Description
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ğrulama Ayarları.
bearerTokenSendingMethods	Sunucuya belirteç gönderme.
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.
OAuth2AuthenticationSettingsContract	API OAuth2 Kimlik Doğrulama ayarları ayrıntıları.
OpenIdAuthenticationSettingsContract	API OAuth2 Kimlik Doğrulama ayarları ayrıntıları.
Protocol	Bu API'deki işlemlerin hangi protokollerin çağrılabileceğini açıklar.
SubscriptionKeyParameterNamesContract	Abonelik anahtarı parametre adları ayrıntıları.
versioningScheme	API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer.

ApiContactInformation

API iletişim bilgileri

Name	Tür	Description
email	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

ApiContract

API 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.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	ApiVersionSetContractDetails	Sürüm kümesi ayrıntıları
properties.apiVersionSetId	string	İlgili ApiVersionSet için kaynak tanımlayıcısı.
properties.authenticationSettings	AuthenticationSettingsContract	Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu.
properties.contact	ApiContactInformation	API için iletişim bilgileri.
properties.description	string	API'nin açıklaması. HTML biçimlendirme etiketlerini 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	ApiLicenseInformation	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ç noktası temel URL'sine eklenir.
properties.protocols	Protocol[]	Bu API'deki işlemlerin hangi protokollerin ç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	SubscriptionKeyParameterNamesContract	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	ApiType	API türü.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

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

ApiType

API türü.

Name	Tür	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	Tür	Description
description	string	API Sürüm Kümesi 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 `header`API Sürümünü gösteren HTTP üst bilgi parametresinin adı.
versionQueryName	string	VersioningScheme olarak ayarlandıysa `query`API Sürümünü gösteren sorgu parametresinin adı.
versioningScheme	versioningScheme	API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer.

AuthenticationSettingsContract

API Kimlik Doğrulama Ayarları.

Name	Tür	Description
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 Kimlik Doğrulama ayarları
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Bu API'ye dahil edilen OAuth2 kimlik doğrulama ayarlarının koleksiyonu.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect Kimlik Doğrulama Ayarları
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	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	ErrorFieldContract[]	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	bearerTokenSendingMethods[]	Sunucuya belirteç gönderme.
openidProviderId	string	OAuth yetkilendirme sunucusu tanımlayıcısı.

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

versioningScheme

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

Name	Tür	Description
Header	string	API Sürümü bir HTTP üst bilgisinde geçirilir.
Query	string	API Sürümü bir sorgu parametresinde geçirilir.
Segment	string	API Sürümü bir yol kesiminde geçirilir.

Aracılığıyla paylaş

Apis - Get

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

ApiManagementGetApiContract

Örnek isteği

Örnek yanıt

ApiManagementGetApiRevisionContract

Örnek isteği

Örnek yanıt

Tanımlar

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorFieldContract

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme

Ek kaynaklar