Serviço Microsoft.ApiManagement

  • Artigo

Definição de recurso do Bicep

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

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

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/serviço, adicione o seguinte Bicep ao seu 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 (obrigatório)

Limite de carateres: 1-50

Carateres válidos:
Alfanuméricos e hífenes.

Comece com letra e termine com alfanumérico.

O nome do recurso tem de ser exclusivo em todo o Azure.
localização Localização do recurso. cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku Propriedades do SKU do serviço Gestão de API. ApiManagementServiceSkuProperties (obrigatório)
identidade Identidade de serviço gerida do serviço de Gestão de API. ApiManagementServiceIdentity
propriedades Propriedades do serviço Gestão de API. ApiManagementServiceProperties (obrigatório)
zonas Uma lista de zonas de disponibilidade que indica de onde o recurso precisa de vir. string[]

ApiManagementServiceIdentity

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

ApiManagementServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{customized property} UserIdentityProperties

UserIdentityProperties

Nome Descrição Valor
clientId O ID de cliente da identidade atribuída pelo utilizador. string
principalId O ID principal da identidade atribuída pelo utilizador. string

ApiManagementServiceProperties

Nome Descrição Valor
additionalLocations Localizações adicionais do datacenter do serviço Gestão de API. AdditionalLocation[]
apiVersionConstraint Restrição da versão das Apis do Plano de Controlo para o serviço Gestão de API. ApiVersionConstraint
certificados Lista de Certificados que têm de ser instalados no serviço Gestão de API. O máximo de certificados suportados que podem ser instalados é 10. CertificateConfiguration[]
configurationApi Configuração da API de Configuração do serviço Gestão de API. ConfigurationApi
customProperties Propriedades personalizadas do serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desativará a cifra TLS_RSA_WITH_3DES_EDE_CBC_SHA para todos os TLS(1.0, 1.1 e 1.2).
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 num serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser utilizada para ativar o protocolo HTTP2 num serviço Gestão de API.
Não especificar nenhuma destas propriedades na operação PATCH irá repor os valores das propriedades omitidas para as respetivas predefinições. Para todas as definições exceto Http2, o valor predefinido é True se o serviço foi criado em ou antes de 1 de abril de 2018 e False de outra forma. O valor predefinido da definição http2 é False.

Pode desativar qualquer uma das seguintes cifras com as definiçõ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 predefinido é true para eles.
Nota: as cifras seguintes não podem ser desativadas, uma vez que são necessárias 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 Estado do portal do programador neste serviço Gestão de API. "Desativado"
"Ativado"
disableGateway Propriedade apenas válida para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway na região mestra. bool
enableClientCertificate A propriedade destina-se apenas a ser utilizada para o Serviço SKU de Consumo. Isto impõe a apresentação de um certificado de cliente em cada pedido ao gateway. Isto também permite autenticar o certificado na política no gateway. bool
hostnameConfigurations Configuração personalizada do nome de anfitrião do serviço Gestão de API. HostnameConfiguration[]
legacyPortalStatus Estado do portal legado no serviço Gestão de API. "Desativado"
"Ativado"
natGatewayState A propriedade pode ser utilizada para ativar o NAT Gateway para este serviço de Gestão de API. "Desativado"
"Ativado"
notificationSenderEmail Email endereço a partir do qual a notificação será enviada. string
privateEndpointConnections Lista de Ligações de Ponto Final Privado deste serviço. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Endereço IP V4 baseado em IP do SKU Standard Público a ser associado a Rede Virtual serviço implementado na região. Suportada apenas para o Programador e o SKU Premium que está a ser implementado no Rede Virtual. string
publicNetworkAccess Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado" "Desativado"
"Ativado"
publisherEmail E-mail do publicador. cadeia (obrigatório)
publisherName Nome do publicador. cadeia (obrigatório)
restore Anular a eliminação do Serviço de Gestão de API se tiver sido eliminado de forma recuperável anteriormente. Se este sinalizador for especificado e definido como Verdadeiro, todas as outras propriedades serão ignoradas. bool
virtualNetworkConfiguration Configuração da rede virtual do serviço Gestão de API. VirtualNetworkConfiguration
virtualNetworkType O tipo de VPN na qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhuma Rede Virtual, Externo significa que a implementação Gestão de API está configurada num Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet. "Externo"
"Interno"
"Nenhum"

AdditionalLocation

