Serviço Microsoft.ApiManagement

  • Artigo

Definição de recurso do Bicep

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

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

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
    {customized property}: 'string'
  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

Nome Descrição Valor
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 50

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.

O nome do recurso deve ser exclusivo no Azure.
local Local do recurso. cadeia de caracteres (obrigatório)
marcas Marcas de recurso. Dicionário de nomes e valores de marcas. Confira Marcas em modelos
sku Propriedades de SKU do serviço Gerenciamento de API. ApiManagementServiceSkuProperties (obrigatório)
identidade Identidade de serviço gerenciada do serviço de Gerenciamento de API. ApiManagementServiceIdentity
properties Propriedades do serviço Gerenciamento de API. ApiManagementServiceProperties (obrigatório)
zonas Uma lista de zonas de disponibilidade que indica de onde o recurso precisa vir. string[]

ApiManagementServiceIdentity

Nome Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (obrigatório)
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. A identidade do usuário
As referências de chave de dicionário serão IDs de recurso do ARM no formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} UserIdentityProperties

UserIdentityProperties

Nome Descrição Valor
clientId A ID do cliente da identidade atribuída pelo usuário. string
principalId A ID principal da identidade atribuída pelo usuário. string

ApiManagementServiceProperties

Nome Descrição Valor
additionalLocations Locais de datacenter adicionais do serviço Gerenciamento de API. AdditionalLocation[]
apiVersionConstraint Restrição de versão das Apis do Painel de Controle para o serviço Gerenciamento de API. ApiVersionConstraint
certificates Lista de Certificados que precisam ser instalados no serviço Gerenciamento de API. O máximo de certificados com suporte que podem ser instalados é 10. CertificateConfiguration[]
configurationApi Configuração da API do serviço Gerenciamento de API. ConfigurationApi
customProperties Propriedades personalizadas do serviço Gerenciamento de API.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desabilitará a TLS_RSA_WITH_3DES_EDE_CBC_SHA de criptografia para todos os TLS(1.0, 1.1 e 1.2).
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser usada para desabilitar apenas o TLS 1.1.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser usada para desabilitar o TLS 1.0 em um serviço Gerenciamento de API.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser usada para desabilitar apenas o TLS 1.1 para comunicações com back-ends.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser usada para desabilitar o TLS 1.0 para comunicações com back-ends.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser usada para habilitar o protocolo HTTP2 em um serviço Gerenciamento de API.
Não especificar nenhuma dessas propriedades na operação PATCH redefinirá os valores das propriedades omitidas para seus padrões. Para todas as configurações, exceto Http2, o valor padrão será True se o serviço tiver sido criado em 1º de abril de 2018 ou antes disso False . O valor padrão da configuração http2 é False.

Você pode desabilitar qualquer uma das seguintes codificações usando as configurações Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Por exemplo, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. O valor padrão é true para eles.
Observação: as seguintes criptografias não podem ser desabilitadas, pois são exigidas por componentes internos da plataforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256		 ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus Status do portal do desenvolvedor neste serviço Gerenciamento de API. 'Desabilitado'
'Enabled'
disableGateway Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway em master região. bool
enableClientCertificate Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe que um certificado de cliente seja apresentado em cada solicitação para o gateway. Isso também permite a capacidade de autenticar o certificado na política no gateway. bool
hostnameConfigurations Configuração de nome de host personalizado do serviço Gerenciamento de API. HostnameConfiguration[]
legacyPortalStatus Status do portal herdado no serviço Gerenciamento de API. 'Desabilitado'
'Enabled'
natGatewayState A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API. 'Desabilitado'
'Enabled'
notificationSenderEmail Email endereço do qual a notificação será enviada. string
privateEndpointConnections Lista de Conexões de Ponto de Extremidade Privado deste serviço. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Endereço IP baseado em IP de SKU Padrão Público V4 a ser associado a Rede Virtual serviço implantado na região. Compatível apenas com a implantação do SKU Premium e do Desenvolvedor no Rede Virtual. string
publicNetworkAccess Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço de Gerenciamento de API. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'. Se 'Disabled', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled' 'Desabilitado'
'Enabled'
publisherEmail Email do editor. cadeia de caracteres (obrigatório)
publisherName Nome do publicador. cadeia de caracteres (obrigatório)
restaurar Cancele a exclusão do Serviço de Gerenciamento de API se ele tiver sido excluído temporariamente. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas. bool
virtualNetworkConfiguration Configuração de rede virtual do serviço Gerenciamento de API. VirtualNetworkConfiguration
virtualNetworkType O tipo de VPN no qual Gerenciamento de API serviço precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação do Gerenciamento de API está configurada dentro de um Rede Virtual ter um ponto de extremidade voltado para a Internet e interno significa que Gerenciamento de API A implantação é configurada dentro de uma Rede Virtual ter apenas um ponto de extremidade voltado para a intranet. 'Externo'
'Interno'
'None'

