Servicio Microsoft.ApiManagement

Artículo
01/16/2024

Definición de recursos de Bicep

El tipo de recurso de servicio se puede implementar con operaciones destinadas a:

Grupos de recursos: consulte los comandos de implementación del grupo de recursos.

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service, agregue el siguiente bicep a la plantilla.

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 propiedad

service

Nombre	Descripción	Value
name	El nombre del recurso	string (obligatorio) Límite de caracteres: 1-50 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. El nombre del recurso debe ser único en Azure.
ubicación	Ubicación del recurso	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
sku	Propiedades de SKU del servicio API Management.	ApiManagementServiceSkuProperties (obligatorio)
identidad	Identidad de servicio administrada del servicio Api Management.	ApiManagementServiceIdentity
properties	Propiedades del servicio API Management.	ApiManagementServiceProperties (obligatorio)
zones	Una lista de zonas de disponibilidad que indica dónde debe proceder el recurso.	string[]

ApiManagementServiceIdentity

Nombre	Descripción	Value
type	Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.	'Ninguno' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (obligatorio)
userAssignedIdentities	Lista de identidades de usuario asociadas al recurso. La identidad del usuario las referencias de clave de diccionario serán identificadores de recursos de ARM con el formato: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Nombre	Descripción	Valor
{propiedad personalizada}		UserIdentityProperties

UserIdentityProperties

Nombre	Descripción	Valor
clientId	Identificador de cliente de la identidad asignada por el usuario.	string
principalId	Identificador principal de la identidad asignada por el usuario.	string

ApiManagementServiceProperties