Nome Descrição Valor
disableGateway Propriedade apenas válida para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway nesta localização adicional. bool
localização O nome da localização da região adicional entre as regiões do Datacenter do Azure. cadeia (obrigatório)
natGatewayState A propriedade pode ser utilizada para ativar o NAT Gateway para este serviço de Gestão de API. "Desativado"
"Ativado"
publicIpAddressId Endereço IP V4 de IP do SKU Standard Público a ser associado a Rede Virtual serviço implementado na localização. Suportada apenas para o SKU Premium que está a ser implementado no Rede Virtual. string
sku Propriedades do SKU do serviço Gestão de API. ApiManagementServiceSkuProperties (obrigatório)
virtualNetworkConfiguration Configuração da rede virtual para a localização. VirtualNetworkConfiguration
zonas Uma lista de zonas de disponibilidade que indica a origem do recurso. cadeia[]

ApiManagementServiceSkuProperties

Nome Descrição Valor
capacidade Capacidade do SKU (número de unidades implementadas do SKU). Para a capacidade de SKU de Consumo tem de ser especificada como 0. int (obrigatório)
name Nome do SKU. "Básico"
"BasicV2"
"Consumo"
"Programador"
"Isolado"
"Premium"
'Standard'
"StandardV2" (obrigatório)

VirtualNetworkConfiguration

Nome Descrição Valor
subnetResourceId O ID de recurso completo de uma sub-rede numa rede virtual para implementar o serviço Gestão de API. string

ApiVersionConstraint

Nome Descrição Valor
minApiVersion Limite as chamadas à API do plano de controlo para Gestão de API serviço com uma versão igual ou mais recente do que este valor. string

CertificateConfiguration

Nome Descrição Valor
certificado Informações do certificado. CertificateInformation
certificatePassword Palavra-passe do Certificado. string
codificarCertificate Certificado codificado base64. string
storeName A localização do arquivo de certificados System.Security.Cryptography.x509certificates.StoreName. Apenas Root e CertificateAuthority são localizações válidas. "CertificateAuthority"
"Raiz" (obrigatório)

CertificateInformation

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

ConfigurationApi

Nome Descrição Valor
legacyApi Indica se a API de Configuração legada (v1) deve ou não ser exposta no serviço de Gestão de API. O valor é opcional, mas tem de ser "Ativado" ou "Desativado". Se "Desativado", a API de Configuração legada (v1) não estará disponível para gateways autoalojados. O valor predefinido é "Ativado" "Desativado"
"Ativado"

ApiManagementServiceBasePropertiesCustomProperties

Nome Descrição Valor
{customized property} string

HostnameConfiguration

Nome Descrição Valor
certificado Informações do certificado. CertificateInformation
certificatePassword Palavra-passe do Certificado. string
certificateSource Origem do Certificado. 'BuiltIn'
"Personalizado"
'KeyVault'
"Gerido"
certificateStatus Estado do Certificado. "Concluído"
"Com falhas"
"Entrada"
defaultSslBinding Especifique true para configurar o certificado associado a este Nome de Anfitrião como o Certificado SSL Predefinido. Se um cliente não enviar o cabeçalho SNI, este será o certificado que será contestado. A propriedade é útil se um serviço tiver vários nomes de anfitrião personalizados ativados e precisar de decidir sobre o certificado ssl predefinido. A definição só foi aplicada ao Tipo de Nome de Anfitrião do gateway. bool
codificadoCertificate Certificado codificado Base64. string
hostName Nome do anfitrião a configurar no serviço de Gestão de API. cadeia (obrigatório)
identityClientId ClientId de identidade gerida atribuída pelo sistema ou pelo utilizador, tal como gerado pelo 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 for fornecido um URL absoluto que contenha a versão, a atualização automática do certificado SSL não funcionará. Isto requer que o serviço de Gestão de API seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo application/x-pkcs12 string
negotiateClientCertificate Especifique true para negociar sempre o certificado de cliente no nome do anfitrião. O Valor Predefinido é falso. bool
tipo Tipo de nome de anfitrião. "ConfigurationApi"
"DeveloperPortal"
"Gestão"
'Portal'
'Proxy'
'Scm' (obrigatório)

RemotePrivateEndpointConnectionWrapper

Nome Descrição Valor
ID ID do recurso de ligação de Ponto Final Privado string
name Nome da Ligação do Ponto Final Privado string
propriedades Propriedades do recurso. PrivateEndpointConnectionWrapperProperties
tipo Tipo de Recurso de Ligação de Ponto Final Privado string

PrivateEndpointConnectionWrapperProperties

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

ArmIdWrapper

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrição Valor
actionsRequired Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor. string
descrição O motivo da aprovação/rejeição da ligação. string
status Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço. "Aprovado"
"Pendente"
"Rejeitado"

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar uma instância da Gestão de API e todos os sub-recursos com modelo