AdditionalLocation

Nome Descrição Valor
disableGateway Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway nesse local adicional. bool
local O nome do local da região adicional entre as regiões do Data center do Azure. cadeia de caracteres (obrigatório)
natGatewayState A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API. 'Desabilitado'
'Enabled'
publicIpAddressId Endereço IP baseado em IP de SKU Padrão Público V4 a ser associado a Rede Virtual serviço implantado no local. Compatível apenas com o SKU Premium que está sendo implantado no Rede Virtual. string
sku Propriedades de SKU do serviço Gerenciamento de API. ApiManagementServiceSkuProperties (obrigatório)
virtualNetworkConfiguration Configuração de rede virtual para o local. VirtualNetworkConfiguration
zonas Uma lista de zonas de disponibilidade que indica de onde o recurso precisa vir. string[]

ApiManagementServiceSkuProperties

Nome Descrição Valor
ALOCADA Capacidade do SKU (número de unidades implantadas do SKU). Para a capacidade de SKU de Consumo, deve ser especificado como 0. int (obrigatório)
name Nome da SKU. 'Básico'
'BasicV2'
'Consumo'
'Developer'
'Isolado'
'Premium'
'Standard'
'StandardV2' (obrigatório)

VirtualNetworkConfiguration

Nome Descrição Valor
subnetResourceId A ID de recurso completa de uma sub-rede em uma rede virtual na qual implantar o serviço Gerenciamento de API. string

ApiVersionConstraint

Nome Descrição Valor
minApiVersion Limite as chamadas à API do painel de controle para Gerenciamento de API serviço com versão igual ou mais recente que esse valor. string

CertificateConfiguration

Nome Descrição Valor
certificado Informações de certificado. CertificateInformation
certificatePassword Senha do certificado. string
encodedCertificate Certificado codificado em Base64. string
storeName O local do repositório de certificados System.Security.Cryptography.x509certificates.StoreName. Somente Root e CertificateAuthority são locais válidos. 'CertificateAuthority'
'Root' (obrigatório)

CertificateInformation

Nome Descrição Valor
data de expiração Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601. cadeia de caracteres (obrigatório)
subject Assunto do certificado. cadeia de caracteres (obrigatório)
thumbprint Impressão digital do certificado. cadeia de caracteres (obrigatório)

ConfigurationApi

Nome Descrição Valor
legacyApi Indica se a API de Configuração herdada (v1) deve ou não ser exposta no serviço Gerenciamento de API. O valor é opcional, mas deve ser 'Habilitado' ou 'Desabilitado'. Se 'Disabled', a API de Configuração herdada (v1) não estará disponível para gateways auto-hospedados. O valor padrão é 'Enabled' 'Desabilitado'
'Enabled'

ApiManagementServiceBasePropertiesCustomProperties

Nome Descrição Valor
{propriedade personalizada} string

HostnameConfiguration

Nome Descrição Valor
certificado Informações de certificado. CertificateInformation
certificatePassword Senha do certificado. string
certificateSource Origem do certificado. 'BuiltIn'
'Personalizado'
'KeyVault'
'Gerenciado'
certificateStatus Status do certificado. 'Concluído'
'Falha'
'InProgress'
defaultSslBinding Especifique true para configurar o certificado associado a esse Nome de Host como o Certificado SSL Padrão. Se um cliente não enviar o cabeçalho SNI, esse será o certificado que será desafiado. A propriedade será útil se um serviço tiver vários nomes de host personalizados habilitados e precisar decidir sobre o certificado ssl padrão. A configuração aplicada somente ao Tipo de Nome do Host do gateway. bool
encodedCertificate Certificado codificado em Base64. string
hostName Nome do host a ser configurado no serviço de Gerenciamento de API. cadeia de caracteres (obrigatório)
identityClientId System ou User Assigned Managed identity clientId, conforme gerado por Azure AD, que tem acesso GET ao keyVault que contém o certificado SSL. string
keyVaultId Url para o Segredo KeyVault que contém o Certificado SsL. Se a URL absoluta que contém a versão for fornecida, a atualização automática do certificado SSL não funcionará. Isso exige que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo application/x-pkcs12 string
negotiateClientCertificate Especifique true para sempre negociar o certificado do cliente no nome do host. O valor padrão é false. bool
tipo Tipo de nome do host. 'ConfigurationApi'
'DeveloperPortal'
'Gerenciamento'
'Portal'
'Proxy'
'Scm' (obrigatório)

RemotePrivateEndpointConnectionWrapper

Nome Descrição Valor
id ID do recurso de conexão do ponto de extremidade privado string
name Nome da conexão do ponto de extremidade privado string
properties Propriedades do recurso. PrivateEndpointConnectionWrapperProperties
tipo Tipo de recurso de conexão de ponto de extremidade privado string

PrivateEndpointConnectionWrapperProperties