Nombre	Descripción	Valor
additionalLocations	Ubicaciones adicionales del centro de datos del servicio API Management.	AdditionalLocation[]
apiVersionConstraint	Restricción de versión de api de plano de control para el servicio API Management.	ApiVersionConstraint
certificates	Lista de certificados que deben instalarse en el servicio API Management. El número máximo de certificados admitidos que se pueden instalar es 10.	CertificateConfiguration[]
configurationApi	Configuración de la API de configuración del servicio API Management.	ConfigurationApi
customProperties	Propiedades personalizadas del servicio API Management. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` deshabilitará la TLS_RSA_WITH_3DES_EDE_CBC_SHA de cifrado para todas las TLS(1.0, 1.1 y 1.2). La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` se puede usar para deshabilitar solo TLS 1.1. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` se puede usar para deshabilitar TLS 1.0 en un servicio de API Management. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` se puede usar para deshabilitar solo TLS 1.1 para las comunicaciones con back-end. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` se puede usar para deshabilitar TLS 1.0 para las comunicaciones con back-end. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` se puede usar para habilitar el protocolo HTTP2 en un servicio de API Management. Si no se especifica ninguna de estas propiedades en la operación PATCH, se restablecerán los valores de las propiedades omitidas en sus valores predeterminados. Para todas las configuraciones, excepto Http2, el valor predeterminado es `True` si el servicio se creó el 1 de abril de 2018 o antes de `False` lo contrario. El valor predeterminado de la configuración http2 es `False`. Puede deshabilitar cualquiera de los siguientes cifrados mediante la configuración `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 ejemplo, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. El valor predeterminado es `true` para ellos. Nota: Los siguientes cifrados no se pueden deshabilitar, ya que son necesarios para los componentes de la plataforma interna: 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 del portal para desarrolladores en este servicio API Management.	'Deshabilitado' 'Habilitado'
disableGateway	La propiedad solo es válida para un servicio api Management implementado en varias ubicaciones. Se puede usar para deshabilitar la puerta de enlace en la región maestra.	bool
enableClientCertificate	La propiedad solo está pensada para usarse para el servicio de SKU de consumo. Esto exige que se presente un certificado de cliente en cada solicitud a la puerta de enlace. Esto también permite autenticar el certificado en la directiva de la puerta de enlace.	bool
hostnameConfigurations	Configuración de nombre de host personalizada del servicio API Management.	HostnameConfiguration[]
legacyPortalStatus	Estado del portal heredado en el servicio API Management.	'Deshabilitado' 'Habilitado'
natGatewayState	La propiedad se puede usar para habilitar NAT Gateway para este servicio de API Management.	'Deshabilitado' 'Habilitado'
notificationSenderEmail	Email dirección desde la que se enviará la notificación.	string
privateEndpointConnections	Lista de conexiones de punto de conexión privado de este servicio.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Dirección IP V4 basada en la SKU estándar pública que se asociará con Virtual Network servicio implementado en la región. Solo se admite para la implementación de SKU De desarrollador y Premium en Virtual Network.	string
publicNetworkAccess	Si se permite o no el acceso al punto de conexión público para este servicio API Management. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado". Si es "Deshabilitado", los puntos de conexión privados son el método de acceso exclusivo. El valor predeterminado es "Enabled"	'Deshabilitado' 'Habilitado'
publisherEmail	Correo electrónico del publicador.	string (obligatorio)
publisherName	Nombre del publicador.	string (obligatorio)
Restauración	Recuperar el servicio Api Management si se eliminó temporalmente. Si se especifica esta marca y se establece en True, se omitirán todas las demás propiedades.	bool
virtualNetworkConfiguration	Configuración de red virtual del servicio API Management.	VirtualNetworkConfiguration
virtualNetworkType	Tipo de VPN en el que se debe configurar API Management servicio. None (Valor predeterminado) significa que el servicio API Management no forma parte de ninguna Virtual Network, External significa que la implementación de API Management está configurada dentro de un Virtual Network que tiene un punto de conexión accesible desde Internet y Internal significa que API Management la implementación se configura dentro de un Virtual Network tener solo un punto de conexión accesible desde la intranet.	"Externo" "Interno" 'Ninguno'

AdditionalLocation

Nombre	Descripción	Valor
disableGateway	La propiedad solo es válida para un servicio api Management implementado en varias ubicaciones. Esto se puede usar para deshabilitar la puerta de enlace en esta ubicación adicional.	bool
ubicación	Nombre de ubicación de la región adicional entre las regiones del centro de datos de Azure.	string (obligatorio)
natGatewayState	La propiedad se puede usar para habilitar NAT Gateway para este servicio de API Management.	'Deshabilitado' 'Habilitado'
publicIpAddressId	Dirección IP basada en ip V4 de SKU estándar pública que se asociará con Virtual Network servicio implementado en la ubicación. Solo se admite para la SKU Premium que se implementa en Virtual Network.	string
sku	Propiedades de SKU del servicio API Management.	ApiManagementServiceSkuProperties (obligatorio)
virtualNetworkConfiguration	Configuración de red virtual para la ubicación.	VirtualNetworkConfiguration
zones	Una lista de zonas de disponibilidad que indica dónde debe proceder el recurso.	string[]

ApiManagementServiceSkuProperties

Nombre	Descripción	Valor
capacity	Capacidad de la SKU (número de unidades implementadas de la SKU). Para la capacidad de SKU de consumo debe especificarse como 0.	int (obligatorio)
name	Nombre de la SKU.	'Básico' 'BasicV2' 'Consumo' "Desarrollador" 'Aislado' 'Premium' 'Estándar' 'StandardV2' (obligatorio)

VirtualNetworkConfiguration

Nombre	Descripción	Valor
subnetResourceId	Identificador de recurso completo de una subred en una red virtual en la que se va a implementar el servicio API Management.	string

ApiVersionConstraint

Nombre	Descripción	Valor
minApiVersion	Limite las llamadas API del plano de control a API Management servicio con la versión igual o posterior a este valor.	string

CertificateConfiguration

Nombre	Descripción	Valor
certificado	Información del certificado.	CertificateInformation
certificatePassword	Contraseña del certificado.	string
codificadoCertificate	Certificado codificado en Base64.	string
storeName	Ubicación del almacén de certificados System.Security.Cryptography.x509certificates.StoreName. Solo root y CertificateAuthority son ubicaciones válidas.	'CertificateAuthority' 'Root' (obligatorio)

CertificateInformation

Nombre	Descripción	Valor
expiry	Fecha de expiración del certificado. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.	string (obligatorio)
subject	Asunto del certificado.	string (obligatorio)
thumbprint	Huella digital del certificado	string (obligatorio)

ConfigurationApi

Nombre	Descripción	Valor
legacyApi	Indicación de si la API de configuración heredada (v1) debe exponerse en el servicio API Management. El valor es opcional, pero debe ser "Habilitado" o "Deshabilitado". Si "Deshabilitado", la API de configuración heredada (v1) no estará disponible para las puertas de enlace autohospedados. El valor predeterminado es "Enabled"	'Deshabilitado' 'Habilitado'

ApiManagementServiceBasePropertiesCustomProperties

Nombre	Descripción	Valor
{propiedad personalizada}		string

HostnameConfiguration

Nombre	Descripción	Valor
certificado	Información del certificado.	CertificateInformation
certificatePassword	Contraseña del certificado.	string
certificateSource	Origen del certificado.	'BuiltIn' 'Personalizado' 'KeyVault' 'Administrado'
certificateStatus	Estado del certificado.	'Completado' 'Error' 'InProgress'
defaultSslBinding	Especifique true para configurar el certificado asociado a este nombre de host como certificado SSL predeterminado. Si un cliente no envía el encabezado SNI, será el certificado que se impugnará. La propiedad es útil si un servicio tiene habilitado varios nombres de host personalizados y debe decidir el certificado ssl predeterminado. La configuración solo se aplica al tipo de nombre de host de puerta de enlace.	bool
codificadoCertificate	Certificado codificado en Base64.	string
hostName	Nombre de host que se va a configurar en el servicio Api Management.	string (obligatorio)
identityClientId	ClientId de identidad administrada asignada por el sistema o el usuario, según lo generado por Azure AD, que tiene acceso GET al almacén de claves que contiene el certificado SSL.	string
keyVaultId	Dirección URL al secreto de KeyVault que contiene el certificado Ssl. Si se proporciona la dirección URL absoluta que contiene la versión, la actualización automática del certificado ssl no funcionará. Esto requiere que el servicio Api Management se configure con aka.ms/apimmsi. El secreto debe ser de tipo application/x-pkcs12.	string
negotiateClientCertificate	Especifique true para negociar siempre el certificado de cliente en el nombre de host. El valor predeterminado es false.	bool
tipo	Tipo de nombre de host.	'ConfigurationApi' "DeveloperPortal" "Administración" 'Portal' 'Proxy' 'Scm' (obligatorio)

RemotePrivateEndpointConnectionWrapper

Nombre	Descripción	Value
id	Identificador de recurso de conexión de punto de conexión privado	string
name	Nombre de conexión de punto de conexión privado	string
properties	Propiedades de recursos.	PrivateEndpointConnectionWrapperProperties
tipo	Tipo de recurso de conexión de punto de conexión privado	string

PrivateEndpointConnectionWrapperProperties

Nombre	Descripción	Valor
privateEndpoint	Recurso del punto de conexión privado.	ArmIdWrapper
privateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.	PrivateLinkServiceConnectionState (obligatorio)

ArmIdWrapper

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

PrivateLinkServiceConnectionState

Nombre	Descripción	Valor
actionsRequired	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.	string
description	Motivo de aprobación o rechazo de la conexión.	string
status	Indica si el propietario del servicio ha aprobado, rechazado o quitado la conexión.	'Aprobado' 'Pendiente' "Rejected"

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla	Descripción
Creación de una instancia de API Management y todos los subrecursos mediante la plantilla	Esta plantilla muestra cómo crear un servicio API Management y configurar subentidades
Implementación de API Management con un Azure Cache for Redis externo	En esta plantilla se muestra cómo crear una instancia de Azure API Management en el nivel Consumo con una instancia de Azure Cache for Redis externa como caché externa API Management.
Implementación de API Management en una red virtual externa con ip pública	Esta plantilla muestra cómo crear una instancia de Azure API Management en el nivel Premium dentro de la subred de la red virtual en modo externo y configurar reglas de NSG recomendadas en la subred. La instancia se implementa en dos zonas de disponibilidad. La plantilla también configura una dirección IP pública de la suscripción.
Creación de una instancia de API Management con nombres de host personalizados	En esta plantilla se muestra cómo crear una instancia de Azure API Management con el nombre de host personalizado para el portal y varios nombres de host personalizados para el proxy.
Creación de API Management en una red virtual interna con App Gateway	En esta plantilla se muestra cómo crear una instancia de Azure API Management en una red privada protegida por Azure Application Gateway.
Implementación de API Management en una red virtual interna con una dirección IP pública	En esta plantilla se muestra cómo crear una instancia de Azure API Management en el nivel Premium dentro de la subred de la red virtual en modo interno y configurar las reglas de NSG recomendadas en la subred. La instancia se implementa en dos zonas de disponibilidad. La plantilla también configura una dirección IP pública de la suscripción.
Creación de una instancia de API Management con identidad MSI	Esta plantilla crea una instancia de desarrollador de Azure API Management tener una identidad MSI
Creación de una instancia de API Management de nivel Premium de varias regiones	Esta plantilla muestra cómo crear una instancia de API Management con ubicaciones adicionales. La ubicación principal es la misma que la ubicación del grupo de recursos. Para ubicaciones adicionales, la plantilla muestra NorthCentralUs y Este de EE. UU. 2. La ubicación principal debe ser diferente de las ubicaciones adicionales.
Creación de API Management con ssl de proxy personalizado mediante KeyVault	En esta plantilla se muestra cómo crear una instancia de Azure API Management y configurar el nombre de host personalizado para el proxy con certificado ssl de keyvault.
Creación de un servicio de API Management con SSL desde KeyVault	Esta plantilla implementa un servicio de API Management configurado con identidad asignada por el usuario. Usa esta identidad para capturar el certificado SSL de KeyVault y mantenerlo actualizado comprobando cada 4 horas.
Creación y supervisión de API Management instancia	Esta plantilla crea una instancia del servicio Azure API Management y el área de trabajo de Log Analytics y configura la supervisión del servicio de API Management con Log Analytics.
Creación de un servicio API Management con un punto de conexión privado	Esta plantilla creará un servicio API Management, una red virtual y un punto de conexión privado que exponga el servicio API Management a la red virtual.
Implementación de API Management en Availability Zones	Esta plantilla crea una instancia premium de Azure API Management e implementa en una zona de disponibilidad.
Creación de una instancia de API Management mediante una plantilla	Esta plantilla crea una instancia de desarrollador de Azure API Management
Front Door Estándar/Premium con origen de API Management	Esta plantilla crea una instancia de Front Door Premium y una instancia de API Management, y usa un grupo de seguridad de red y una directiva de API Management global para validar que el tráfico ha llegado a través del origen de Front Door.
Creación de Azure Front Door delante de Azure API Management	En este ejemplo se muestra cómo usar Azure Front Door como equilibrador de carga global delante de Azure API Management.
Application Gateway con API Management internos y aplicación web	Application Gateway enrutar el tráfico de Internet a una red virtual (modo interno) API Management instancia que atiende una API web hospedada en una aplicación web de Azure.

Definición de recursos de plantilla de ARM

El tipo de recurso de servicio se puede implementar con operaciones que tienen como destino:

Grupos de recursos: consulte los comandos de implementación del grupo de recursos.

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service, agregue el siguiente json a la plantilla.

{
  "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 propiedad

service

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft.ApiManagement/service"
apiVersion	La versión de la API de recursos	"2023-05-01-preview"
name	El nombre del recurso	string (obligatorio) Límite de caracteres: 1-50 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. El nombre del recurso debe ser único en Azure.
ubicación	Ubicación del recurso	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
sku	Propiedades de SKU del servicio API Management.	ApiManagementServiceSkuProperties (obligatorio)
identidad	Identidad de servicio administrada del servicio Api Management.	ApiManagementServiceIdentity
properties	Propiedades del servicio API Management.	ApiManagementServiceProperties (obligatorio)
zones	Lista de zonas de disponibilidad de las que se indica dónde debe proceder el recurso.	string[]

ApiManagementServiceIdentity

Nombre	Descripción	Value
type	Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.	'Ninguno' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (obligatorio)
userAssignedIdentities	Lista de identidades de usuario asociadas al recurso. La identidad del usuario las referencias de clave de diccionario serán identificadores de recursos de ARM con el formato: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	ApiManagementServiceIdentityUserAssignedIdentities

ApiManagementServiceIdentityUserAssignedIdentities

Nombre	Descripción	Valor
{propiedad personalizada}		UserIdentityProperties

UserIdentityProperties

Nombre	Descripción	Valor
clientId	Identificador de cliente de la identidad asignada por el usuario.	string
principalId	Identificador de entidad de seguridad de la identidad asignada por el usuario.	string

ApiManagementServiceProperties

Nombre	Descripción	Valor
additionalLocations	Ubicaciones adicionales del centro de datos del servicio API Management.	AdditionalLocation[]
apiVersionConstraint	Restricción de versión de api de plano de control para el servicio API Management.	ApiVersionConstraint
certificates	Lista de certificados que deben instalarse en el servicio API Management. El número máximo de certificados admitidos que se pueden instalar es 10.	CertificateConfiguration[]
configurationApi	Configuración de la API de configuración del servicio API Management.	ConfigurationApi
customProperties	Propiedades personalizadas del servicio API Management. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` deshabilitará la TLS_RSA_WITH_3DES_EDE_CBC_SHA de cifrado para todas las TLS(1.0, 1.1 y 1.2). La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` se puede usar para deshabilitar solo TLS 1.1. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` se puede usar para deshabilitar TLS 1.0 en un servicio de API Management. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` se puede usar para deshabilitar solo TLS 1.1 para las comunicaciones con back-end. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` se puede usar para deshabilitar TLS 1.0 para las comunicaciones con back-end. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` se puede usar para habilitar el protocolo HTTP2 en un servicio de API Management. Si no se especifica ninguna de estas propiedades en la operación PATCH, se restablecerán los valores de las propiedades omitidas en sus valores predeterminados. Para todas las configuraciones, excepto Http2, el valor predeterminado es `True` si el servicio se creó el 1 de abril de 2018 o antes de `False` lo contrario. El valor predeterminado de la configuración http2 es `False`. Puede deshabilitar cualquiera de los siguientes cifrados mediante la configuración `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 ejemplo, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. El valor predeterminado es `true` para ellos. Nota: Los siguientes cifrados no se pueden deshabilitar, ya que son necesarios para los componentes de la plataforma interna: 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 del portal para desarrolladores en este servicio API Management.	'Deshabilitado' 'Habilitado'
disableGateway	La propiedad solo es válida para un servicio api Management implementado en varias ubicaciones. Se puede usar para deshabilitar la puerta de enlace en la región maestra.	bool
enableClientCertificate	La propiedad solo está pensada para usarse para el servicio de SKU de consumo. Esto exige que se presente un certificado de cliente en cada solicitud a la puerta de enlace. Esto también permite autenticar el certificado en la directiva de la puerta de enlace.	bool
hostnameConfigurations	Configuración de nombre de host personalizada del servicio API Management.	HostnameConfiguration[]
legacyPortalStatus	Estado del portal heredado en el servicio API Management.	'Deshabilitado' 'Habilitado'
natGatewayState	La propiedad se puede usar para habilitar NAT Gateway para este servicio de API Management.	'Deshabilitado' 'Habilitado'
notificationSenderEmail	Email dirección desde la que se enviará la notificación.	string
privateEndpointConnections	Lista de conexiones de punto de conexión privado de este servicio.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Dirección IP V4 basada en la SKU estándar pública que se asociará con Virtual Network servicio implementado en la región. Solo se admite para la implementación de SKU De desarrollador y Premium en Virtual Network.	string
publicNetworkAccess	Si se permite o no el acceso al punto de conexión público para este servicio API Management. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado". Si es "Deshabilitado", los puntos de conexión privados son el método de acceso exclusivo. El valor predeterminado es "Enabled"	'Deshabilitado' 'Habilitado'
publisherEmail	Correo electrónico del publicador.	string (obligatorio)
publisherName	Nombre del publicador.	string (obligatorio)
Restauración	Quite el servicio Api Management si anteriormente se eliminó temporalmente. Si se especifica esta marca y se establece en True se omitirán todas las demás propiedades.	bool
virtualNetworkConfiguration	Configuración de red virtual del servicio API Management.	VirtualNetworkConfiguration
virtualNetworkType	Tipo de VPN en el que se debe configurar API Management servicio. Ninguno (valor predeterminado) significa que el servicio API Management no forma parte de ninguna Virtual Network, external significa que la implementación de API Management se configura dentro de un Virtual Network que tiene un punto de conexión accesible desde Internet y significa internamente que API Management la implementación se configura dentro de un Virtual Network tener solo un punto de conexión accesible desde la intranet.	'Externo' 'Interno' 'Ninguno'