Implementar no Azure		 Este modelo demonstra como criar um serviço de Gestão de API e configurar sub entidades
Implementar Gestão de API com uma Cache do Azure para Redis externa

Implementar no Azure		 Este modelo demonstra como criar uma instância do Azure Gestão de API no escalão Consumo com uma instância de Cache do Azure para Redis externa como a Gestão de API cache externa.
Implementar Gestão de API na VNet externa com IP público

Implementar no Azure		 Este modelo demonstra como criar uma instância do Azure Gestão de API no escalão Premium na sub-rede da sua rede virtual no modo externo e configurar regras NSG recomendadas na sub-rede. A instância é implementada em duas zonas de disponibilidade. O modelo também configura um endereço IP público a partir da sua subscrição.
Criar uma instância Gestão de API com nomes de anfitrião personalizados

Implementar no Azure		 Este modelo demonstra como criar uma instância do Azure Gestão de API com o nome de anfitrião personalizado para o portal e vários nomes de anfitrião personalizados para proxy
Criar Gestão de API na VNet Interna com o Gateway de Aplicação

Implementar no Azure		 Este modelo demonstra como Criar uma instância do Azure Gestão de API numa rede privada protegida por Gateway de Aplicação do Azure.
Implementar Gestão de API na VNet interna com IP público

Implementar no Azure		 Este modelo demonstra como criar uma instância do Azure Gestão de API no escalão Premium na sub-rede da rede virtual no modo interno e configurar as regras de NSG recomendadas na sub-rede. A instância é implementada em duas zonas de disponibilidade. O modelo também configura um endereço IP público a partir da sua subscrição.
Criar uma instância Gestão de API com a Identidade MSI

Implementar no Azure		 Este modelo cria uma instância de programador do Azure Gestão de API ter uma Identidade MSI
Criar um escalão Premium de várias regiões Gestão de API instância

Implementar no Azure		 Este modelo demonstra como criar uma instância Gestão de API com localizações adicionais. A localização primária é a mesma que a localização do grupo de recursos. Para localizações adicionais, o modelo mostra NorthCentralUs e E.U.A. Leste2. A localização primária deve ser diferente das localizações adicionais.
Criar Gestão de API com ssl de proxy personalizado com o KeyVault

Implementar no Azure		 Este modelo demonstra como Criar uma instância do Azure Gestão de API e configurar o nome de anfitrião personalizado para proxy com o certificado SSL do keyvault.
Criar um serviço de Gestão de API com SSL a partir do KeyVault

Implementar no Azure		 Este modelo implementa um serviço de Gestão de API configurado com a Identidade Atribuída pelo Utilizador. Utiliza esta identidade para obter o certificado SSL do KeyVault e mantém-no atualizado ao verificar a cada 4 horas.
Criar e monitorizar Gestão de API instância

Implementar no Azure		 Este modelo cria uma instância do serviço do Azure Gestão de API e da área de trabalho do Log Analytics e configura a monitorização do seu serviço de Gestão de API com o Log Analytics
Criar um serviço de Gestão de API com um ponto final privado

Implementar no Azure		 Este modelo irá criar um serviço Gestão de API, uma rede virtual e um ponto final privado expondo o serviço Gestão de API à rede virtual.
Implementar Gestão de API em Zonas de Disponibilidade

Implementar no Azure		 Este modelo cria uma instância premium do Azure Gestão de API e implementa numa Zona de Disponibilidade
Criar uma instância de Gestão de API com um modelo

Implementar no Azure		 Este modelo cria uma instância de programador do Azure Gestão de API
Front Door Standard/Premium com origem Gestão de API

Implementar no Azure		 Este modelo cria um Front Door Premium e uma instância de Gestão de API e utiliza um NSG e uma política de Gestão de API global para validar que o tráfego passou pela origem do Front Door.
Criar o Azure Front Door em frente ao Azure Gestão de API

Implementar no Azure		 Este exemplo demonstra como utilizar o Azure Front Door como um balanceador de carga global em frente ao Azure Gestão de API.
Gateway de Aplicação com o Gestão de API interno e a Aplicação Web

Implementar no Azure		 Gateway de Aplicação encaminhar o tráfego da Internet para uma rede virtual (modo interno) Gestão de API instância que presta serviços a uma API Web alojada numa Aplicação Web do Azure.

Definição de recurso do modelo arm

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

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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-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 de recursos '2023-05-01-preview'
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-50

Carateres válidos:
Alfanuméricos e hífenes.

Comece com letra e termine com alfanumérico.