Nome Descrição Valor
privateEndpoint O recurso do ponto de extremidade privado. ArmIdWrapper
privateLinkServiceConnectionState Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor. PrivateLinkServiceConnectionState (obrigatório)

ArmIdWrapper

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

PrivateLinkServiceConnectionState

Nome Descrição Valor
actionsRequired Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor. string
descrição O motivo da aprovação/rejeição da conexão. string
status Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço. 'Aprovado'
'Pendente'
'Rejeitado'

Modelos de início rápido

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

Modelo Descrição
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando um modelo

Implantar no Azure		 Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar sub-entidades
Implantar Gerenciamento de API com um Cache do Azure para Redis externo

Implantar no Azure		 Este modelo demonstra como criar uma instância do Azure Gerenciamento de API na camada consumo com uma instância de Cache do Azure para Redis externa como o cache externo Gerenciamento de API.
Implantar Gerenciamento de API na VNet externa com IP público

Implantar no Azure		 Este modelo demonstra como criar uma instância do Azure Gerenciamento de API na camada Premium dentro da sub-rede da rede virtual no modo externo e configurar as regras de 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 de sua assinatura.
Criar uma instância de Gerenciamento de API com nomes de host personalizados

Implantar no Azure		 Este modelo demonstra como criar uma instância do Azure Gerenciamento de API com o nome do host personalizado para o portal e vários nomes de host personalizados para proxy
Criar Gerenciamento de API na VNet interna com o Gateway de Aplicativo

Implantar no Azure		 Este modelo demonstra como Criar uma instância do Azure Gerenciamento de API em uma rede privada protegida por Gateway de Aplicativo do Azure.
Implantar Gerenciamento de API na VNet interna com IP público

Implantar no Azure		 Este modelo demonstra como criar uma instância do Azure Gerenciamento de API na camada Premium dentro da sub-rede da rede virtual no modo interno e configurar as regras de 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 de sua assinatura.
Criar uma instância de Gerenciamento de API com identidade MSI

Implantar no Azure		 Este modelo cria uma instância de desenvolvedor do Azure Gerenciamento de API ter uma identidade MSI
Criar uma instância de Gerenciamento de API da camada Premium de várias regiões

Implantar no Azure		 Este modelo demonstra como criar uma instância de Gerenciamento de API com locais adicionais. O local primário é o mesmo que o local do grupo de recursos. Para locais adicionais, o modelo mostra NorthCentralUs e Leste dos EUA 2. O local primário deve ser diferente dos locais adicionais.
Criar Gerenciamento de API com ssl de proxy personalizado usando o KeyVault

Implantar no Azure		 Este modelo demonstra como Criar uma instância do Azure Gerenciamento de API e configurar o nome do host personalizado para proxy com o certificado SSL do keyvault.
Criar um serviço Gerenciamento de API com SSL do KeyVault

Implantar no Azure		 Este modelo implanta um serviço Gerenciamento de API configurado com a 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 Gerenciamento de API instância

Implantar no Azure		 Este modelo cria uma instância do serviço de Gerenciamento de API do Azure e do workspace 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

Implantar no Azure		 Esse modelo criará um serviço de Gerenciamento de API, uma rede virtual e um ponto de extremidade privado expondo o serviço Gerenciamento de API à rede virtual.
Implantar Gerenciamento de API nas Zonas de Disponibilidade

Implantar no Azure		 Este modelo cria uma instância premium do Azure Gerenciamento de API e implanta em uma Zona de Disponibilidade
Criar uma instância de Gerenciamento de API usando um modelo

Implantar no Azure		 Este modelo cria uma instância de desenvolvedor do Azure Gerenciamento de API
Front Door Standard/Premium com Gerenciamento de API origem

Implantar no Azure		 Este modelo cria um Front Door Premium e uma instância de Gerenciamento de API e usa uma política de Gerenciamento de API global e NSG para validar se o tráfego passou pela origem do Front Door.
Criar o Azure Front Door na frente do Azure Gerenciamento de API

Implantar no Azure		 Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Azure Gerenciamento de API.
Gateway de Aplicativo com Gerenciamento de API interna e Aplicativo Web

Implantar no Azure		 Gateway de Aplicativo roteamento do tráfego da Internet para uma rede virtual (modo interno) Gerenciamento de API instância que atende a uma API Web hospedada em um Aplicativo Web do Azure.

Definição de recurso de modelo do ARM

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

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

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
    "{customized property}": "string"
  "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

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.ApiManagement/service'
apiVersion A versão da API do recurso '2023-05-01-preview'
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 50

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.

