Microsoft.ApiManagement hizmeti/çalışma alanları/apis 2023-03-01-preview
Bicep kaynak tanımı
Hizmet/çalışma alanları/apis kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları - Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/workspaces/apis kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis@2023-03-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
apiRevision: 'string'
apiRevisionDescription: 'string'
apiType: 'string'
apiVersion: 'string'
apiVersionDescription: 'string'
apiVersionSet: {
description: 'string'
id: 'string'
name: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
apiVersionSetId: 'string'
authenticationSettings: {
oAuth2: {
authorizationServerId: 'string'
scope: 'string'
}
oAuth2AuthenticationSettings: [
{
authorizationServerId: 'string'
scope: 'string'
}
]
openid: {
bearerTokenSendingMethods: [
'string'
]
openidProviderId: 'string'
}
openidAuthenticationSettings: [
{
bearerTokenSendingMethods: [
'string'
]
openidProviderId: 'string'
}
]
}
contact: {
email: 'string'
name: 'string'
url: 'string'
}
description: 'string'
displayName: 'string'
format: 'string'
isCurrent: bool
license: {
name: 'string'
url: 'string'
}
path: 'string'
protocols: [
'string'
]
serviceUrl: 'string'
sourceApiId: 'string'
subscriptionKeyParameterNames: {
header: 'string'
query: 'string'
}
subscriptionRequired: bool
termsOfServiceUrl: 'string'
translateRequiredQueryParameters: 'string'
type: 'string'
value: 'string'
wsdlSelector: {
wsdlEndpointName: 'string'
wsdlServiceName: 'string'
}
}
}
Özellik değerleri
hizmet/çalışma alanları/api'ler
Ad | Açıklama | Değer |
---|---|---|
name | Kaynak adı Bicep'te alt kaynaklar için adları ve türleri ayarlamayı öğrenin. |
dize (gerekli) |
Üst | Bicep'te bir alt kaynağın üst kaynağını belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir. Daha fazla bilgi için bkz . Üst kaynağın dışındaki alt kaynak. |
Kaynak türü için sembolik ad: çalışma alanları |
properties | Güncelleştirme özelliklerinin API varlığı oluşturma. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Ad | Açıklama | Değer |
---|---|---|
apiRevision | API'nin düzeltmesini açıklar. Değer sağlanmazsa varsayılan düzeltme 1 oluşturulur | string |
apiRevisionDescription | API Düzeltmesi'nin açıklaması. | string |
apiType | Oluşturulacak API türü. * http REST API oluşturur* soap SOAP geçiş API'si oluşturur* websocket websocket API'si oluşturur* graphql GraphQL API'si oluşturur. Gelecekte yeni türler eklenebilir. |
'graphql' 'http' 'odata' 'soap' 'websocket' |
apiVersion | API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir | string |
apiVersionDescription | API Sürümünün Açıklaması. | string |
apiVersionSet | Sürüm kümesi ayrıntıları | ApiVersionSetContractDetails |
apiVersionSetId | İlgili ApiVersionSet için kaynak tanımlayıcısı. | string |
authenticationSettings | Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu. | AuthenticationSettingsContract |
kişi | API için iletişim bilgileri. | ApiContactInformation |
açıklama | API'nin açıklaması. HTML biçimlendirme etiketlerini içerebilir. | string |
displayName | API adı. 1 ile 300 karakter uzunluğunda olmalıdır. | string |
biçim | API'nin içeri aktarıldığı İçeriğin biçimi. Gelecekte yeni biçimler eklenebilir | 'graphql-link' 'odata' 'odata-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
ıscurrent | API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir. | bool |
lisans | API için lisans bilgileri. | ApiLicenseInformation |
path | 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. | dize (gerekli) |
Protokol | Bu API'deki işlemlerin hangi protokollerin çağrılabileceğini açıklar. | Herhangi birini içeren dize dizisi: 'http' 'https' 'ws' 'wss' |
serviceUrl | Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz. | string |
sourceApiId | Kaynak API'nin API tanımlayıcısı. | string |
subscriptionKeyParameterNames | API'nin kullanılabilir hale getirildiği protokoller. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir. | bool |
termsOfServiceUrl | API için Hizmet Koşulları'nın URL'si. URL biçiminde OLMALıDıR. | string |
translateRequiredQueryParameters | Gerekli sorgu parametrelerini şablon parametrelerine çevirme stratejisi. Varsayılan olarak 'template' değerine sahiptir. Olası değerler: 'template', 'query' | 'query' 'şablon' |
tür | API türü. | 'graphql' 'http' 'odata' 'soap' 'websocket' |
değer | API içeri aktarılırken içerik değeri. | string |
wsdlSelector | WSDL'nin içeri aktarılmasını belgenin bir alt kümesiyle sınırlama ölçütleri. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
Ad | Açıklama | Değer |
---|---|---|
açıklama | API Sürüm Kümesi açıklaması. | string |
kimlik | 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. | string |
name | API Sürüm Kümesinin görünen Adı. | string |
versionHeaderName | VersioningScheme olarak ayarlandıysa header API Sürümünü gösteren HTTP üst bilgi parametresinin adı. |
string |
versioningScheme | API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer. | 'Üst Bilgi' 'Sorgu' 'Segment' |
versionQueryName | VersioningScheme olarak ayarlandıysa query API Sürümünü gösteren sorgu parametresinin adı. |
string |
AuthenticationSettingsContract
Ad | Açıklama | Değer |
---|---|---|
oAuth2 | OAuth2 Kimlik Doğrulama ayarları | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Bu API'ye dahil edilen OAuth2 kimlik doğrulama ayarlarının koleksiyonu. | OAuth2AuthenticationSettingsContract[] |
Openıd | OpenID Connect Kimlik Doğrulama Ayarları | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Bu API'ye dahil edilen Open ID Connect kimlik doğrulama ayarlarının koleksiyonu. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Ad | Açıklama | Değer |
---|---|---|
authorizationServerId | OAuth yetkilendirme sunucusu tanımlayıcısı. | string |
scope | işlem kapsamı. | string |
OpenIdAuthenticationSettingsContract
Ad | Açıklama | Değer |
---|---|---|
bearerTokenSendingMethods | Sunucuya belirteç gönderme. | Herhangi birini içeren dize dizisi: 'authorizationHeader' 'query' |
openidProviderId | OAuth yetkilendirme sunucusu tanımlayıcısı. | string |
ApiContactInformation
Ad | Açıklama | Değer |
---|---|---|
e-posta | İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde OLMALI | string |
name | İlgili kişinin/kuruluşun tanımlayıcı adı | string |
url | Kişi bilgilerini gösteren URL. URL biçiminde olmalıdır | string |
ApiLicenseInformation
Ad | Açıklama | Değer |
---|---|---|
name | API için kullanılan lisans adı | string |
url | API için kullanılan lisansın URL'si. URL biçiminde olmalıdır | string |
SubscriptionKeyParameterNamesContract
Ad | Açıklama | Değer |
---|---|---|
üst bilgi | Abonelik anahtarı üst bilgi adı. | string |
query | Abonelik anahtarı sorgu dizesi parametre adı. | string |
ApiCreateOrUpdatePropertiesWsdlSelector
Ad | Açıklama | Değer |
---|---|---|
wsdlEndpointName | WSDL'den içeri aktarılacağınız uç noktanın (bağlantı noktası) adı | string |
wsdlServiceName | WSDL'den içeri aktaracak hizmetin adı | string |
ARM şablonu kaynak tanımı
Hizmet/çalışma alanları/apis kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları - Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/workspaces/apis kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.
{
"type": "Microsoft.ApiManagement/service/workspaces/apis",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"apiRevision": "string",
"apiRevisionDescription": "string",
"apiType": "string",
"apiVersion": "string",
"apiVersionDescription": "string",
"apiVersionSet": {
"description": "string",
"id": "string",
"name": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
},
"apiVersionSetId": "string",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "string",
"scope": "string"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "string",
"scope": "string"
}
],
"openid": {
"bearerTokenSendingMethods": [ "string" ],
"openidProviderId": "string"
},
"openidAuthenticationSettings": [
{
"bearerTokenSendingMethods": [ "string" ],
"openidProviderId": "string"
}
]
},
"contact": {
"email": "string",
"name": "string",
"url": "string"
},
"description": "string",
"displayName": "string",
"format": "string",
"isCurrent": "bool",
"license": {
"name": "string",
"url": "string"
},
"path": "string",
"protocols": [ "string" ],
"serviceUrl": "string",
"sourceApiId": "string",
"subscriptionKeyParameterNames": {
"header": "string",
"query": "string"
},
"subscriptionRequired": "bool",
"termsOfServiceUrl": "string",
"translateRequiredQueryParameters": "string",
"type": "string",
"value": "string",
"wsdlSelector": {
"wsdlEndpointName": "string",
"wsdlServiceName": "string"
}
}
}
Özellik değerleri
hizmet/çalışma alanları/api'ler
Ad | Açıklama | Değer |
---|---|---|
tür | Kaynak türü | 'Microsoft.ApiManagement/service/workspaces/apis' |
apiVersion | Kaynak API'sinin sürümü | '2023-03-01-preview' |
name | Kaynak adı JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlamayı öğrenin. |
dize (gerekli) |
properties | Güncelleştirme özelliklerinin API varlığı oluşturma. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Ad | Açıklama | Değer |
---|---|---|
apiRevision | API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur | string |
apiRevisionDescription | API Düzeltmesi'nin açıklaması. | string |
apiType | Oluşturulacak API türü. * http REST API oluşturur* soap SOAP doğrudan API'sini oluşturur* websocket websocket API'si oluşturur* graphql GraphQL API'si oluşturur. Gelecekte yeni türler eklenebilir. |
'graphql' 'http' 'odata' 'sabun' 'websocket' |
apiVersion | API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir | string |
apiVersionDescription | API Sürümünün açıklaması. | string |
apiVersionSet | Sürüm kümesi ayrıntıları | ApiVersionSetContractDetails |
apiVersionSetId | İlgili ApiVersionSet için kaynak tanımlayıcısı. | string |
authenticationSettings | Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu. | AuthenticationSettingsContract |
kişi | API için iletişim bilgileri. | ApiContactInformation |
açıklama | API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir. | string |
displayName | API adı. 1 ile 300 karakter uzunluğunda olmalıdır. | string |
biçim | API'nin içeri aktarıldığı İçeriğin biçimi. Gelecekte yeni biçimler eklenebilir | 'graphql-link' 'odata' 'odata-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
ıscurrent | API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir. | bool |
lisans | API için lisans bilgileri. | ApiLicenseInformation |
path | 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. | dize (gerekli) |
Protokol | Bu API'deki işlemlerin hangi protokollerde çağrılabileceğini açıklar. | Herhangi birini içeren dize dizisi: 'http' 'https' 'ws' 'wss' |
serviceUrl | Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz. | string |
sourceApiId | Kaynak API'nin API tanımlayıcısı. | string |
subscriptionKeyParameterNames | API'nin kullanılabilir hale getirildiği protokoller. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir. | bool |
termsOfServiceUrl | API için Hizmet Koşulları'nın URL'si. URL biçiminde olmalıdır. | string |
translateRequiredQueryParameters | Gerekli sorgu parametrelerini şablon parametrelerine çevirme stratejisi. Varsayılan olarak 'template' değerine sahiptir. Olası değerler: 'template', 'query' | 'query' 'şablon' |
tür | API türü. | 'graphql' 'http' 'odata' 'sabun' 'websocket' |
değer | API içeri aktarılırken içerik değeri. | string |
wsdlSelector | WSDL'nin içeri aktarılmasını belgenin bir alt kümesiyle sınırlama ölçütleri. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
Ad | Açıklama | Değer |
---|---|---|
açıklama | API Sürüm Kümesi'nin açıklaması. | string |
kimlik | 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. | string |
name | API Sürüm Kümesinin görünen Adı. | string |
versionHeaderName | versioningScheme olarak ayarlandıysa header API Sürümünü gösteren HTTP üst bilgi parametresinin adı. |
string |
versioningScheme | API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer. | 'Üst Bilgi' 'Sorgu' 'Segment' |
versionQueryName | versioningScheme olarak ayarlandıysa query API Sürümünü gösteren sorgu parametresinin adı. |
string |
AuthenticationSettingsContract
Ad | Açıklama | Değer |
---|---|---|
oAuth2 | OAuth2 Kimlik Doğrulama ayarları | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Bu API'ye dahil edilen OAuth2 kimlik doğrulama ayarlarının koleksiyonu. | OAuth2AuthenticationSettingsContract[] |
Openıd | OpenID Connect Kimlik Doğrulama Ayarları | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Bu API'ye dahil edilen Open ID Connect kimlik doğrulama ayarlarının koleksiyonu. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Ad | Açıklama | Değer |
---|---|---|
authorizationServerId | OAuth yetkilendirme sunucusu tanımlayıcısı. | string |
scope | işlem kapsamı. | string |
OpenIdAuthenticationSettingsContract
Ad | Açıklama | Değer |
---|---|---|
bearerTokenSendingMethods | Sunucuya belirteç gönderme. | Herhangi birini içeren dize dizisi: 'authorizationHeader' 'query' |
openidProviderId | OAuth yetkilendirme sunucusu tanımlayıcısı. | string |
ApiContactInformation
Ad | Açıklama | Değer |
---|---|---|
e-posta | İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde OLMALI | string |
name | İlgili kişinin/kuruluşun tanımlayıcı adı | string |
url | Kişi bilgilerini gösteren URL. URL biçiminde olmalıdır | string |
ApiLicenseInformation
Ad | Açıklama | Değer |
---|---|---|
name | API için kullanılan lisans adı | string |
url | API için kullanılan lisansın URL'si. URL biçiminde olmalıdır | string |
SubscriptionKeyParameterNamesContract
Ad | Açıklama | Değer |
---|---|---|
üst bilgi | Abonelik anahtarı üst bilgi adı. | string |
query | Abonelik anahtarı sorgu dizesi parametre adı. | string |
ApiCreateOrUpdatePropertiesWsdlSelector
Ad | Açıklama | Değer |
---|---|---|
wsdlEndpointName | WSDL'den içeri aktarılacağınız uç noktanın (bağlantı noktası) adı | string |
wsdlServiceName | WSDL'den içeri aktaracak hizmetin adı | string |
Terraform (AzAPI sağlayıcısı) kaynak tanımı
Hizmet/çalışma alanları/apis kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/workspaces/apis kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apis@2023-03-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
apiRevision = "string"
apiRevisionDescription = "string"
apiType = "string"
apiVersion = "string"
apiVersionDescription = "string"
apiVersionSet = {
description = "string"
id = "string"
name = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
apiVersionSetId = "string"
authenticationSettings = {
oAuth2 = {
authorizationServerId = "string"
scope = "string"
}
oAuth2AuthenticationSettings = [
{
authorizationServerId = "string"
scope = "string"
}
]
openid = {
bearerTokenSendingMethods = [
"string"
]
openidProviderId = "string"
}
openidAuthenticationSettings = [
{
bearerTokenSendingMethods = [
"string"
]
openidProviderId = "string"
}
]
}
contact = {
email = "string"
name = "string"
url = "string"
}
description = "string"
displayName = "string"
format = "string"
isCurrent = bool
license = {
name = "string"
url = "string"
}
path = "string"
protocols = [
"string"
]
serviceUrl = "string"
sourceApiId = "string"
subscriptionKeyParameterNames = {
header = "string"
query = "string"
}
subscriptionRequired = bool
termsOfServiceUrl = "string"
translateRequiredQueryParameters = "string"
type = "string"
value = "string"
wsdlSelector = {
wsdlEndpointName = "string"
wsdlServiceName = "string"
}
}
})
}
Özellik değerleri
hizmet/çalışma alanları/api'ler
Ad | Açıklama | Değer |
---|---|---|
tür | Kaynak türü | "Microsoft.ApiManagement/service/workspaces/apis@2023-03-01-preview" |
name | Kaynak adı | dize (gerekli) |
parent_id | Bu kaynağın üst öğesi olan kaynağın kimliği. | Kaynak türü: çalışma alanları kimliği |
properties | Güncelleştirme özelliklerinin API varlığı oluşturma. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Ad | Açıklama | Değer |
---|---|---|
apiRevision | API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur | string |
apiRevisionDescription | API Düzeltmesi'nin açıklaması. | string |
apiType | Oluşturulacak API türü. * http REST API oluşturur* soap SOAP doğrudan API'sini oluşturur* websocket websocket API'si oluşturur* graphql GraphQL API'si oluşturur. Gelecekte yeni türler eklenebilir. |
"graphql" "http" "odata" "sabun" "websocket" |
apiVersion | API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir | string |
apiVersionDescription | API Sürümünün açıklaması. | string |
apiVersionSet | Sürüm kümesi ayrıntıları | ApiVersionSetContractDetails |
apiVersionSetId | İlgili ApiVersionSet için kaynak tanımlayıcısı. | string |
authenticationSettings | Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu. | AuthenticationSettingsContract |
kişi | API için iletişim bilgileri. | ApiContactInformation |
açıklama | API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir. | string |
displayName | API adı. 1 ile 300 karakter uzunluğunda olmalıdır. | string |
biçim | API'nin içeri aktarıldığı İçeriğin biçimi. Gelecekte yeni biçimler eklenebilir | "graphql-link" "odata" "odata-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link" |
ıscurrent | API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir. | bool |
lisans | API için lisans bilgileri. | ApiLicenseInformation |
path | 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. | dize (gerekli) |
Protokol | Bu API'deki işlemlerin hangi protokollerde çağrılabileceğini açıklar. | Herhangi birini içeren dize dizisi: "http" "https" "ws" "wss" |
serviceUrl | Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz. | string |
sourceApiId | Kaynak API'nin API tanımlayıcısı. | string |
subscriptionKeyParameterNames | API'nin kullanılabilir hale getirildiği protokoller. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | API'ye erişmek için bir API'nin mi yoksa Ürün aboneliğinin mi gerekli olduğunu belirtir. | bool |
termsOfServiceUrl | API için Hizmet Koşulları'nın URL'si. URL biçiminde olmalıdır. | string |
translateRequiredQueryParameters | Gerekli sorgu parametrelerini şablon parametrelerine çevirme stratejisi. Varsayılan olarak 'template' değerine sahiptir. Olası değerler: 'template', 'query' | "sorgu" "şablon" |
tür | API türü. | "graphql" "http" "odata" "sabun" "websocket" |
değer | API içeri aktarılırken içerik değeri. | string |
wsdlSelector | WSDL'nin içeri aktarılmasını belgenin bir alt kümesiyle sınırlama ölçütleri. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
Ad | Açıklama | Değer |
---|---|---|
açıklama | API Sürüm Kümesi'nin açıklaması. | string |
kimlik | 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. | string |
name | API Sürüm Kümesinin görünen Adı. | string |
versionHeaderName | versioningScheme olarak ayarlandıysa header API Sürümünü gösteren HTTP üst bilgi parametresinin adı. |
string |
versioningScheme | API Sürüm tanımlayıcısının HTTP isteğinde nerede bulunacağını belirleyen bir değer. | "Üst bilgi" "Sorgu" "Segment" |
versionQueryName | versioningScheme olarak ayarlandıysa query API Sürümünü gösteren sorgu parametresinin adı. |
string |
AuthenticationSettingsContract
Ad | Açıklama | Değer |
---|---|---|
oAuth2 | OAuth2 Kimlik Doğrulama ayarları | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Bu API'ye dahil edilen OAuth2 kimlik doğrulama ayarlarının koleksiyonu. | OAuth2AuthenticationSettingsContract[] |
Openıd | OpenID Connect Kimlik Doğrulama Ayarları | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Bu API'ye dahil edilen Open ID Connect kimlik doğrulama ayarlarının koleksiyonu. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Ad | Açıklama | Değer |
---|---|---|
authorizationServerId | OAuth yetkilendirme sunucusu tanımlayıcısı. | string |
scope | işlem kapsamı. | string |
OpenIdAuthenticationSettingsContract
Ad | Açıklama | Değer |
---|---|---|
bearerTokenSendingMethods | Sunucuya belirteç gönderme. | Herhangi birini içeren dize dizisi: "authorizationHeader" "query" |
openidProviderId | OAuth yetkilendirme sunucusu tanımlayıcısı. | string |
ApiContactInformation
Ad | Açıklama | Değer |
---|---|---|
e-posta | İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde OLMALıDıR | string |
name | İlgili kişinin/kuruluşun tanımlayıcı adı | string |
url | Kişi bilgilerine işaret eden URL. URL biçiminde olmalıdır | string |
ApiLicenseInformation
Ad | Açıklama | Değer |
---|---|---|
name | API için kullanılan lisans adı | string |
url | API için kullanılan lisansın URL'si. URL biçiminde olmalıdır | string |
SubscriptionKeyParameterNamesContract
Ad | Açıklama | Değer |
---|---|---|
üst bilgi | Abonelik anahtarı üst bilgi adı. | string |
query | Abonelik anahtarı sorgu dizesi parametre adı. | string |
ApiCreateOrUpdatePropertiesWsdlSelector
Ad | Açıklama | Değer |
---|---|---|
wsdlEndpointName | WSDL'den içeri aktarılacağınız uç noktanın (bağlantı noktası) adı | string |
wsdlServiceName | WSDL'den içeri aktaracak hizmetin adı | string |