O nome do recurso tem de ser exclusivo em todo o Azure.
localização Localização do recurso. cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku Propriedades do SKU do serviço Gestão de API. ApiManagementServiceSkuProperties (obrigatório)
identidade Identidade de serviço gerida do serviço de Gestão de API. ApiManagementServiceIdentity
propriedades Propriedades do serviço Gestão de API. ApiManagementServiceProperties (obrigatório)
zonas Uma lista de zonas de disponibilidade que indica de onde o recurso precisa de vir. string[]

ApiManagementServiceIdentity

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

ApiManagementServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{customized property} UserIdentityProperties

UserIdentityProperties

Nome Descrição Valor
clientId O ID de cliente da identidade atribuída pelo utilizador. string
principalId O ID principal da identidade atribuída pelo utilizador. string

ApiManagementServiceProperties

Nome Descrição Valor
additionalLocations Localizações adicionais do datacenter do serviço Gestão de API. AdditionalLocation[]
apiVersionConstraint Restrição da versão das Apis do Plano de Controlo para o serviço Gestão de API. ApiVersionConstraint
certificados Lista de Certificados que têm de ser instalados no serviço Gestão de API. O máximo de certificados suportados que podem ser instalados é 10. CertificateConfiguration[]
configurationApi Configuração da API de Configuração do serviço Gestão de API. ConfigurationApi
customProperties Propriedades personalizadas do serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desativará a cifra TLS_RSA_WITH_3DES_EDE_CBC_SHA para todos os TLS(1.0, 1.1 e 1.2).
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 num serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser utilizada para ativar o protocolo HTTP2 num serviço Gestão de API.
Não especificar nenhuma destas propriedades na operação PATCH irá repor os valores das propriedades omitidas para as respetivas predefinições. Para todas as definições exceto Http2, o valor predefinido é True se o serviço foi criado em ou antes de 1 de abril de 2018 e False de outra forma. O valor predefinido da definição http2 é False.

Pode desativar qualquer uma das seguintes cifras com as definiçõ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 predefinido é true para eles.
Nota: as cifras seguintes não podem ser desativadas, uma vez que são necessárias 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 Estado do portal do programador neste serviço Gestão de API. "Desativado"
"Ativado"
disableGateway Propriedade apenas válida para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway na região mestra. bool
enableClientCertificate A propriedade destina-se apenas a ser utilizada para o Serviço SKU de Consumo. Isto impõe a apresentação de um certificado de cliente em cada pedido ao gateway. Isto também permite autenticar o certificado na política no gateway. bool
hostnameConfigurations Configuração personalizada do nome de anfitrião do serviço Gestão de API. HostnameConfiguration[]
legacyPortalStatus Estado do portal legado no serviço Gestão de API. "Desativado"
"Ativado"
natGatewayState A propriedade pode ser utilizada para ativar o NAT Gateway para este serviço de Gestão de API. "Desativado"
"Ativado"
notificationSenderEmail Email endereço a partir do qual a notificação será enviada. string
privateEndpointConnections Lista de Ligações de Ponto Final Privado deste serviço. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Endereço IP V4 baseado em IP do SKU Standard Público a ser associado a Rede Virtual serviço implementado na região. Suportada apenas para o Programador e o SKU Premium que está a ser implementado no Rede Virtual. string
publicNetworkAccess Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado" "Desativado"
"Ativado"
publisherEmail E-mail do Publisher. cadeia (obrigatório)
publisherName Nome do publicador. cadeia (obrigatório)
restore Anular a eliminação do Serviço de Gestão de API se tiver sido eliminado de forma recuperável anteriormente. Se este sinalizador for especificado e definido como Verdadeiro, todas as outras propriedades serão ignoradas. bool
virtualNetworkConfiguration Configuração da rede virtual do serviço Gestão de API. VirtualNetworkConfiguration
virtualNetworkType O tipo de VPN no qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhum Rede Virtual, Externo significa que a implementação do Gestão de API está configurada dentro de um Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet. "Externo"
"Interno"
"Nenhum"

AdditionalLocation

Nome Descrição Valor
disableGateway Propriedade válida apenas para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway nesta localização adicional. bool
localização O nome da localização da região adicional entre as regiões do Centro de Dados do Azure. cadeia (obrigatório)
natGatewayState A propriedade pode ser utilizada para ativar o NAT Gateway para este serviço de Gestão de API. "Desativado"
"Ativado"
publicIpAddressId Endereço IP baseado em IP V4 do SKU Standard público a ser associado ao serviço implementado Rede Virtual na localização. Suportado apenas para o SKU Premium que está a ser implementado no Rede Virtual. string
sku Propriedades de SKU do serviço Gestão de API. ApiManagementServiceSkuProperties (obrigatório)
virtualNetworkConfiguration Configuração da rede virtual para a localização. VirtualNetworkConfiguration
zonas Uma lista de zonas de disponibilidade que indica a origem do recurso. cadeia[]