O nome do recurso deve ser exclusivo no Azure.
local Local do recurso. cadeia de caracteres (obrigatório)
marcas Marcas de recurso. Dicionário de nomes e valores de marcas. Confira Marcas em modelos
sku Propriedades de SKU do serviço Gerenciamento de API. ApiManagementServiceSkuProperties (obrigatório)
identidade Identidade de serviço gerenciada do serviço de Gerenciamento de API. ApiManagementServiceIdentity
properties Propriedades do serviço Gerenciamento de API. ApiManagementServiceProperties (obrigatório)
zonas Uma lista de zonas de disponibilidade que indica de onde o recurso precisa vir. string[]

ApiManagementServiceIdentity

Nome Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço. 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (obrigatório)
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. A identidade do usuário
As referências de chave de dicionário serão IDs de recurso do ARM no formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} UserIdentityProperties

UserIdentityProperties

Nome Descrição Valor
clientId A ID do cliente da identidade atribuída pelo usuário. string
principalId A ID principal da identidade atribuída pelo usuário. string

ApiManagementServiceProperties

Nome Descrição Valor
additionalLocations Locais de datacenter adicionais do serviço Gerenciamento de API. AdditionalLocation[]
apiVersionConstraint Restrição de versão das Apis do Painel de Controle para o serviço Gerenciamento de API. ApiVersionConstraint
certificates Lista de Certificados que precisam ser instalados no serviço Gerenciamento de API. O máximo de certificados com suporte que podem ser instalados é 10. CertificateConfiguration[]
configurationApi Configuração da API do serviço Gerenciamento de API. ConfigurationApi
customProperties Propriedades personalizadas do serviço Gerenciamento de API.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desabilitará a TLS_RSA_WITH_3DES_EDE_CBC_SHA de criptografia para todos os TLS(1.0, 1.1 e 1.2).
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser usada para desabilitar apenas o TLS 1.1.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser usada para desabilitar o TLS 1.0 em um serviço Gerenciamento de API.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser usada para desabilitar apenas o TLS 1.1 para comunicações com back-ends.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser usada para desabilitar o TLS 1.0 para comunicações com back-ends.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser usada para habilitar o protocolo HTTP2 em um serviço Gerenciamento de API.
Não especificar nenhuma dessas propriedades na operação PATCH redefinirá os valores das propriedades omitidas para seus padrões. Para todas as configurações, exceto Http2, o valor padrão será True se o serviço tiver sido criado em 1º de abril de 2018 ou antes disso False . O valor padrão da configuração http2 é False.

Você pode desabilitar qualquer uma das seguintes codificações usando as configurações Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Por exemplo, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. O valor padrão é true para eles.
Observação: as seguintes criptografias não podem ser desabilitadas, pois são exigidas por componentes internos da plataforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256		 ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus Status do portal do desenvolvedor neste serviço Gerenciamento de API. 'Desabilitado'
'Enabled'
disableGateway Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway em master região. bool
enableClientCertificate Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe que um certificado de cliente seja apresentado em cada solicitação para o gateway. Isso também permite a capacidade de autenticar o certificado na política no gateway. bool
hostnameConfigurations Configuração de nome de host personalizado do serviço Gerenciamento de API. HostnameConfiguration[]
legacyPortalStatus Status do portal herdado no serviço Gerenciamento de API. 'Desabilitado'
'Enabled'
natGatewayState A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API. 'Desabilitado'
'Enabled'
notificationSenderEmail Email endereço do qual a notificação será enviada. string
privateEndpointConnections Lista de Conexões de Ponto de Extremidade Privado deste serviço. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Endereço IP baseado em IP de SKU Padrão Público V4 a ser associado a Rede Virtual serviço implantado na região. Compatível apenas com a implantação do SKU Premium e do Desenvolvedor no Rede Virtual. string
publicNetworkAccess Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço de Gerenciamento de API. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'. Se 'Disabled', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled' 'Desabilitado'
'Enabled'
publisherEmail Email do editor. cadeia de caracteres (obrigatório)
publisherName Nome do publicador. cadeia de caracteres (obrigatório)
restaurar Cancele a exclusão do Serviço de Gerenciamento de API se ele tiver sido excluído temporariamente. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas. bool
virtualNetworkConfiguration Configuração de rede virtual do serviço Gerenciamento de API. VirtualNetworkConfiguration
virtualNetworkType O tipo de VPN no qual Gerenciamento de API serviço precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação do Gerenciamento de API está configurada dentro de um Rede Virtual ter um ponto de extremidade voltado para a Internet e interno significa que Gerenciamento de API A implantação é configurada dentro de uma Rede Virtual ter apenas um ponto de extremidade voltado para a intranet. 'Externo'
'Interno'
'None'

AdditionalLocation

