Microsoft.ApiManagement hizmeti 2021-12-01-preview

Bicep kaynak tanımı

Hizmet 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 kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.ApiManagement/service@2021-12-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        disableGateway: bool
        location: 'string'
        publicIpAddressId: 'string'
        sku: {
          capacity: int
          name: 'string'
        }
        virtualNetworkConfiguration: {
          subnetResourceId: 'string'
        }
        zones: [
          'string'
        ]
      }
    ]
    apiVersionConstraint: {
      minApiVersion: 'string'
    }
    certificates: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        encodedCertificate: 'string'
        storeName: 'string'
      }
    ]
    customProperties: {
      {customized property}: 'string'
    }
    disableGateway: bool
    enableClientCertificate: bool
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        certificateSource: 'string'
        certificateStatus: 'string'
        defaultSslBinding: bool
        encodedCertificate: 'string'
        hostName: 'string'
        identityClientId: 'string'
        keyVaultId: 'string'
        negotiateClientCertificate: bool
        type: 'string'
      }
    ]
    notificationSenderEmail: 'string'
    privateEndpointConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
        type: 'string'
      }
    ]
    publicIpAddressId: 'string'
    publicNetworkAccess: 'string'
    publisherEmail: 'string'
    publisherName: 'string'
    restore: bool
    virtualNetworkConfiguration: {
      subnetResourceId: 'string'
    }
    virtualNetworkType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Özellik değerleri

AdditionalLocation

ApiManagementServiceBasePropertiesCustomProperties

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

ApimResourceTags

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

PrivateEndpointConnectionWrapperProperties

PrivateLinkServiceConnectionState

RemotePrivateEndpointConnectionWrapper

UserIdentityProperties

VirtualNetworkConfiguration

Hızlı başlangıç örnekleri

Aşağıdaki hızlı başlangıç örnekleri bu kaynak türünü dağıtır.

ARM şablonu kaynak tanımı

Hizmet 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 kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2021-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": "bool",
        "location": "string",
        "publicIpAddressId": "string",
        "sku": {
          "capacity": "int",
          "name": "string"
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "string"
        },
        "zones": [ "string" ]
      }
    ],
    "apiVersionConstraint": {
      "minApiVersion": "string"
    },
    "certificates": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "encodedCertificate": "string",
        "storeName": "string"
      }
    ],
    "customProperties": {
      "{customized property}": "string"
    },
    "disableGateway": "bool",
    "enableClientCertificate": "bool",
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "certificateSource": "string",
        "certificateStatus": "string",
        "defaultSslBinding": "bool",
        "encodedCertificate": "string",
        "hostName": "string",
        "identityClientId": "string",
        "keyVaultId": "string",
        "negotiateClientCertificate": "bool",
        "type": "string"
      }
    ],
    "notificationSenderEmail": "string",
    "privateEndpointConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        },
        "type": "string"
      }
    ],
    "publicIpAddressId": "string",
    "publicNetworkAccess": "string",
    "publisherEmail": "string",
    "publisherName": "string",
    "restore": "bool",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "string"
    },
    "virtualNetworkType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Özellik değerleri

AdditionalLocation

ApiManagementServiceBasePropertiesCustomProperties

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

ApimResourceTags

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

PrivateEndpointConnectionWrapperProperties

PrivateLinkServiceConnectionState

RemotePrivateEndpointConnectionWrapper

UserIdentityProperties