ApiManagementServiceSkuProperties

Nome Descrição Valor
capacidade Capacidade do SKU (número de unidades implementadas do SKU). Para a capacidade de SKU de Consumo tem de ser especificada como 0. int (obrigatório)
name Nome do SKU. "Básico"
"BasicV2"
"Consumo"
"Programador"
"Isolado"
"Premium"
'Standard'
"StandardV2" (obrigatório)

VirtualNetworkConfiguration

Nome Descrição Valor
subnetResourceId O ID de recurso completo de uma sub-rede numa rede virtual para implementar o serviço Gestão de API. string

ApiVersionConstraint

Nome Descrição Valor
minApiVersion Limite as chamadas à API do plano de controlo para Gestão de API serviço com uma versão igual ou mais recente do que este valor. string

CertificateConfiguration

Nome Descrição Valor
certificado Informações do certificado. CertificateInformation
certificatePassword Palavra-passe do Certificado. string
codificarCertificate Certificado codificado base64. string
storeName A localização do arquivo de certificados System.Security.Cryptography.x509certificates.StoreName. Apenas Root e CertificateAuthority são localizações válidas. "CertificateAuthority"
"Raiz" (obrigatório)

CertificateInformation

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

ConfigurationApi

Nome Descrição Valor
legacyApi Indica se a API de Configuração legada (v1) deve ou não ser exposta no serviço de Gestão de API. O valor é opcional, mas tem de ser "Ativado" ou "Desativado". Se "Desativado", a API de Configuração legada (v1) não estará disponível para gateways autoalojados. O valor predefinido é "Ativado" "Desativado"
"Ativado"

ApiManagementServiceBasePropertiesCustomProperties

Nome Descrição Valor
{customized property} string

HostnameConfiguration

Nome Descrição Valor
certificado Informações do certificado. CertificateInformation
certificatePassword Palavra-passe do Certificado. string
certificateSource Origem do Certificado. 'BuiltIn'
"Personalizado"
'KeyVault'
"Gerido"
certificateStatus Estado do Certificado. "Concluído"
"Falha"
"Entrada"
defaultSslBinding Especifique true para configurar o certificado associado a este Nome de Anfitrião como Certificado SSL Predefinido. Se um cliente não enviar o cabeçalho SNI, este será o certificado que será contestado. A propriedade é útil se um serviço tiver vários nomes de anfitrião personalizados ativados e precisar de decidir sobre o certificado ssl predefinido. A definição só é aplicada ao Tipo de Nome de Anfitrião do gateway. bool
codificarCertificate Certificado codificado base64. string
hostName Nome do anfitrião para configurar no serviço de Gestão de API. cadeia (obrigatório)
identityClientId System or User Assigned Managed identity clientId como gerado pelo 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 for fornecido um URL absoluto que contenha a versão, a atualização automática do certificado ssl não funcionará. Isto requer que o serviço de Gestão de API seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo aplicação/x-pkcs12 string
negotiateClientCertificate Especifique true para negociar sempre o certificado de cliente no nome do anfitrião. O Valor Predefinido é falso. bool
tipo Tipo de nome de anfitrião. "ConfigurationApi"
"DeveloperPortal"
"Gestão"
'Portal'
"Proxy"
"Scm" (obrigatório)

RemotePrivateEndpointConnectionWrapper

Nome Descrição Valor
ID ID do recurso de ligação de Ponto Final Privado string
name Nome da Ligação de Ponto Final Privado string
propriedades Propriedades do recurso. PrivateEndpointConnectionWrapperProperties
tipo Tipo de Recurso de Ligação de Ponto Final Privado string

PrivateEndpointConnectionWrapperProperties

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

ArmIdWrapper

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrição Valor
actionsRequired Uma mensagem a indicar se as alterações no fornecedor de serviços necessitam de atualizações no consumidor. string
descrição O motivo da aprovação/rejeição da ligação. string
status Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço. "Aprovado"
"Pendente"
"Rejeitado"

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar uma instância da Gestão de API e todos os sub-recursos com modelo

Implementar no Azure		 Este modelo demonstra como criar um serviço de Gestão de API e configurar sub entidades
Implementar Gestão de API com uma Cache do Azure para Redis externa

Implementar no Azure		 Este modelo demonstra como criar uma instância do Azure Gestão de API na camada Consumo com uma instância de Cache do Azure para Redis externa como a Gestão de API cache externa.
Implementar Gestão de API na VNet externa com IP público

Implementar no Azure		 Este modelo demonstra como criar uma instância do Azure Gestão de API no escalão Premium na sub-rede da rede virtual no modo externo e configurar regras de NSG recomendadas na sub-rede. A instância é implementada em duas zonas de disponibilidade. O modelo também configura um endereço IP público a partir da sua subscrição.
Criar uma instância de Gestão de API com nomes de anfitrião personalizados

Implementar no Azure		 Este modelo demonstra como criar uma instância do Azure Gestão de API com o nome de anfitrião personalizado para o portal e vários nomes de anfitrião personalizados para proxy
Criar Gestão de API na VNet Interna com o Gateway de Aplicação

Implementar no Azure		 Este modelo demonstra como Criar uma instância do Azure Gestão de API numa rede privada protegida por Gateway de Aplicação do Azure.
Implementar Gestão de API na VNet interna com IP público

Implementar no Azure		 Este modelo demonstra como criar uma instância do Azure Gestão de API no escalão Premium na sub-rede da rede virtual no modo interno e configurar regras de NSG recomendadas na sub-rede. A instância é implementada em duas zonas de disponibilidade. O modelo também configura um endereço IP público a partir da sua subscrição.
Criar uma instância Gestão de API com a Identidade MSI

Implementar no Azure		 Este modelo cria uma instância de programador do Azure Gestão de API ter uma Identidade MSI
Criar uma instância de Gestão de API de escalão Premium de várias regiões

Implementar no Azure		 Este modelo demonstra como criar uma instância Gestão de API com localizações adicionais. A localização primária é a mesma que a localização do grupo de recursos. Para localizações adicionais, o modelo mostra NorthCentralUs e E.U.A. Leste2. A localização primária deve ser diferente das localizações adicionais.
Criar Gestão de API com ssl de proxy personalizado com o KeyVault

Implementar no Azure		 Este modelo demonstra como Criar uma instância do Azure Gestão de API e configurar o nome de anfitrião personalizado para proxy com certificado ssl do keyvault.
Criar um serviço de Gestão de API com SSL a partir do KeyVault

Implementar no Azure		 Este modelo implementa um serviço Gestão de API configurado com a Identidade Atribuída pelo Utilizador. Utiliza esta identidade para obter o certificado SSL do KeyVault e mantém-no atualizado ao verificar a cada 4 horas.
Criar e monitorizar Gestão de API instância

Implementar no Azure		 Este modelo cria uma instância do serviço Gestão de API do Azure e da área de trabalho do Log Analytics e configura a monitorização do seu serviço de Gestão de API com o Log Analytics
Criar um serviço Gestão de API com um ponto final privado

Implementar no Azure		 Este modelo irá criar um serviço Gestão de API, uma rede virtual e um ponto final privado expondo o serviço Gestão de API à rede virtual.
Implementar Gestão de API em Zonas de Disponibilidade

Implementar no Azure		 Este modelo cria uma instância premium do Azure Gestão de API e implementa numa Zona de Disponibilidade
Criar uma instância de Gestão de API com um modelo

Implementar no Azure		 Este modelo cria uma instância de programador do Azure Gestão de API
Front Door Standard/Premium com origem Gestão de API

Implementar no Azure		 Este modelo cria um Front Door Premium e uma instância de Gestão de API e utiliza uma política de Gestão de API global e NSG para validar que o tráfego passou pela origem do Front Door.
Criar o Azure Front Door em frente ao Azure Gestão de API

Implementar no Azure		 Este exemplo demonstra como utilizar o Azure Front Door como um balanceador de carga global em frente ao Azure Gestão de API.
Gateway de Aplicação com o Gestão de API interno e a Aplicação Web

Implementar no Azure		 Gateway de Aplicação encaminhar o tráfego da Internet para uma rede virtual (modo interno) Gestão de API instância que presta serviços a uma API Web alojada numa Aplicação Web do Azure.

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

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

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo 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-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 (obrigatório)

Limite de carateres: 1-50

Carateres válidos:
Alfanuméricos e hífenes.

Comece com letra e termine com alfanumérico.

O nome do recurso tem de ser exclusivo em todo o Azure.
localização Localização do recurso. cadeia (obrigatório)
parent_id Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. cadeia (obrigatório)
etiquetas Etiquetas de recursos. Dicionário de nomes e valores de etiquetas.
sku Propriedades do SKU do serviço Gestão de API. ApiManagementServiceSkuProperties (obrigatório)
identidade Identidade de serviço gerida do serviço de Gestão de API. ApiManagementServiceIdentity
propriedades Propriedades do serviço Gestão de API. ApiManagementServiceProperties (obrigatório)
zonas Uma lista de zonas de disponibilidade que indica de onde o recurso precisa de vir. string[]

ApiManagementServiceIdentity

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

ApiManagementServiceIdentityUserAssignedIdentities

Nome Descrição Valor
{customized property} UserIdentityProperties

UserIdentityProperties

Nome Descrição Valor
clientId O ID de cliente da identidade atribuída pelo utilizador. string
principalId O ID principal da identidade atribuída pelo utilizador. string

ApiManagementServiceProperties

Nome Descrição Valor
additionalLocations Localizações adicionais do datacenter do serviço Gestão de API. AdditionalLocation[]
apiVersionConstraint Restrição da versão das Apis do Plano de Controlo para o serviço Gestão de API. ApiVersionConstraint
certificados Lista de Certificados que têm de ser instalados no serviço Gestão de API. O máximo de certificados suportados que podem ser instalados é 10. CertificateConfiguration[]
configurationApi Configuração da API de Configuração do serviço Gestão de API. ConfigurationApi
customProperties Propriedades personalizadas do serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 desativará a cifra TLS_RSA_WITH_3DES_EDE_CBC_SHA para todos os TLS(1.0, 1.1 e 1.2).
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 num serviço Gestão de API.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pode ser utilizada para desativar apenas o TLS 1.1 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pode ser utilizada para desativar o TLS 1.0 para comunicações com back-ends.
A definição Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pode ser utilizada para ativar o protocolo HTTP2 num serviço Gestão de API.
Não especificar nenhuma destas propriedades na operação PATCH irá repor os valores das propriedades omitidas para as respetivas predefinições. Para todas as definições exceto Http2, o valor predefinido é True se o serviço foi criado em ou antes de 1 de abril de 2018 e False de outra forma. O valor predefinido da definição http2 é False.

Pode desativar qualquer uma das seguintes cifras com as definiçõ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 predefinido é true para eles.
Nota: as cifras seguintes não podem ser desativadas, uma vez que são necessárias 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 Estado do portal do programador neste serviço de Gestão de API. "Desativado"
"Ativado"
disableGateway Propriedade válida apenas para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway na região mestra. bool
enableClientCertificate Propriedade destinada apenas a ser utilizada para o Serviço SKU de Consumo. Isto impõe a apresentação de um certificado de cliente em cada pedido ao gateway. Isto também permite a capacidade de autenticar o certificado na política no gateway. bool
hostnameConfigurations Configuração personalizada do nome do anfitrião do serviço Gestão de API. HostnameConfiguration[]
legacyPortalStatus Estado do portal legado no serviço Gestão de API. "Desativado"
"Ativado"
natGatewayState A propriedade pode ser utilizada para ativar o NAT Gateway para este serviço de Gestão de API. "Desativado"
"Ativado"
notificationSenderEmail Email endereço a partir do qual a notificação será enviada. string
privateEndpointConnections Lista de Ligações de Ponto Final Privado deste serviço. RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId Endereço IP baseado em IP V4 do SKU Standard Público a associar ao serviço implementado Rede Virtual na região. Suportada apenas para Programadores e SKU Premium que estão a ser implementados no Rede Virtual. string
publicNetworkAccess Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado" "Desativado"
"Ativado"
publisherEmail E-mail do Publisher. cadeia (obrigatório)
publisherName Nome do publicador. cadeia (obrigatório)
restore Anular a eliminação do Serviço de Gestão de API se tiver sido eliminado de forma recuperável anteriormente. Se este sinalizador for especificado e definido como Verdadeiro, todas as outras propriedades serão ignoradas. bool
virtualNetworkConfiguration Configuração da rede virtual do serviço Gestão de API. VirtualNetworkConfiguration
virtualNetworkType O tipo de VPN no qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhum Rede Virtual, Externo significa que a implementação do Gestão de API está configurada dentro de um Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet. "Externo"
"Interno"
"Nenhum"

AdditionalLocation

Nome Descrição Valor
disableGateway Propriedade válida apenas para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway nesta localização adicional. bool
localização O nome da localização da região adicional entre as regiões do Centro de Dados do Azure. cadeia (obrigatório)
natGatewayState A propriedade pode ser utilizada para ativar o NAT Gateway para este serviço de Gestão de API. "Desativado"
"Ativado"
publicIpAddressId Endereço IP baseado em IP V4 do SKU Standard público a ser associado ao serviço implementado Rede Virtual na localização. Suportado apenas para o SKU Premium que está a ser implementado no Rede Virtual. string
sku Propriedades de SKU do serviço Gestão de API. ApiManagementServiceSkuProperties (obrigatório)
virtualNetworkConfiguration Configuração da rede virtual para a localização. VirtualNetworkConfiguration
zonas Uma lista de zonas de disponibilidade que indica a origem do recurso. cadeia[]

ApiManagementServiceSkuProperties

Nome Descrição Valor
capacidade Capacidade do SKU (número de unidades implementadas do SKU). Para a capacidade de SKU de Consumo tem de ser especificada como 0. int (obrigatório)
name Nome do SKU. "Básico"
"BasicV2"
"Consumo"
"Programador"
"Isolado"
"Premium"
"Standard"
"StandardV2" (obrigatório)

VirtualNetworkConfiguration

Nome Descrição Valor
subnetResourceId O ID de recurso completo de uma sub-rede numa rede virtual para implementar o serviço Gestão de API. string

ApiVersionConstraint

Nome Descrição Valor
minApiVersion Limite as chamadas à API do plano de controlo para Gestão de API serviço com uma versão igual ou mais recente do que este valor. string

CertificateConfiguration

Nome Descrição Valor
certificado Informações do certificado. CertificateInformation
certificatePassword Palavra-passe do Certificado. string
codificadoCertificate Certificado codificado Base64. string
storeName A localização do arquivo de certificados System.Security.Cryptography.x509certificates.StoreName. Apenas Root e CertificateAuthority são localizações válidas. "CertificateAuthority"
"Raiz" (obrigatório)

CertificateInformation

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

ConfigurationApi

Nome Descrição Valor
legacyApi Indica se a API de Configuração (v1) legada deve ou não ser exposta no serviço de Gestão de API. O valor é opcional, mas tem de ser "Ativado" ou "Desativado". Se "Desativado", a API de Configuração legada (v1) não estará disponível para gateways autoalojados. O valor predefinido é "Ativado" "Desativado"
"Ativado"

ApiManagementServiceBasePropertiesCustomProperties

Nome Descrição Valor
{customized property} string

HostnameConfiguration

Nome Descrição Valor
certificado Informações do certificado. CertificateInformation
certificatePassword Palavra-passe do Certificado. string
certificateSource Origem do Certificado. "BuiltIn"
"Personalizado"
"KeyVault"
"Gerido"
certificateStatus Estado do Certificado. "Concluído"
"Falhou"
"Entrada"
defaultSslBinding Especifique true para configurar o certificado associado a este Nome de Anfitrião como o Certificado SSL Predefinido. Se um cliente não enviar o cabeçalho SNI, este será o certificado que será contestado. A propriedade é útil se um serviço tiver vários nomes de anfitrião personalizados ativados e precisar de decidir sobre o certificado ssl predefinido. A definição só foi aplicada ao Tipo de Nome de Anfitrião do gateway. bool
codificadoCertificate Certificado codificado Base64. string
hostName Nome do anfitrião a configurar no serviço de Gestão de API. cadeia (obrigatório)
identityClientId ClientId de identidade gerida atribuída pelo sistema ou pelo utilizador, tal como gerado pelo 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 for fornecido um URL absoluto que contenha a versão, a atualização automática do certificado SSL não funcionará. Isto requer que o serviço de Gestão de API seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo application/x-pkcs12 string
negotiateClientCertificate Especifique true para negociar sempre o certificado de cliente no nome do anfitrião. O Valor Predefinido é falso. bool
tipo Tipo de nome de anfitrião. "ConfigurationApi"
"DeveloperPortal"
"Gestão"
"Portal"
"Proxy"
"Scm" (obrigatório)

RemotePrivateEndpointConnectionWrapper

Nome Descrição Valor
ID ID do recurso de ligação de Ponto Final Privado string
name Nome da Ligação do Ponto Final Privado string
propriedades Propriedades do recurso. PrivateEndpointConnectionWrapperProperties
tipo Tipo de Recurso de Ligação de Ponto Final Privado string

PrivateEndpointConnectionWrapperProperties

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

ArmIdWrapper

Este objeto não contém quaisquer propriedades a definir durante a implementação. Todas as propriedades são ReadOnly.

PrivateLinkServiceConnectionState

Nome Descrição Valor
actionsRequired Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor. string
descrição O motivo da aprovação/rejeição da ligação. string
status Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço. "Aprovado"
"Pendente"
"Rejeitado"