Nome Descrição Valor
disableGateway Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway nesse local adicional. bool
local O nome do local da região adicional entre as regiões do Data center do Azure. cadeia de caracteres (obrigatório)
natGatewayState A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API. 'Desabilitado'
'Enabled'
publicIpAddressId Endereço IP baseado em IP de SKU Padrão Público V4 a ser associado a Rede Virtual serviço implantado no local. Compatível apenas com o SKU Premium que está sendo implantado no Rede Virtual. string
sku Propriedades de SKU do serviço Gerenciamento de API. ApiManagementServiceSkuProperties (obrigatório)
virtualNetworkConfiguration Configuração de rede virtual para o local. VirtualNetworkConfiguration
zonas Uma lista de zonas de disponibilidade que indica de onde o recurso precisa vir. string[]

ApiManagementServiceSkuProperties

Nome Descrição Valor
ALOCADA Capacidade do SKU (número de unidades implantadas do SKU). Para a capacidade de SKU de Consumo, deve ser especificado como 0. int (obrigatório)
name Nome da SKU. 'Básico'
'BasicV2'
'Consumo'
'Developer'
'Isolado'
'Premium'
'Standard'
'StandardV2' (obrigatório)

VirtualNetworkConfiguration

Nome Descrição Valor
subnetResourceId A ID de recurso completa de uma sub-rede em uma rede virtual na qual implantar o serviço Gerenciamento de API. string

ApiVersionConstraint

Nome Descrição Valor
minApiVersion Limite as chamadas à API do painel de controle para Gerenciamento de API serviço com versão igual ou mais recente que esse valor. string

CertificateConfiguration

Nome Descrição Valor
certificado Informações de certificado. CertificateInformation
certificatePassword Senha do certificado. string
encodedCertificate Certificado codificado em Base64. string
storeName O local do repositório de certificados System.Security.Cryptography.x509certificates.StoreName. Somente Root e CertificateAuthority são locais válidos. 'CertificateAuthority'
'Root' (obrigatório)

CertificateInformation

Nome Descrição Valor
data de expiração Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601. cadeia de caracteres (obrigatório)
subject Assunto do certificado. cadeia de caracteres (obrigatório)
thumbprint Impressão digital do certificado. cadeia de caracteres (obrigatório)

ConfigurationApi

Nome Descrição Valor
legacyApi Indica se a API de Configuração herdada (v1) deve ou não ser exposta no serviço Gerenciamento de API. O valor é opcional, mas deve ser 'Habilitado' ou 'Desabilitado'. Se 'Disabled', a API de Configuração herdada (v1) não estará disponível para gateways auto-hospedados. O valor padrão é 'Enabled' 'Desabilitado'
'Enabled'

ApiManagementServiceBasePropertiesCustomProperties

Nome Descrição Valor
{propriedade personalizada} string

HostnameConfiguration

Nome Descrição Valor
certificado Informações de certificado. CertificateInformation
certificatePassword Senha do certificado. string
certificateSource Origem do certificado. 'BuiltIn'
'Custom'
'KeyVault'
'Gerenciado'
certificateStatus Status do Certificado. 'Concluído'
'Falha'
'InProgress'
defaultSslBinding Especifique true para configurar o certificado associado a esse Nome de Host como o Certificado SSL Padrão. Se um cliente não enviar o cabeçalho SNI, esse será o certificado que será contestado. A propriedade será útil se um serviço tiver vários nomes de host personalizados habilitados e precisar decidir sobre o certificado SSL padrão. A configuração aplicada somente ao tipo de nome do host do gateway. bool
encodedCertificate Certificado codificado em Base64. string
hostName Nome do host a ser configurado no serviço de Gerenciamento de API. cadeia de caracteres (obrigatório)
identityClientId ClientId de identidade gerenciada atribuída pelo usuário ou pelo sistema, conforme gerado por Azure AD, que tem acesso GET ao keyVault que contém o certificado SSL. string
keyVaultId URL para o Segredo do KeyVault que contém o Certificado SSL. Se a URL absoluta que contém a versão for fornecida, a atualização automática do certificado SSL não funcionará. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo application/x-pkcs12 string
negotiateClientCertificate Especifique true para sempre negociar o certificado do cliente no nome do host. O valor padrão é false. bool
tipo Tipo de nome do host. 'ConfigurationApi'
'DeveloperPortal'
'Gerenciamento'
'Portal'
'Proxy'
'Scm' (obrigatório)

RemotePrivateEndpointConnectionWrapper

Nome Descrição Valor
id ID do recurso de conexão do ponto de extremidade privado string
name Nome da conexão do ponto de extremidade privado string
properties Propriedades do recurso. PrivateEndpointConnectionWrapperProperties
tipo Tipo de recurso de conexão de ponto de extremidade privado string

PrivateEndpointConnectionWrapperProperties

Nome Descrição Valor
privateEndpoint O recurso do ponto de extremidade privado. ArmIdWrapper
privateLinkServiceConnectionState Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor. PrivateLinkServiceConnectionState (obrigatório)

ArmIdWrapper

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

PrivateLinkServiceConnectionState

Nome Descrição Valor
actionsRequired Uma mensagem indicando se as alterações no provedor de serviços exigem atualizações no consumidor. string
descrição O motivo da aprovação/rejeição da conexão. string
status Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço. 'Aprovado'
'Pendente'
'Rejeitado'