AdditionalLocation

Nombre	Descripción	Valor
disableGateway	La propiedad solo es válida para un servicio api Management implementado en varias ubicaciones. Esto se puede usar para deshabilitar la puerta de enlace en esta ubicación adicional.	bool
ubicación	Nombre de ubicación de la región adicional entre las regiones del centro de datos de Azure.	string (obligatorio)
natGatewayState	La propiedad se puede usar para habilitar nat Gateway para este servicio de API Management.	'Deshabilitado' 'Habilitado'
publicIpAddressId	Dirección IP V4 basada en la SKU estándar pública que se va a asociar con Virtual Network servicio implementado en la ubicación. Solo se admite para la SKU Premium que se implementa en Virtual Network.	string
sku	Propiedades de SKU del servicio API Management.	ApiManagementServiceSkuProperties (obligatorio)
virtualNetworkConfiguration	Configuración de red virtual para la ubicación.	VirtualNetworkConfiguration
zones	Una lista de zonas de disponibilidad que indica dónde debe proceder el recurso.	string[]

ApiManagementServiceSkuProperties

Nombre	Descripción	Valor
capacity	Capacidad de la SKU (número de unidades implementadas de la SKU). Para la capacidad de SKU de consumo debe especificarse como 0.	int (obligatorio)
name	Nombre de la SKU.	'Básico' 'BasicV2' 'Consumo' "Desarrollador" 'Aislado' 'Premium' 'Estándar' 'StandardV2' (obligatorio)