VirtualNetworkConfiguration

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon	Açıklama
İç API Management ve Web App ile Application Gateway 'a dağıtma	Application Gateway, İnternet trafiğini Azure Web App'te barındırılan bir web API'sine hizmet veren bir sanal ağ (iç mod) API Management örneğine yönlendirir.
Çok bölgeli Premium katman API Management örneği oluşturma 'a dağıtma	Bu şablon, ek konumlar içeren bir API Management örneğinin nasıl oluşturulacağını gösterir. Birincil konum, kaynak grubunun konumuyla aynıdır. Ek konumlar için şablon NorthCentralUs ve Doğu ABD2'yi gösterir. Birincil konum ek konumlardan farklı olmalıdır.
Şablon kullanarak API Management örneği ve tüm alt kaynakları oluşturma 'a dağıtma	Bu şablon, API Management hizmeti oluşturma ve alt varlıkları yapılandırma adımlarını gösterir
MSI Kimliği sahip bir API Management örneği oluşturma 'a dağıtma	Bu şablon, MSI Kimliğine sahip bir Azure API Management geliştirici örneği oluşturur
Şablon kullanarak API Management örneği oluşturma 'a dağıtma	Bu şablon Azure API Management'ın geliştirici örneğini oluşturur
Özel konak adlarıyla API Management örneği oluşturma 'a dağıtma	Bu şablonda portal için özel konak adı ve ara sunucu için birden çok özel konak adı ile Azure API Management örneğinin nasıl oluşturulacağı gösterilmektedir
Özel uç nokta ile API Management hizmeti oluşturma 'a dağıtma	Bu şablon, API Management hizmetini sanal ağa maruz bırakarak bir API Management hizmeti, bir sanal ağ ve özel uç nokta oluşturur.
KeyVault SSL ile API Management hizmeti oluşturma 'a dağıtma	Bu şablon, Kullanıcı Tarafından Atanan Kimlik ile yapılandırılmış bir API Management hizmeti dağıtır. KeyVault'tan SSL sertifikası getirmek için bu kimliği kullanır ve her 4 saatte bir denetleyerek bu sertifikayı güncel tutar.
API Management örneği oluşturma ve izleme 'a dağıtma	Bu şablon, Azure API Management hizmetinin ve Log Analytics çalışma alanının bir örneğini oluşturur ve Log Analytics ile API Management hizmetiniz için izlemeyi ayarlar
App Gateway ile İç Sanal Ağda API Management Oluşturma 'a dağıtma	Bu şablon, Azure Application Gateway tarafından korunan özel bir ağda Azure API Management örneği oluşturma adımlarını gösterir.
KeyVault kullanarak özel proxy ssl ile API Management oluşturma 'a dağıtma	Bu şablonda Azure API Management örneği oluşturma ve keyvault'tan ssl sertifikası ile ara sunucu için özel ana bilgisayar adı yapılandırma adımları gösterilmektedir.
Azure API Management önünde Azure Front Door oluşturma 'a dağıtma	Bu örnek, Azure API Management'ın önünde genel yük dengeleyici olarak Azure Front Door'un nasıl kullanılacağını gösterir.
genel IP ile dış sanal ağda API Management'ı dağıtma 'a dağıtma	Bu şablon, dış modda sanal ağınızın alt ağı içindeki Premium katmanında Azure API Management örneğinin nasıl oluşturulacağını ve alt ağda önerilen NSG kurallarının nasıl yapılandıracağını gösterir. Örnek iki kullanılabilirlik alanına dağıtılır. Şablon ayrıca aboneliğinizden bir genel IP adresi de yapılandırıyor.
genel IP ile API Management'ı iç sanal ağda dağıtma 'a dağıtma	Bu şablon, iç modda sanal ağınızın alt ağı içindeki Premium katmanında Azure API Management örneğinin nasıl oluşturulacağını ve alt ağda önerilen NSG kurallarının nasıl yapılandıracağını gösterir. Örnek iki kullanılabilirlik alanına dağıtılır. Şablon ayrıca aboneliğinizden bir genel IP adresi de yapılandırıyor.
API Management'ı Kullanılabilirlik Alanlarına Dağıtma 'a dağıtma	Bu şablon, Azure API Management'ın premium bir örneğini oluşturur ve bir Kullanılabilirlik Alanına dağıtır
Api Management'ı Dış Azure Cache for Redis ile Dağıtma 'a dağıtma	Bu şablon, Dış Redis için Azure Cache örneğini API Management dış önbelleği olarak kullanarak Tüketim katmanında Azure API Management örneğinin nasıl oluşturulacağını gösterir.
API Management kaynağı ile Front Door Standard/Premium 'a dağıtma	Bu şablon bir Front Door Premium ve API Management örneği oluşturur ve trafiğin Front Door kaynağından geldiğini doğrulamak için bir NSG ve genel API Management ilkesi kullanır.

Terraform (AzAPI sağlayıcısı) kaynak tanımı

Hizmet 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 kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2021-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          disableGateway = bool
          location = "string"
          publicIpAddressId = "string"
          sku = {
            capacity = int
            name = "string"
          }
          virtualNetworkConfiguration = {
            subnetResourceId = "string"
          }
          zones = [
            "string"
          ]
        }
      ]
      apiVersionConstraint = {
        minApiVersion = "string"
      }
      certificates = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          encodedCertificate = "string"
          storeName = "string"
        }
      ]
      customProperties = {
        {customized property} = "string"
      }
      disableGateway = bool
      enableClientCertificate = bool
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          certificateSource = "string"
          certificateStatus = "string"
          defaultSslBinding = bool
          encodedCertificate = "string"
          hostName = "string"
          identityClientId = "string"
          keyVaultId = "string"
          negotiateClientCertificate = bool
          type = "string"
        }
      ]
      notificationSenderEmail = "string"
      privateEndpointConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
          type = "string"
        }
      ]
      publicIpAddressId = "string"
      publicNetworkAccess = "string"
      publisherEmail = "string"
      publisherName = "string"
      restore = bool
      virtualNetworkConfiguration = {
        subnetResourceId = "string"
      }
      virtualNetworkType = "string"
    }
  })
}

Özellik değerleri

AdditionalLocation

ApiManagementServiceBasePropertiesCustomProperties

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

ApimResourceTags

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

PrivateEndpointConnectionWrapperProperties

PrivateLinkServiceConnectionState

RemotePrivateEndpointConnectionWrapper

UserIdentityProperties

VirtualNetworkConfiguration