Modelos de início rápido

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

Modelo Descrição
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando um modelo

Implantar no Azure		 Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar sub-entidades
Implantar Gerenciamento de API com um Cache do Azure para Redis externo

Implantar no Azure		 Este modelo demonstra como criar uma instância do Azure Gerenciamento de API na camada consumo com uma instância de Cache do Azure para Redis externa como o cache externo Gerenciamento de API.
Implantar Gerenciamento de API na VNet externa com IP público

Implantar no Azure		 Este modelo demonstra como criar uma instância do Azure Gerenciamento de API na camada Premium dentro da sub-rede da rede virtual no modo externo e configurar as regras de 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 de sua assinatura.
Criar uma instância Gerenciamento de API com nomes de host personalizados

Implantar no Azure		 Este modelo demonstra como criar uma instância do Azure Gerenciamento de API com nome de host personalizado para portal e vários nomes de host personalizados para proxy
Criar Gerenciamento de API na VNet Interna com o Gateway de Aplicativo

Implantar no Azure		 Este modelo demonstra como criar uma instância do Azure Gerenciamento de API em uma rede privada protegida por Gateway de Aplicativo do Azure.
Implantar Gerenciamento de API na VNet interna com IP público

Implantar no Azure		 Este modelo demonstra como criar uma instância do Azure Gerenciamento de API na camada Premium dentro da sub-rede da rede virtual no modo interno e configurar regras de 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 de sua assinatura.
Criar uma instância de Gerenciamento de API com identidade MSI

Implantar no Azure		 Este modelo cria uma instância de desenvolvedor do Azure Gerenciamento de API ter uma identidade MSI
Criar uma instância de Gerenciamento de API de camada Premium de várias regiões

Implantar no Azure		 Este modelo demonstra como criar uma instância de Gerenciamento de API com locais adicionais. O local primário é o mesmo que o local do grupo de recursos. Para locais adicionais, o modelo mostra NorthCentralUs e Leste dos EUA2. O local primário deve ser diferente dos locais adicionais.
Criar Gerenciamento de API com ssl de proxy personalizado usando KeyVault

Implantar no Azure		 Este modelo demonstra como criar uma instância do Azure Gerenciamento de API e configurar o nome de host personalizado para proxy com certificado ssl do keyvault.
Criar um serviço de Gerenciamento de API com SSL do KeyVault

Implantar no Azure		 Este modelo implanta um serviço de Gerenciamento de API configurado com a 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 Gerenciamento de API instância

Implantar no Azure		 Este modelo cria uma instância do serviço Gerenciamento de API do Azure e do workspace 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

Implantar no Azure		 Esse modelo criará um serviço Gerenciamento de API, uma rede virtual e um ponto de extremidade privado expondo o serviço Gerenciamento de API à rede virtual.
Implantar Gerenciamento de API nas Zonas de Disponibilidade

Implantar no Azure		 Este modelo cria uma instância premium do Azure Gerenciamento de API e é implantado em uma Zona de Disponibilidade
Criar uma instância de Gerenciamento de API usando um modelo

Implantar no Azure		 Este modelo cria uma instância de desenvolvedor do Azure Gerenciamento de API
Front Door Standard/Premium com Gerenciamento de API origem

Implantar no Azure		 Este modelo cria um Front Door Premium e uma instância de Gerenciamento de API e usa uma política de Gerenciamento de API global e NSG para validar se o tráfego passou pela origem do Front Door.
Criar o Azure Front Door na frente do Azure Gerenciamento de API

Implantar no Azure		 Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Azure Gerenciamento de API.
Gateway de Aplicativo com Gerenciamento de API interna e Aplicativo Web

Implantar no Azure		 Gateway de Aplicativo roteamento do tráfego da Internet para uma rede virtual (modo interno) Gerenciamento de API instância que atende a uma API Web hospedada em um Aplicativo Web do Azure.

Definição de recurso do Terraform (provedor AzAPI)

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

  • Grupos de recursos

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

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2023-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
    {customized property} = "string"
  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

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.ApiManagement/service@2023-05-01-preview"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 50

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.

O nome do recurso deve ser exclusivo no Azure.
local Local do recurso. cadeia de caracteres (obrigatório)
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. cadeia de caracteres (obrigatório)
marcas Marcas de recurso. Dicionário de nomes e valores de marcas.
sku Propriedades de SKU do serviço Gerenciamento de API. ApiManagementServiceSkuProperties (obrigatório)
identidade Identidade de serviço gerenciada do serviço de Gerenciamento de API. ApiManagementServiceIdentity
properties Propriedades do serviço Gerenciamento de API. ApiManagementServiceProperties (obrigatório)
zonas Uma lista de zonas de disponibilidade que indica de onde o recurso precisa vir. string[]

ApiManagementServiceIdentity

Nome Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned" (obrigatório)
identity_ids A lista de identidades de usuário associadas ao recurso. A identidade do usuário
As referências de chave de dicionário serão IDs de recurso do ARM no formato:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
 Matriz de IDs de identidade do usuário.

ApiManagementServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{propriedade personalizada} UserIdentityProperties

UserIdentityProperties

Nome Descrição Valor
clientId A ID do cliente da identidade atribuída pelo usuário. string
principalId A ID principal da identidade atribuída pelo usuário. string

ApiManagementServiceProperties

Nome Descrição Valor
additionalLocations Locais de datacenter adicionais do serviço Gerenciamento de API. AdditionalLocation[]
apiVersionConstraint Restrição de versão das Apis do Painel de Controle para o serviço Gerenciamento de API. ApiVersionConstraint
certificates Lista de Certificados que precisam ser instalados no serviço Gerenciamento de API. O máximo de certificados com suporte que podem ser instalados é 10. CertificateConfiguration[]
configurationApi Configuração da API do serviço Gerenciamento de API. ConfigurationApi
customProperties Propriedades personalizadas do serviço Gerenciamento de API.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desabilitará a TLS_RSA_WITH_3DES_EDE_CBC_SHA de criptografia para todos os TLS(1.0, 1.1 e 1.2).
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser usada para desabilitar apenas o TLS 1.1.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser usada para desabilitar o TLS 1.0 em um serviço Gerenciamento de API.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser usada para desabilitar apenas o TLS 1.1 para comunicações com back-ends.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser usada para desabilitar o TLS 1.0 para comunicações com back-ends.
A configuração Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser usada para habilitar o protocolo HTTP2 em um serviço Gerenciamento de API.
Não especificar nenhuma dessas propriedades na operação PATCH redefinirá os valores das propriedades omitidas para seus padrões. Para todas as configurações, exceto Http2, o valor padrão será True se o serviço tiver sido criado em 1º de abril de 2018 ou antes disso False . O valor padrão da configuração http2 é False.

Você pode desabilitar qualquer uma das seguintes codificações usando as configurações Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Por exemplo, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. O valor padrão é true para eles.
Observação: as seguintes criptografias não podem ser desabilitadas, pois são exigidas por componentes internos da plataforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256		 ApiManagementServiceBasePropertiesCustomProperties
developerPortalStatus Status do portal do desenvolvedor neste serviço de Gerenciamento de API. "Desabilitado"
"Habilitado"
disableGateway Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway em master região. bool
enableClientCertificate Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe que um certificado do cliente seja apresentado em cada solicitação para o gateway. Isso também permite a capacidade de autenticar o certificado na política no gateway. bool
hostnameConfigurations Configuração de nome de host personalizado do serviço Gerenciamento de API. HostnameConfiguration[]
legacyPortalStatus Status do portal herdado no serviço Gerenciamento de API. "Desabilitado"
"Habilitado"
natGatewayState A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API. "Desabilitado"
"Habilitado"
notificationSenderEmail Email endereço do qual a notificação será enviada. string
privateEndpointConnections Lista de conexões de ponto de extremidade privado desse serviço. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Endereço IP baseado em IP de SKU padrão público V4 a ser associado a Rede Virtual serviço implantado na região. Compatível apenas com o SKU Premium e desenvolvedor que está sendo implantado no Rede Virtual. string
publicNetworkAccess Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço Gerenciamento de API. O valor é opcional, mas, se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Desabilitado', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled' "Desabilitado"
"Habilitado"
publisherEmail Email do publicador. cadeia de caracteres (obrigatório)
publisherName Nome do publicador. cadeia de caracteres (obrigatório)
restaurar Desmarque o Serviço de Gerenciamento de API se ele tiver sido excluído anteriormente. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas. bool
virtualNetworkConfiguration Configuração de rede virtual do serviço Gerenciamento de API. VirtualNetworkConfiguration
virtualNetworkType O tipo de VPN no qual Gerenciamento de API serviço precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhum Rede Virtual, Externo significa que a implantação do Gerenciamento de API está configurada dentro de um Rede Virtual ter um ponto de extremidade voltado para a Internet e o interno significa que Gerenciamento de API a implantação é configurada dentro de um Rede Virtual ter apenas um ponto de extremidade voltado para intranet. "Externo"
"Interno"
"None"

AdditionalLocation

Nome Descrição Valor
disableGateway Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway neste local adicional. bool
local O nome da localização da região adicional entre as regiões do Data center do Azure. cadeia de caracteres (obrigatório)
natGatewayState A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API. "Desabilitado"
"Habilitado"
publicIpAddressId Endereço IP baseado em IP de SKU padrão público V4 a ser associado a Rede Virtual serviço implantado no local. Compatível apenas com o SKU Premium que está sendo implantado no Rede Virtual. string
sku Propriedades de SKU do serviço Gerenciamento de API. ApiManagementServiceSkuProperties (obrigatório)
virtualNetworkConfiguration Configuração de rede virtual para o local. VirtualNetworkConfiguration
zonas Uma lista de zonas de disponibilidade que indica de onde o recurso precisa vir. string[]

ApiManagementServiceSkuProperties

Nome Descrição Valor
ALOCADA Capacidade do SKU (número de unidades implantadas do SKU). Para a capacidade de SKU de Consumo, deve ser especificado como 0. int (obrigatório)
name Nome do Sku. “Basic”
"BasicV2"
"Consumo"
"Desenvolvedor"
"Isolado"
"Premium"
"Standard"
"StandardV2" (obrigatório)

VirtualNetworkConfiguration

Nome Descrição Valor
subnetResourceId A ID de recurso completa de uma sub-rede em uma rede virtual na qual implantar o serviço Gerenciamento de API. string

ApiVersionConstraint

Nome Descrição Valor
minApiVersion Limite as chamadas à API do painel de controle para Gerenciamento de API serviço com versão igual ou mais recente que esse valor. string

CertificateConfiguration

Nome Descrição Valor
certificado Informações de certificado. CertificateInformation
certificatePassword Senha do certificado. string
encodedCertificate Certificado codificado em Base64. string
storeName O local do repositório de certificados System.Security.Cryptography.x509certificates.StoreName. Somente Root e CertificateAuthority são locais válidos. "CertificateAuthority"
"Raiz" (obrigatório)

CertificateInformation

Nome Descrição Valor
data de expiração Data de validade do certificado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601. cadeia de caracteres (obrigatório)
subject Assunto do certificado. cadeia de caracteres (obrigatório)
thumbprint Impressão digital do certificado. cadeia de caracteres (obrigatório)

ConfigurationApi

Nome Descrição Valor
legacyApi Indica se a API de Configuração herdada (v1) deve ou não ser exposta no serviço Gerenciamento de API. O valor é opcional, mas deve ser 'Habilitado' ou 'Desabilitado'. Se 'Disabled', a API de Configuração herdada (v1) não estará disponível para gateways auto-hospedados. O valor padrão é 'Enabled' "Desabilitado"
"Habilitado"

ApiManagementServiceBasePropertiesCustomProperties

Nome Descrição Valor
{propriedade personalizada} string

HostnameConfiguration

Nome Descrição Valor
certificado Informações de certificado. CertificateInformation
certificatePassword Senha do certificado. string
certificateSource Origem do certificado. "BuiltIn"
“Personalizado”
"KeyVault"
"Gerenciado"
certificateStatus Status do Certificado. "Concluído"
"Falha"
"InProgress"
defaultSslBinding Especifique true para configurar o certificado associado a esse Nome de Host como o Certificado SSL Padrão. Se um cliente não enviar o cabeçalho SNI, esse será o certificado que será contestado. A propriedade será útil se um serviço tiver vários nomes de host personalizados habilitados e precisar decidir sobre o certificado SSL padrão. A configuração aplicada somente ao tipo de nome do host do gateway. bool
encodedCertificate Certificado codificado em Base64. string
hostName Nome do host a ser configurado no serviço de Gerenciamento de API. cadeia de caracteres (obrigatório)
identityClientId ClientId de identidade gerenciada atribuída pelo usuário ou pelo sistema, conforme gerado por Azure AD, que tem acesso GET ao keyVault que contém o certificado SSL. string
keyVaultId URL para o Segredo do KeyVault que contém o Certificado SSL. Se a URL absoluta que contém a versão for fornecida, a atualização automática do certificado SSL não funcionará. Isso requer que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo application/x-pkcs12 string
negotiateClientCertificate Especifique true para sempre negociar o certificado do cliente no nome do host. O valor padrão é false. bool
tipo Tipo de nome do host. "ConfigurationApi"
"DeveloperPortal"
"Gerenciamento"
"Portal"
"Proxy"
"Scm" (obrigatório)

RemotePrivateEndpointConnectionWrapper

Nome Descrição Valor
id ID do recurso de conexão do ponto de extremidade privado string
name Nome da conexão do ponto de extremidade privado string
properties Propriedades do recurso. PrivateEndpointConnectionWrapperProperties
tipo Tipo de recurso de conexão de ponto de extremidade privado string

PrivateEndpointConnectionWrapperProperties

Nome Descrição Valor
privateEndpoint O recurso do ponto de extremidade privado. ArmIdWrapper
privateLinkServiceConnectionState Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor. PrivateLinkServiceConnectionState (obrigatório)

ArmIdWrapper

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

PrivateLinkServiceConnectionState

Nome Descrição Valor
actionsRequired Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor. string
descrição O motivo da aprovação/rejeição da conexão. string
status Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço. "Aprovado"
"Pendente"
"Rejeitado"