VirtualNetworkConfiguration

Nombre	Descripción	Valor
subnetResourceId	Identificador de recurso completo de una subred en una red virtual en la que se va a implementar el servicio API Management.	string

ApiVersionConstraint

Nombre	Descripción	Valor
minApiVersion	Limite las llamadas API del plano de control a API Management servicio con la versión igual o posterior a este valor.	string

CertificateConfiguration

Nombre	Descripción	Valor
certificado	Información del certificado.	CertificateInformation
certificatePassword	Contraseña del certificado.	string
codificadoCertificate	Certificado codificado en Base64.	string
storeName	Ubicación del almacén de certificados System.Security.Cryptography.x509certificates.StoreName. Solo root y CertificateAuthority son ubicaciones válidas.	'CertificateAuthority' 'Root' (obligatorio)

CertificateInformation

Nombre	Descripción	Valor
expiry	Fecha de expiración del certificado. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.	string (obligatorio)
subject	Sujeto del certificado.	string (obligatorio)
thumbprint	Huella digital del certificado	string (obligatorio)

ConfigurationApi

Nombre	Descripción	Valor
legacyApi	Indicación de si la API de configuración heredada (v1) debe exponerse en el servicio API Management. El valor es opcional, pero debe ser "Habilitado" o "Deshabilitado". Si es "Deshabilitado", la API de configuración heredada (v1) no estará disponible para las puertas de enlace autohospedados. El valor predeterminado es "Enabled"	'Deshabilitado' 'Habilitado'

