Serviço Microsoft.ApiManagement

Definição de recursos do bíceps

O tipo de recurso de serviço pode ser implantado com operações que visam:

• Grupos de recursos - Consulte comandos de implantação de grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service@2023-09-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    additionalLocations: [
      {
        disableGateway: bool
        location: 'string'
        natGatewayState: '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'
      }
    ]
    configurationApi: {
      legacyApi: 'string'
    }
    customProperties: {
      {customized property}: 'string'
    }
    developerPortalStatus: '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'
      }
    ]
    legacyPortalStatus: 'string'
    natGatewayState: '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'
  }
  zones: [
    'string'
  ]
}

Valores de propriedade

serviço

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

Localização Adicional

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

Este objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Crie uma instância de Gerenciamento de API e todos os subrecursos usando o modelo	Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar subentidades
Implantar o Gerenciamento de API com um Cache do Azure externo para Redis	Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada de Consumo com uma instância externa do Cache do Azure para Redis como o cache externo do Gerenciamento de API.
Implantar o Gerenciamento de API em VNet externa com IP público	Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada Premium dentro da sub-rede da sua rede virtual no modo externo e configurar regras NSG recomendadas na sub-rede. A instância é implantada em duas zonas de disponibilidade. O modelo também configura um endereço IP público da sua assinatura.
Criar uma instância de Gerenciamento de API com nomes de host personalizados	Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure com nome de host personalizado para portal e vários nomes de host personalizados para proxy
Criar gerenciamento de API em rede virtual interna com do App Gateway	Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure em uma rede privada protegida pelo Gateway de Aplicativo do Azure.
Implantar o Gerenciamento de API em VNet interna com IP público	Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada Premium dentro da sub-rede da sua rede virtual no modo interno e configurar regras NSG recomendadas na sub-rede. A instância é implantada em duas zonas de disponibilidade. O modelo também configura um endereço IP público da sua assinatura.
Criar uma instância de Gerenciamento de API com o MSI Identity	Este modelo cria uma instância de desenvolvedor do Gerenciamento de API do Azure com uma Identidade MSI
Criar uma instância de Gerenciamento de API de camada Premium multirregional	Este modelo demonstra como criar uma instância de Gerenciamento de API com locais adicionais. O local principal é o mesmo que o local do grupo de recursos. Para locais adicionais, o modelo mostra NorthCentralUs e East US2. O local principal deve ser diferente dos locais adicionais.
Criar gerenciamento de API com proxy ssl personalizado usando KeyVault	Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure e configurar o nome de host personalizado para proxy com certificado ssl do keyvault.
Criar um serviço de gerenciamento de API com SSL a partir do KeyVault	Este modelo implanta um serviço de Gerenciamento de API configurado com Identidade Atribuída pelo Usuário. Ele usa essa identidade para buscar o certificado SSL do KeyVault e o mantém atualizado verificando a cada 4 horas.
Criar e monitorar a instância de Gerenciamento de API	Este modelo cria uma instância do serviço de Gerenciamento de API do Azure e do espaço de trabalho do Log Analytics e configura o monitoramento para seu serviço de Gerenciamento de API com o Log Analytics
Criar um serviço de Gerenciamento de API com um ponto de extremidade privado	Este modelo criará um serviço de Gerenciamento de API, uma rede virtual e um ponto de extremidade privado expondo o serviço de Gerenciamento de API à rede virtual.
implantar o gerenciamento de API em zonas de disponibilidade	Este modelo cria uma instância premium do Gerenciamento de API do Azure e implanta em uma zona de disponibilidade
Criar uma instância de Gerenciamento de API usando um modelo	Este modelo cria uma instância de desenvolvedor do Gerenciamento de API do Azure
Porta Frontal Standard/Premium com origem API Management	Este modelo cria um Front Door Premium e uma instância de Gerenciamento de API, e usa uma política NSG e global de Gerenciamento de API para validar que o tráfego passou pela origem do Front Door.
Criar a Porta da Frente do Azure em frente ao de Gerenciamento de API do Azure	Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Gerenciamento de API do Azure.
Application Gateway com gerenciamento interno de API e de aplicativos Web	Gateway de Aplicativo roteando tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno) que atende uma API Web hospedada em um Aplicativo Web do Azure.

Definição de recurso de modelo ARM

O tipo de recurso de serviço pode ser implantado com operações que visam:

• Grupos de recursos - Consulte comandos de implantação de grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": "bool",
        "location": "string",
        "natGatewayState": "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"
      }
    ],
    "configurationApi": {
      "legacyApi": "string"
    },
    "customProperties": {
      "{customized property}": "string"
    },
    "developerPortalStatus": "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"
      }
    ],
    "legacyPortalStatus": "string",
    "natGatewayState": "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"
  },
  "zones": [ "string" ]
}

Valores de propriedade

serviço

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

Localização Adicional

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

Este objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Crie uma instância de Gerenciamento de API e todos os subrecursos usando o modelo	Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar subentidades
Implantar o Gerenciamento de API com um Cache do Azure externo para Redis	Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada de Consumo com uma instância externa do Cache do Azure para Redis como o cache externo do Gerenciamento de API.
Implantar o Gerenciamento de API em VNet externa com IP público	Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada Premium dentro da sub-rede da sua rede virtual no modo externo e configurar regras NSG recomendadas na sub-rede. A instância é implantada em duas zonas de disponibilidade. O modelo também configura um endereço IP público da sua assinatura.
Criar uma instância de Gerenciamento de API com nomes de host personalizados	Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure com nome de host personalizado para portal e vários nomes de host personalizados para proxy
Criar gerenciamento de API em rede virtual interna com do App Gateway	Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure em uma rede privada protegida pelo Gateway de Aplicativo do Azure.
Implantar o Gerenciamento de API em VNet interna com IP público	Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada Premium dentro da sub-rede da sua rede virtual no modo interno e configurar regras NSG recomendadas na sub-rede. A instância é implantada em duas zonas de disponibilidade. O modelo também configura um endereço IP público da sua assinatura.
Criar uma instância de Gerenciamento de API com o MSI Identity	Este modelo cria uma instância de desenvolvedor do Gerenciamento de API do Azure com uma Identidade MSI
Criar uma instância de Gerenciamento de API de camada Premium multirregional	Este modelo demonstra como criar uma instância de Gerenciamento de API com locais adicionais. O local principal é o mesmo que o local do grupo de recursos. Para locais adicionais, o modelo mostra NorthCentralUs e East US2. O local principal deve ser diferente dos locais adicionais.
Criar gerenciamento de API com proxy ssl personalizado usando KeyVault	Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure e configurar o nome de host personalizado para proxy com certificado ssl do keyvault.
Criar um serviço de gerenciamento de API com SSL a partir do KeyVault	Este modelo implanta um serviço de Gerenciamento de API configurado com Identidade Atribuída pelo Usuário. Ele usa essa identidade para buscar o certificado SSL do KeyVault e o mantém atualizado verificando a cada 4 horas.
Criar e monitorar a instância de Gerenciamento de API	Este modelo cria uma instância do serviço de Gerenciamento de API do Azure e do espaço de trabalho do Log Analytics e configura o monitoramento para seu serviço de Gerenciamento de API com o Log Analytics
Criar um serviço de Gerenciamento de API com um ponto de extremidade privado	Este modelo criará um serviço de Gerenciamento de API, uma rede virtual e um ponto de extremidade privado expondo o serviço de Gerenciamento de API à rede virtual.
implantar o gerenciamento de API em zonas de disponibilidade	Este modelo cria uma instância premium do Gerenciamento de API do Azure e implanta em uma zona de disponibilidade
Criar uma instância de Gerenciamento de API usando um modelo	Este modelo cria uma instância de desenvolvedor do Gerenciamento de API do Azure
Porta Frontal Standard/Premium com origem API Management	Este modelo cria um Front Door Premium e uma instância de Gerenciamento de API, e usa uma política NSG e global de Gerenciamento de API para validar que o tráfego passou pela origem do Front Door.
Criar a Porta da Frente do Azure em frente ao de Gerenciamento de API do Azure	Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Gerenciamento de API do Azure.
Application Gateway com gerenciamento interno de API e de aplicativos Web	Gateway de Aplicativo roteando tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno) que atende uma API Web hospedada em um Aplicativo Web do Azure.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso de serviço pode ser implantado com operações que visam:

• Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2023-09-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          disableGateway = bool
          location = "string"
          natGatewayState = "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"
        }
      ]
      configurationApi = {
        legacyApi = "string"
      }
      customProperties = {
        {customized property} = "string"
      }
      developerPortalStatus = "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"
        }
      ]
      legacyPortalStatus = "string"
      natGatewayState = "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"
    }
    zones = [
      "string"
    ]
    sku = {
      capacity = int
      name = "string"
    }
  })
}

Valores de propriedade

serviço

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

Localização Adicional

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

Este objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState