Not
Bu sayfaya erişim yetkilendirme gerektiriyor. Oturum açmayı veya dizinleri değiştirmeyi deneyebilirsiniz.
Bu sayfaya erişim yetkilendirme gerektiriyor. Dizinleri değiştirmeyi deneyebilirsiniz.
- en son
- 2025-09-01-önizleme
- 2025-03-01-önizleme
- 2024-10-01-önizleme
- 2024-06-01-önizleme
- 2024-05-01
- 2023-09-01-önizleme
- 2023-05-01-önizleme
- 2023-03-01-önizleme
- 2022-09-01-önizleme
- 2022-08-01
- 2022-04-01-önizleme
- 2021-12-01-önizleme
- 2021-08-01
- 2021-04-01-önizleme
- 2021-01-01-önizleme
- 2020-12-01
- 2020-06-01-önizleme
- 2019-12-01
- 2019-12-01-önizleme
- 2019-01-01
- 2018-06-01-önizleme
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep kaynak tanımı
Hizmet/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üğü.
Kullanım Örnekleri
Bicep Örnekleri
API Management Hizmeti içinde API dağıtmanın temel bir örneği.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
name: resourceName
location: location
sku: {
capacity: 0
name: 'Consumption'
}
properties: {
certificates: []
customProperties: {
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
}
disableGateway: false
publicNetworkAccess: 'Enabled'
publisherEmail: 'pub1@email.com'
publisherName: 'pub1'
virtualNetworkType: 'None'
}
}
resource api 'Microsoft.ApiManagement/service/apis@2021-08-01' = {
name: '${resourceName};rev=1'
parent: service
properties: {
apiRevisionDescription: ''
apiType: 'http'
apiVersion: ''
apiVersionDescription: ''
authenticationSettings: {}
description: ''
displayName: 'api1'
path: 'api1'
protocols: [
'https'
]
serviceUrl: ''
subscriptionRequired: true
type: 'http'
}
}
Azure Doğrulanmış Modülleri
Aşağıdaki Azure Doğrulanmış Modüller bu kaynak türünü dağıtmak için kullanılabilir.
| Module | Açıklama |
|---|---|
| API Yönetim Servisi - API | API Yönetim Hizmeti için AVM Child Modülü - API |
Kaynak biçimi
Microsoft.ApiManagement/service/apis kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2022-04-01-preview' = {
parent: resourceSymbolicName
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
Microsoft.ApiManagement/service/apis
| Ad | Açıklama | Değer |
|---|---|---|
| ad | Kaynak adı | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 256 Desen = ^[^*#&+:<>?]+$ (gerekli) |
| ebeveyn | Bicep'te bir alt kaynak için üst kaynak belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir. Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında. |
Kaynak türü için sembolik ad: hizmet |
| Özellikler | Güncelleştirme özelliklerinin API varlığı oluşturma. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
Apiİletişim Bilgileri
| Ad | Açıklama | Değer |
|---|---|---|
| E-posta | İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde olmalıdır | dizgi |
| ad | İlgili kişinin/kuruluşun tanımlayıcı adı | dizgi |
| URL | kişi bilgilerine işaret eden URL. URL biçiminde olmalıdır | dizgi |
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Ad | Açıklama | Değer |
|---|---|---|
| apiRevision (Düzeltme Bölümü) | API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 100 |
| apiRevisionDescription | API Düzeltmesi'nin açıklaması. | dizgi Kısıtlama -ları: Maksimum uzunluk = 256 |
| apiType (apiTürü) | Oluşturulacak API türü. * http REST API oluşturur * soap bir SOAP geçiş API'si oluşturur * websocket websocket API'si oluşturur * graphql GraphQL API'si oluşturur. |
'Graphql' 'http' 'sabun' 'web soketi' |
| apiVersiyonu | API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir | dizgi Kısıtlama -ları: Maksimum uzunluk = 100 |
| apiVersionDescription | API Sürümünün açıklaması. | dizgi Kısıtlama -ları: Maksimum uzunluk = 256 |
| apiVersionSet | Sürüm kümesi ayrıntıları | apiVersionSetContractDetails |
| apiVersionSetId | İlgili ApiVersionSet için kaynak tanımlayıcısı. | dizgi |
| authenticationSettings | Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu. | AuthenticationSettingsContract |
| temas | API için iletişim bilgileri. | Apiİletişim Bilgileri |
| Açıklama | API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir. | dizgi |
| ekran adı | API adı. 1 ile 300 karakter uzunluğunda olmalıdır. | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 300 |
| biçim | API'nin içeri aktarıldığı İçeriğin biçimi. | 'graphql-bağlantısı' 'openapi' 'openapi+json' 'openapi+json-bağlantısı' 'openapi-bağlantısı' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-bağlantısı' |
| Güncel | API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir. | Bool |
| lisans | API için lisans bilgileri. | ApiLicenseInformation (ApiLisans Bilgileri) |
| yol | 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 için genel bir URL oluşturmak üzere hizmet örneği oluşturma sırasında belirtilen API uç nokta temel URL'sine eklenir. | dizgi Kısıtlama -ları: Maksimum uzunluk = 400 (gerekli) |
| Protokol | Bu API'deki işlemlerin çağrılabileceği protokolleri 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. | dizgi Kısıtlama -ları: Maksimum uzunluk = 2000 |
| sourceApiId | Kaynak API'nin API tanımlayıcısı. | dizgi |
| subscriptionKeyParameterNames | API'nin kullanılabilir hale getirildiği protokoller. | SubscriptionKeyParameterNamesContract |
| subscriptionGerekli | 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. | dizgi |
| 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' 'sabun' 'web soketi' |
| değer | API içeri aktarılırken içerik değeri. | dizgi |
| wsdlSelector | WSDL'nin içeri aktarılmasını belgenin bir alt kümesiyle sınırlama ölçütleri. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Ad | Açıklama | Değer |
|---|---|---|
| wsdlEndpointName | WSDL'den içeri aktarılacağınız uç noktanın (bağlantı noktası) adı | dizgi |
| wsdlServiceName | WSDL'den içeri aktaracak hizmetin adı | dizgi |
ApiLicenseInformation (ApiLisans Bilgileri)
| Ad | Açıklama | Değer |
|---|---|---|
| ad | API için kullanılan lisans adı | dizgi |
| URL | API için kullanılan lisansın URL'si. URL biçiminde olmalıdır | dizgi |
ApiVersionSetContractDetails
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | API Sürüm Kümesi açıklaması. | dizgi |
| Kimliği | 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. | dizgi |
| ad | API Sürüm Kümesinin görünen Adı. | dizgi |
| versionHeaderName | VersioningScheme headerolarak ayarlandıysa API Sürümünü gösteren HTTP üst bilgi parametresinin adı. |
dizgi |
| 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 queryolarak ayarlandıysa API Sürümünü gösteren sorgu parametresinin adı. |
dizgi |
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[] |
| Açık Kimlik | 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ı. | dizgi |
| kapsam | işlem kapsamı. | dizgi |
OpenIdAuthenticationSettingsContract
| Ad | Açıklama | Değer |
|---|---|---|
| bearerTokenSendingMethods | Sunucuya belirteç gönderme. | Herhangi birini içeren dize dizisi: 'authorizationHeader' 'sorgu' |
| openidProviderId | OAuth yetkilendirme sunucusu tanımlayıcısı. | dizgi |
SubscriptionKeyParameterNamesContract
| Ad | Açıklama | Değer |
|---|---|---|
| üstbilgi | Abonelik anahtarı üst bilgi adı. | dizgi |
| sorgu | Abonelik anahtarı sorgu dizesi parametre adı. | dizgi |
ARM şablonu kaynak tanımı
Hizmet/apis kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları - Kaynak grubu dağıtım komutlarına bakınız Her API sürümünde değişen özelliklerin listesi için değişiklik günlüğüne bakınız.
Kullanım Örnekleri
Kaynak biçimi
Microsoft.ApiManagement/service/apis kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2022-04-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
Microsoft.ApiManagement/service/apis
| Ad | Açıklama | Değer |
|---|---|---|
| apiVersiyonu | API sürümü | '2022-04-01-önizleme' |
| ad | Kaynak adı | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 256 Desen = ^[^*#&+:<>?]+$ (gerekli) |
| Özellikler | Güncelleştirme özelliklerinin API varlığı oluşturma. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| tür | Kaynak türü | 'Microsoft.ApiManagement/service/apis' |
Apiİletişim Bilgileri
| Ad | Açıklama | Değer |
|---|---|---|
| E-posta | İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde olmalıdır | dizgi |
| ad | İlgili kişinin/kuruluşun tanımlayıcı adı | dizgi |
| URL | kişi bilgilerine işaret eden URL. URL biçiminde olmalıdır | dizgi |
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Ad | Açıklama | Değer |
|---|---|---|
| apiRevision (Düzeltme Bölümü) | API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 100 |
| apiRevisionDescription | API Düzeltmesi'nin açıklaması. | dizgi Kısıtlama -ları: Maksimum uzunluk = 256 |
| apiType (apiTürü) | Oluşturulacak API türü. * http REST API oluşturur * soap bir SOAP geçiş API'si oluşturur * websocket websocket API'si oluşturur * graphql GraphQL API'si oluşturur. |
'Graphql' 'http' 'sabun' 'web soketi' |
| apiVersiyonu | API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir | dizgi Kısıtlama -ları: Maksimum uzunluk = 100 |
| apiVersionDescription | API Sürümünün açıklaması. | dizgi Kısıtlama -ları: Maksimum uzunluk = 256 |
| apiVersionSet | Sürüm kümesi ayrıntıları | apiVersionSetContractDetails |
| apiVersionSetId | İlgili ApiVersionSet için kaynak tanımlayıcısı. | dizgi |
| authenticationSettings | Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu. | AuthenticationSettingsContract |
| temas | API için iletişim bilgileri. | Apiİletişim Bilgileri |
| Açıklama | API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir. | dizgi |
| ekran adı | API adı. 1 ile 300 karakter uzunluğunda olmalıdır. | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 300 |
| biçim | API'nin içeri aktarıldığı İçeriğin biçimi. | 'graphql-bağlantısı' 'openapi' 'openapi+json' 'openapi+json-bağlantısı' 'openapi-bağlantısı' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-bağlantısı' |
| Güncel | API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir. | Bool |
| lisans | API için lisans bilgileri. | ApiLicenseInformation (ApiLisans Bilgileri) |
| yol | 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 için genel bir URL oluşturmak üzere hizmet örneği oluşturma sırasında belirtilen API uç nokta temel URL'sine eklenir. | dizgi Kısıtlama -ları: Maksimum uzunluk = 400 (gerekli) |
| Protokol | Bu API'deki işlemlerin çağrılabileceği protokolleri 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. | dizgi Kısıtlama -ları: Maksimum uzunluk = 2000 |
| sourceApiId | Kaynak API'nin API tanımlayıcısı. | dizgi |
| subscriptionKeyParameterNames | API'nin kullanılabilir hale getirildiği protokoller. | SubscriptionKeyParameterNamesContract |
| subscriptionGerekli | 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. | dizgi |
| 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' 'sabun' 'web soketi' |
| değer | API içeri aktarılırken içerik değeri. | dizgi |
| wsdlSelector | WSDL'nin içeri aktarılmasını belgenin bir alt kümesiyle sınırlama ölçütleri. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Ad | Açıklama | Değer |
|---|---|---|
| wsdlEndpointName | WSDL'den içeri aktarılacağınız uç noktanın (bağlantı noktası) adı | dizgi |
| wsdlServiceName | WSDL'den içeri aktaracak hizmetin adı | dizgi |
ApiLicenseInformation (ApiLisans Bilgileri)
| Ad | Açıklama | Değer |
|---|---|---|
| ad | API için kullanılan lisans adı | dizgi |
| URL | API için kullanılan lisansın URL'si. URL biçiminde olmalıdır | dizgi |
ApiVersionSetContractDetails
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | API Sürüm Kümesi açıklaması. | dizgi |
| Kimliği | 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. | dizgi |
| ad | API Sürüm Kümesinin görünen Adı. | dizgi |
| versionHeaderName | VersioningScheme headerolarak ayarlandıysa API Sürümünü gösteren HTTP üst bilgi parametresinin adı. |
dizgi |
| 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 queryolarak ayarlandıysa API Sürümünü gösteren sorgu parametresinin adı. |
dizgi |
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[] |
| Açık Kimlik | 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ı. | dizgi |
| kapsam | işlem kapsamı. | dizgi |
OpenIdAuthenticationSettingsContract
| Ad | Açıklama | Değer |
|---|---|---|
| bearerTokenSendingMethods | Sunucuya belirteç gönderme. | Herhangi birini içeren dize dizisi: 'authorizationHeader' 'sorgu' |
| openidProviderId | OAuth yetkilendirme sunucusu tanımlayıcısı. | dizgi |
SubscriptionKeyParameterNamesContract
| Ad | Açıklama | Değer |
|---|---|---|
| üstbilgi | Abonelik anahtarı üst bilgi adı. | dizgi |
| sorgu | Abonelik anahtarı sorgu dizesi parametre adı. | dizgi |
Terraform (AzAPI sağlayıcısı) kaynak tanımı
Hizmet/apis kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları Her API sürümünde değişen özelliklerin listesi için bkz. Değişiklik günlüğü.
Kullanım Örnekleri
Terraform Örnekleri
API Management Hizmeti içinde API dağıtmanın temel bir örneği.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "service" {
type = "Microsoft.ApiManagement/service@2021-08-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
certificates = [
]
customProperties = {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11" = "false"
}
disableGateway = false
publicNetworkAccess = "Enabled"
publisherEmail = "pub1@email.com"
publisherName = "pub1"
virtualNetworkType = "None"
}
sku = {
capacity = 0
name = "Consumption"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "api" {
type = "Microsoft.ApiManagement/service/apis@2021-08-01"
parent_id = azapi_resource.service.id
name = "${var.resource_name};rev=1"
body = {
properties = {
apiRevisionDescription = ""
apiType = "http"
apiVersion = ""
apiVersionDescription = ""
authenticationSettings = {
}
description = ""
displayName = "api1"
path = "api1"
protocols = [
"https",
]
serviceUrl = ""
subscriptionRequired = true
type = "http"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Kaynak biçimi
Microsoft.ApiManagement/service/apis kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2022-04-01-preview"
name = "string"
parent_id = "string"
body = {
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
Microsoft.ApiManagement/service/apis
| Ad | Açıklama | Değer |
|---|---|---|
| ad | Kaynak adı | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 256 Desen = ^[^*#&+:<>?]+$ (gerekli) |
| ebeveyn_kimlik | Bu kaynağın üst öğesi olan kaynağın kimliği. | Kaynak türü için kimlik: hizmet |
| Özellikler | Güncelleştirme özelliklerinin API varlığı oluşturma. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| tür | Kaynak türü | "Microsoft.ApiManagement/service/apis@2022-04-01-preview" |
Apiİletişim Bilgileri
| Ad | Açıklama | Değer |
|---|---|---|
| E-posta | İlgili kişinin/kuruluşun e-posta adresi. E-posta adresi biçiminde olmalıdır | dizgi |
| ad | İlgili kişinin/kuruluşun tanımlayıcı adı | dizgi |
| URL | kişi bilgilerine işaret eden URL. URL biçiminde olmalıdır | dizgi |
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Ad | Açıklama | Değer |
|---|---|---|
| apiRevision (Düzeltme Bölümü) | API'nin düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 100 |
| apiRevisionDescription | API Düzeltmesi'nin açıklaması. | dizgi Kısıtlama -ları: Maksimum uzunluk = 256 |
| apiType (apiTürü) | Oluşturulacak API türü. * http REST API oluşturur * soap bir SOAP geçiş API'si oluşturur * websocket websocket API'si oluşturur * graphql GraphQL API'si oluşturur. |
'Graphql' 'http' 'sabun' 'web soketi' |
| apiVersiyonu | API sürümlendiyse API'nin sürüm tanımlayıcısını gösterir | dizgi Kısıtlama -ları: Maksimum uzunluk = 100 |
| apiVersionDescription | API Sürümünün açıklaması. | dizgi Kısıtlama -ları: Maksimum uzunluk = 256 |
| apiVersionSet | Sürüm kümesi ayrıntıları | apiVersionSetContractDetails |
| apiVersionSetId | İlgili ApiVersionSet için kaynak tanımlayıcısı. | dizgi |
| authenticationSettings | Bu API'ye dahil edilen kimlik doğrulama ayarlarının koleksiyonu. | AuthenticationSettingsContract |
| temas | API için iletişim bilgileri. | Apiİletişim Bilgileri |
| Açıklama | API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir. | dizgi |
| ekran adı | API adı. 1 ile 300 karakter uzunluğunda olmalıdır. | dizgi Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 300 |
| biçim | API'nin içeri aktarıldığı İçeriğin biçimi. | 'graphql-bağlantısı' 'openapi' 'openapi+json' 'openapi+json-bağlantısı' 'openapi-bağlantısı' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-bağlantısı' |
| Güncel | API düzeltmenin geçerli API düzeltmesi olup olmadığını gösterir. | Bool |
| lisans | API için lisans bilgileri. | ApiLicenseInformation (ApiLisans Bilgileri) |
| yol | 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 için genel bir URL oluşturmak üzere hizmet örneği oluşturma sırasında belirtilen API uç nokta temel URL'sine eklenir. | dizgi Kısıtlama -ları: Maksimum uzunluk = 400 (gerekli) |
| Protokol | Bu API'deki işlemlerin çağrılabileceği protokolleri 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. | dizgi Kısıtlama -ları: Maksimum uzunluk = 2000 |
| sourceApiId | Kaynak API'nin API tanımlayıcısı. | dizgi |
| subscriptionKeyParameterNames | API'nin kullanılabilir hale getirildiği protokoller. | SubscriptionKeyParameterNamesContract |
| subscriptionGerekli | 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. | dizgi |
| 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' 'sabun' 'web soketi' |
| değer | API içeri aktarılırken içerik değeri. | dizgi |
| wsdlSelector | WSDL'nin içeri aktarılmasını belgenin bir alt kümesiyle sınırlama ölçütleri. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Ad | Açıklama | Değer |
|---|---|---|
| wsdlEndpointName | WSDL'den içeri aktarılacağınız uç noktanın (bağlantı noktası) adı | dizgi |
| wsdlServiceName | WSDL'den içeri aktaracak hizmetin adı | dizgi |
ApiLicenseInformation (ApiLisans Bilgileri)
| Ad | Açıklama | Değer |
|---|---|---|
| ad | API için kullanılan lisans adı | dizgi |
| URL | API için kullanılan lisansın URL'si. URL biçiminde olmalıdır | dizgi |
ApiVersionSetContractDetails
| Ad | Açıklama | Değer |
|---|---|---|
| Açıklama | API Sürüm Kümesi açıklaması. | dizgi |
| Kimliği | 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. | dizgi |
| ad | API Sürüm Kümesinin görünen Adı. | dizgi |
| versionHeaderName | VersioningScheme headerolarak ayarlandıysa API Sürümünü gösteren HTTP üst bilgi parametresinin adı. |
dizgi |
| 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 queryolarak ayarlandıysa API Sürümünü gösteren sorgu parametresinin adı. |
dizgi |
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[] |
| Açık Kimlik | 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ı. | dizgi |
| kapsam | işlem kapsamı. | dizgi |
OpenIdAuthenticationSettingsContract
| Ad | Açıklama | Değer |
|---|---|---|
| bearerTokenSendingMethods | Sunucuya belirteç gönderme. | Herhangi birini içeren dize dizisi: 'authorizationHeader' 'sorgu' |
| openidProviderId | OAuth yetkilendirme sunucusu tanımlayıcısı. | dizgi |
SubscriptionKeyParameterNamesContract
| Ad | Açıklama | Değer |
|---|---|---|
| üstbilgi | Abonelik anahtarı üst bilgi adı. | dizgi |
| sorgu | Abonelik anahtarı sorgu dizesi parametre adı. | dizgi |