ApiManagementServiceBasePropertiesCustomProperties

Nombre	Descripción	Valor
{propiedad personalizada}		string

HostnameConfiguration

Nombre	Descripción	Valor
certificado	Información del certificado.	CertificateInformation
certificatePassword	Contraseña del certificado.	string
certificateSource	Origen del certificado.	'BuiltIn' 'Personalizado' "KeyVault" "Administrado"
certificateStatus	Estado del certificado.	"Completado" 'Failed' 'InProgress'
defaultSslBinding	Especifique true para configurar el certificado asociado a este nombre de host como certificado SSL predeterminado. Si un cliente no envía el encabezado SNI, será el certificado que se impugnará. La propiedad es útil si un servicio tiene habilitado varios nombres de host personalizados y debe decidir el certificado ssl predeterminado. La configuración solo se aplica al tipo de nombre de host de puerta de enlace.	bool
encodedCertificate	Certificado codificado en Base64.	string
hostName	Nombre de host que se va a configurar en el servicio Api Management.	string (obligatorio)
identityClientId	ClientId de identidad administrada asignada por el sistema o el usuario generado por Azure AD, que tiene acceso GET al almacén de claves que contiene el certificado SSL.	string
keyVaultId	Dirección URL al secreto de KeyVault que contiene el certificado Ssl. Si se proporciona la dirección URL absoluta que contiene la versión, la actualización automática del certificado ssl no funcionará. Esto requiere que el servicio Api Management se configure con aka.ms/apimmsi. El secreto debe ser de tipo application/x-pkcs12.	string
negotiateClientCertificate	Especifique true para negociar siempre el certificado de cliente en el nombre de host. El valor predeterminado es false.	bool
tipo	Tipo de nombre de host.	'ConfigurationApi' "DeveloperPortal" "Administración" 'Portal' 'Proxy' 'Scm' (obligatorio)

RemotePrivateEndpointConnectionWrapper

Nombre	Descripción	Value
id	Identificador de recurso de conexión de punto de conexión privado	string
name	Nombre de conexión del punto de conexión privado	string
properties	Propiedades del recurso.	PrivateEndpointConnectionWrapperProperties
tipo	Tipo de recurso de conexión de punto de conexión privado	string

PrivateEndpointConnectionWrapperProperties

Nombre	Descripción	Valor
privateEndpoint	Recurso del punto de conexión privado.	ArmIdWrapper
privateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.	PrivateLinkServiceConnectionState (obligatorio)

ArmIdWrapper

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

PrivateLinkServiceConnectionState

Nombre	Descripción	Valor
actionsRequired	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.	string
description	Motivo de aprobación o rechazo de la conexión.	string
status	Indica si el propietario del servicio ha aprobado, rechazado o quitado la conexión.	'Aprobado' 'Pendiente' "Rejected"

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla	Descripción
Creación de una instancia de API Management y todos los subrecursos mediante la plantilla	Esta plantilla muestra cómo crear un servicio API Management y configurar subentidades
Implementación de API Management con un Azure Cache for Redis externo	En esta plantilla se muestra cómo crear una instancia de Azure API Management en el nivel Consumo con una instancia de Azure Cache for Redis externa como caché externa API Management.
Implementación de API Management en una red virtual externa con ip pública	Esta plantilla muestra cómo crear una instancia de Azure API Management en el nivel Premium dentro de la subred de la red virtual en modo externo y configurar reglas de NSG recomendadas en la subred. La instancia se implementa en dos zonas de disponibilidad. La plantilla también configura una dirección IP pública de la suscripción.
Creación de una instancia de API Management con nombres de host personalizados	En esta plantilla se muestra cómo crear una instancia de Azure API Management con el nombre de host personalizado para el portal y varios nombres de host personalizados para proxy.
Creación de API Management en una red virtual interna con App Gateway	En esta plantilla se muestra cómo crear una instancia de Azure API Management en una red privada protegida por Azure Application Gateway.
Implementación de API Management en una red virtual interna con ip pública	Esta plantilla muestra cómo crear una instancia de Azure API Management en el nivel Premium dentro de la subred de la red virtual en modo interno y configurar reglas de NSG recomendadas en la subred. La instancia se implementa en dos zonas de disponibilidad. La plantilla también configura una dirección IP pública de la suscripción.
Creación de una instancia de API Management con identidad MSI	Esta plantilla crea una instancia de desarrollador de Azure API Management tener una identidad MSI
Creación de una instancia de nivel Premium de varias regiones API Management	En esta plantilla se muestra cómo crear una instancia de API Management con ubicaciones adicionales. La ubicación principal es la misma que la ubicación del grupo de recursos. Para ubicaciones adicionales, la plantilla muestra NorthCentralUs y Este de EE. UU. 2. La ubicación principal debe ser diferente de las ubicaciones adicionales.
Creación de API Management con ssl de proxy personalizado mediante KeyVault	En esta plantilla se muestra cómo crear una instancia de Azure API Management y configurar el nombre de host personalizado para el proxy con el certificado SSL de keyvault.
Creación de un servicio API Management con SSL desde KeyVault	Esta plantilla implementa un servicio de API Management configurado con identidad asignada por el usuario. Usa esta identidad para capturar el certificado SSL de KeyVault y mantenerlo actualizado comprobando cada 4 horas.
Creación y supervisión de API Management instancia	Esta plantilla crea una instancia del servicio Azure API Management y el área de trabajo de Log Analytics y configura la supervisión del servicio de API Management con Log Analytics.
Creación de un servicio API Management con un punto de conexión privado	Esta plantilla creará un servicio API Management, una red virtual y un punto de conexión privado que exponga el servicio API Management a la red virtual.
Implementación de API Management en Availability Zones	Esta plantilla crea una instancia premium de Azure API Management e implementa en una zona de disponibilidad.
Creación de una instancia de API Management mediante una plantilla	Esta plantilla crea una instancia de desarrollador de Azure API Management
Front Door Estándar/Premium con API Management origen	Esta plantilla crea una instancia de Front Door Premium y una instancia de API Management, y usa un grupo de seguridad de red y una directiva de API Management global para validar que el tráfico ha llegado a través del origen de Front Door.
Creación de Azure Front Door delante de Azure API Management	En este ejemplo se muestra cómo usar Azure Front Door como equilibrador de carga global delante de Azure API Management.
Application Gateway con API Management interna y aplicación web	Application Gateway enrutar el tráfico de Internet a una red virtual (modo interno) API Management instancia que atiende una API web hospedada en una aplicación web de Azure.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso de servicio se puede implementar con operaciones destinadas a:

Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service, agregue el siguiente terraform a la plantilla.

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 propiedad

service

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft.ApiManagement/service@2023-05-01-preview"
name	El nombre del recurso	string (obligatorio) Límite de caracteres: 1-50 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. El nombre del recurso debe ser único en Azure.
ubicación	Ubicación del recurso	string (obligatorio)
parent_id	Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos.	string (obligatorio)
etiquetas	Etiquetas del recurso.	Diccionario de nombres y valores de etiqueta.
sku	Propiedades de SKU del servicio API Management.	ApiManagementServiceSkuProperties (obligatorio)
identidad	Identidad de servicio administrada del servicio Api Management.	ApiManagementServiceIdentity
properties	Propiedades del servicio API Management.	ApiManagementServiceProperties (obligatorio)
zones	Lista de zonas de disponibilidad de las que se indica dónde debe proceder el recurso.	string[]

ApiManagementServiceIdentity

Nombre	Descripción	Value
type	Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned, UserAssigned" incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio.	"SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (obligatorio)
identity_ids	Lista de identidades de usuario asociadas al recurso. La identidad del usuario las referencias de clave de diccionario serán identificadores de recursos de ARM con el formato: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	Matriz de identificadores de identidad de usuario.

ApiManagementServiceIdentityUserAssignedIdentities

Nombre	Descripción	Valor
{propiedad personalizada}		UserIdentityProperties

UserIdentityProperties

Nombre	Descripción	Valor
clientId	Identificador de cliente de la identidad asignada por el usuario.	string
principalId	Identificador de entidad de seguridad de la identidad asignada por el usuario.	string

ApiManagementServiceProperties

Nombre	Descripción	Valor
additionalLocations	Ubicaciones adicionales del centro de datos del servicio API Management.	AdditionalLocation[]
apiVersionConstraint	Restricción de versión de api de plano de control para el servicio API Management.	ApiVersionConstraint
certificates	Lista de certificados que deben instalarse en el servicio API Management. El número máximo de certificados admitidos que se pueden instalar es 10.	CertificateConfiguration[]
configurationApi	Configuración de la API de configuración del servicio API Management.	ConfigurationApi
customProperties	Propiedades personalizadas del servicio API Management. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` deshabilitará la TLS_RSA_WITH_3DES_EDE_CBC_SHA de cifrado para todas las TLS(1.0, 1.1 y 1.2). La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` se puede usar para deshabilitar solo TLS 1.1. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` se puede usar para deshabilitar TLS 1.0 en un servicio de API Management. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` se puede usar para deshabilitar solo TLS 1.1 para las comunicaciones con back-end. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` se puede usar para deshabilitar TLS 1.0 para las comunicaciones con back-end. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` se puede usar para habilitar el protocolo HTTP2 en un servicio de API Management. Si no se especifica ninguna de estas propiedades en la operación PATCH, se restablecerán los valores de las propiedades omitidas en sus valores predeterminados. Para todas las configuraciones, excepto Http2, el valor predeterminado es `True` si el servicio se creó el 1 de abril de 2018 o antes de `False` lo contrario. El valor predeterminado de la configuración http2 es `False`. Puede deshabilitar cualquiera de los siguientes cifrados mediante la configuración `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 ejemplo, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. El valor predeterminado es `true` para ellos. Nota: Los siguientes cifrados no se pueden deshabilitar, ya que son necesarios para los componentes de la plataforma interna: 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 del portal para desarrolladores en este servicio API Management.	"Deshabilitado" "Habilitado"
disableGateway	La propiedad solo es válida para un servicio api Management implementado en varias ubicaciones. Se puede usar para deshabilitar la puerta de enlace en la región maestra.	bool
enableClientCertificate	La propiedad solo está pensada para usarse para el servicio de SKU de consumo. Esto exige que se presente un certificado de cliente en cada solicitud a la puerta de enlace. Esto también permite autenticar el certificado en la directiva de la puerta de enlace.	bool
hostnameConfigurations	Configuración de nombre de host personalizada del servicio API Management.	HostnameConfiguration[]
legacyPortalStatus	Estado del portal heredado en el servicio API Management.	"Deshabilitado" "Habilitado"
natGatewayState	La propiedad se puede usar para habilitar NAT Gateway para este servicio de API Management.	"Deshabilitado" "Habilitado"
notificationSenderEmail	Email dirección desde la que se enviará la notificación.	string
privateEndpointConnections	Lista de conexiones de punto de conexión privado de este servicio.	RemotePrivateEndpointConnectionWrapper[]
publicIpAddressId	Dirección IP V4 basada en la SKU estándar pública que se asociará con Virtual Network servicio implementado en la región. Solo se admite para la implementación de SKU De desarrollador y Premium en Virtual Network.	string
publicNetworkAccess	Si se permite o no el acceso al punto de conexión público para este servicio API Management. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado". Si es "Deshabilitado", los puntos de conexión privados son el método de acceso exclusivo. El valor predeterminado es "Enabled"	"Deshabilitado" "Habilitado"
publisherEmail	Correo electrónico del publicador.	string (obligatorio)
publisherName	Nombre del publicador.	string (obligatorio)
Restauración	Recuperar el servicio Api Management si se eliminó temporalmente. Si se especifica esta marca y se establece en True, se omitirán todas las demás propiedades.	bool
virtualNetworkConfiguration	Configuración de red virtual del servicio API Management.	VirtualNetworkConfiguration
virtualNetworkType	Tipo de VPN en el que se debe configurar API Management servicio. None (Valor predeterminado) significa que el servicio API Management no forma parte de ninguna Virtual Network, External significa que la implementación de API Management está configurada dentro de un Virtual Network que tiene un punto de conexión accesible desde Internet y Internal significa que API Management la implementación se configura dentro de un Virtual Network tener solo un punto de conexión accesible desde la intranet.	"Externo" "Interno" "None"

AdditionalLocation

Nombre	Descripción	Valor
disableGateway	La propiedad solo es válida para un servicio api Management implementado en varias ubicaciones. Esto se puede usar para deshabilitar la puerta de enlace en esta ubicación adicional.	bool
ubicación	Nombre de ubicación de la región adicional entre las regiones del centro de datos de Azure.	string (obligatorio)
natGatewayState	La propiedad se puede usar para habilitar NAT Gateway para este servicio de API Management.	"Deshabilitado" "Habilitado"
publicIpAddressId	Dirección IP basada en ip V4 de SKU estándar pública que se asociará con Virtual Network servicio implementado en la ubicación. Solo se admite para la SKU Premium que se implementa en Virtual Network.	string
sku	Propiedades de SKU del servicio API Management.	ApiManagementServiceSkuProperties (obligatorio)
virtualNetworkConfiguration	Configuración de red virtual para la ubicación.	VirtualNetworkConfiguration
zones	Lista de zonas de disponibilidad de las que se indica dónde debe proceder el recurso.	string[]

ApiManagementServiceSkuProperties

Nombre	Descripción	Valor
capacity	Capacidad de la SKU (número de unidades implementadas de la SKU). Para la capacidad de SKU de consumo debe especificarse como 0.	int (obligatorio)
name	Nombre de la SKU.	"Básica" "BasicV2" "Consumo" "Desarrollador" "Aislado" "Premium" "Estándar" "StandardV2" (obligatorio)

VirtualNetworkConfiguration

Nombre	Descripción	Valor
subnetResourceId	Identificador de recurso completo de una subred en una red virtual en la que implementar el servicio API Management.	string

ApiVersionConstraint

Nombre	Descripción	Valor
minApiVersion	Limite las llamadas API del plano de control a API Management servicio con la versión igual o posterior a este valor.	string

CertificateConfiguration

Nombre	Descripción	Valor
certificado	Información del certificado.	CertificateInformation
certificatePassword	Contraseña del certificado.	string
encodedCertificate	Certificado codificado en Base64.	string
storeName	Ubicación del almacén de certificados System.Security.Cryptography.x509certificates.StoreName. Solo root y CertificateAuthority son ubicaciones válidas.	"CertificateAuthority" "Root" (obligatorio)

CertificateInformation

Nombre	Descripción	Valor
expiry	Fecha de expiración del certificado. La fecha se ajusta al siguiente formato: `yyyy-MM-ddTHH:mm:ssZ` según lo especificado por el estándar ISO 8601.	string (obligatorio)
subject	Sujeto del certificado.	string (obligatorio)
thumbprint	Huella digital del certificado	string (obligatorio)

ConfigurationApi

Nombre	Descripción	Valor
legacyApi	Indicación de si la API de configuración heredada (v1) debe exponerse en el servicio API Management. El valor es opcional, pero debe ser "Habilitado" o "Deshabilitado". Si es "Deshabilitado", la API de configuración heredada (v1) no estará disponible para las puertas de enlace autohospedados. El valor predeterminado es "Enabled"	"Deshabilitado" "Habilitado"

ApiManagementServiceBasePropertiesCustomProperties

Nombre	Descripción	Valor
{propiedad personalizada}		string

HostnameConfiguration

Nombre	Descripción	Valor
certificado	Información del certificado.	CertificateInformation
certificatePassword	Contraseña del certificado.	string
certificateSource	Origen del certificado.	"BuiltIn" "Custom" "KeyVault" "Administrado"
certificateStatus	Estado del certificado.	"Completado" "Error" "InProgress"
defaultSslBinding	Especifique true para configurar el certificado asociado a este nombre de host como certificado SSL predeterminado. Si un cliente no envía el encabezado SNI, será el certificado que se impugnará. La propiedad es útil si un servicio tiene habilitado varios nombres de host personalizados y debe decidir el certificado ssl predeterminado. La configuración solo se aplica al tipo de nombre de host de puerta de enlace.	bool
encodedCertificate	Certificado codificado en Base64.	string
hostName	Nombre de host que se va a configurar en el servicio Api Management.	string (obligatorio)
identityClientId	ClientId de identidad administrada asignada por el sistema o el usuario, según lo generado por Azure AD, que tiene acceso GET al almacén de claves que contiene el certificado SSL.	string
keyVaultId	Dirección URL al secreto de KeyVault que contiene el certificado Ssl. Si se proporciona la dirección URL absoluta que contiene la versión, la actualización automática del certificado ssl no funcionará. Esto requiere que el servicio Api Management se configure con aka.ms/apimmsi. El secreto debe ser de tipo application/x-pkcs12.	string
negotiateClientCertificate	Especifique true para negociar siempre el certificado de cliente en el nombre de host. El valor predeterminado es false.	bool
tipo	Tipo de nombre de host.	"ConfigurationApi" "DeveloperPortal" "Administración" "Portal" "Proxy" "Scm" (obligatorio)

RemotePrivateEndpointConnectionWrapper

Nombre	Descripción	Value
id	Identificador de recurso de conexión de punto de conexión privado	string
name	Nombre de conexión de punto de conexión privado	string
properties	Propiedades de recursos.	PrivateEndpointConnectionWrapperProperties
tipo	Tipo de recurso de conexión de punto de conexión privado	string

PrivateEndpointConnectionWrapperProperties

Nombre	Descripción	Valor
privateEndpoint	Recurso del punto de conexión privado.	ArmIdWrapper
privateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.	PrivateLinkServiceConnectionState (obligatorio)

ArmIdWrapper

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

PrivateLinkServiceConnectionState

Nombre	Descripción	Valor
actionsRequired	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.	string
description	Motivo de aprobación o rechazo de la conexión.	string
status	Indica si el propietario del servicio ha aprobado, rechazado o quitado la conexión.	"Aprobado" "Pendiente" "Rechazado"

Compartir a través de

Servicio Microsoft.ApiManagement

Definición de recursos de Bicep

Formato de los recursos

Valores de propiedad

service

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Plantillas de inicio rápido

Definición de recursos de plantilla de ARM

Formato de los recursos

Valores de propiedad

service

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Plantillas de inicio rápido

Definición de recursos de Terraform (proveedor AzAPI)

Formato de los recursos

Valores de propiedad

service

ApiManagementServiceIdentity

ApiManagementServiceIdentityUserAssignedIdentities

UserIdentityProperties

ApiManagementServiceProperties

AdditionalLocation

ApiManagementServiceSkuProperties

VirtualNetworkConfiguration

ApiVersionConstraint

CertificateConfiguration

CertificateInformation

ConfigurationApi

ApiManagementServiceBasePropertiesCustomProperties

HostnameConfiguration

RemotePrivateEndpointConnectionWrapper

PrivateEndpointConnectionWrapperProperties

ArmIdWrapper

PrivateLinkServiceConnectionState

Comentarios

Comentarios

Recursos adicionales