Compartir a través de

ApiManagementServiceBaseProperties interface

  • Referencia
Paquete:
@azure/arm-apimanagement

Propiedades base de una descripción del recurso de servicio de API Management.

Propiedades

additionalLocations

Ubicaciones adicionales del centro de datos del servicio API Management.
apiVersionConstraint

Restricción de versión de api de plano de control para el servicio API Management.
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.
createdAtUtc

Fecha UTC de creación del servicio API Management. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
customProperties

Propiedades personalizadas del servicio API Management.
La configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 deshabilitará el cifrado TLS_RSA_WITH_3DES_EDE_CBC_SHA 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 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 API Management.
No especificar ninguna de estas propiedades en la operación PATCH restablecerá 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_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 porque 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
developerPortalUrl

Dirección URL del punto de conexión del portal de DEveloper del servicio API Management. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
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 la región maestra.
enableClientCertificate

Propiedad solo diseñada 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.
gatewayRegionalUrl

Dirección URL de puerta de enlace del servicio API Management en la región predeterminada. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
gatewayUrl

Dirección URL de puerta de enlace del servicio API Management. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
hostnameConfigurations

Configuración de nombre de host personalizada del servicio API Management.
managementApiUrl

Dirección URL del punto de conexión de la API de administración del servicio API Management. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
natGatewayState

La propiedad se puede usar para habilitar nat Gateway para este servicio de API Management.
notificationSenderEmail

Email dirección desde la que se enviará la notificación.
outboundPublicIPAddresses

Prefijos de dirección IPV4 públicas de salida asociados al servicio implementado de puerta de enlace NAT. Disponible solo para SKU Premium en la plataforma stv2. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
platformVersion

Versión de la plataforma de proceso que ejecuta el servicio en esta ubicación. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
portalUrl

Dirección URL del punto de conexión del portal del publicador del servicio API Management. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
privateEndpointConnections

Lista de conexiones de punto de conexión privado de este servicio.
privateIPAddresses

Direcciones IP de carga equilibrada estática privada del servicio API Management en la región primaria que se implementa en un Virtual Network interno. Solo está disponible para la SKU básica, estándar, premium y aislada. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
provisioningState

El estado de aprovisionamiento actual del servicio API Management que puede ser uno de los siguientes: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
publicIPAddresses

Direcciones IP públicas de carga equilibrada estática del servicio API Management en la región primaria. Solo está disponible para la SKU básica, estándar, premium y aislada. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
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.
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"
restore

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.
scmUrl

Dirección URL del punto de conexión de SCM del servicio API Management. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
targetProvisioningState

El estado de aprovisionamiento del servicio API Management, que está destinado a la operación de larga duración iniciada en el servicio. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
virtualNetworkConfiguration

Configuración de red virtual del servicio API Management.
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.

Detalles de las propiedades

additionalLocations

Ubicaciones adicionales del centro de datos del servicio API Management.

additionalLocations?: AdditionalLocation[]

Valor de propiedad

AdditionalLocation[]

apiVersionConstraint

Restricción de versión de api de plano de control para el servicio API Management.

apiVersionConstraint?: ApiVersionConstraint

Valor de propiedad

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.

certificates?: CertificateConfiguration[]

Valor de propiedad

CertificateConfiguration[]

createdAtUtc

Fecha UTC de creación del servicio API Management. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

createdAtUtc?: Date

Valor de propiedad

Date

customProperties

Propiedades personalizadas del servicio API Management.
La configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 deshabilitará el cifrado TLS_RSA_WITH_3DES_EDE_CBC_SHA 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 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 API Management.
No especificar ninguna de estas propiedades en la operación PATCH restablecerá 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_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 porque 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

customProperties?: {[propertyName: string]: string}

Valor de propiedad

{[propertyName: string]: string}

developerPortalUrl

Dirección URL del punto de conexión del portal de DEveloper del servicio API Management. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

developerPortalUrl?: string

Valor de propiedad

string

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 la región maestra.

disableGateway?: boolean

Valor de propiedad

boolean

enableClientCertificate

Propiedad solo diseñada 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.

enableClientCertificate?: boolean

Valor de propiedad

boolean

gatewayRegionalUrl

Dirección URL de puerta de enlace del servicio API Management en la región predeterminada. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

gatewayRegionalUrl?: string

Valor de propiedad

string

gatewayUrl

Dirección URL de puerta de enlace del servicio API Management. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

gatewayUrl?: string

Valor de propiedad

string

hostnameConfigurations

Configuración de nombre de host personalizada del servicio API Management.

hostnameConfigurations?: HostnameConfiguration[]

Valor de propiedad

HostnameConfiguration[]

managementApiUrl

Dirección URL del punto de conexión de la API de administración del servicio API Management. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

managementApiUrl?: string

Valor de propiedad

string

natGatewayState

La propiedad se puede usar para habilitar nat Gateway para este servicio de API Management.

natGatewayState?: string

Valor de propiedad

string

notificationSenderEmail

Email dirección desde la que se enviará la notificación.

notificationSenderEmail?: string

Valor de propiedad

string

outboundPublicIPAddresses

Prefijos de dirección IPV4 públicas de salida asociados al servicio implementado de puerta de enlace NAT. Disponible solo para SKU Premium en la plataforma stv2. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

outboundPublicIPAddresses?: string[]

Valor de propiedad

string[]

platformVersion

Versión de la plataforma de proceso que ejecuta el servicio en esta ubicación. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

platformVersion?: string

Valor de propiedad

string

portalUrl

Dirección URL del punto de conexión del portal del publicador del servicio API Management. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

portalUrl?: string

Valor de propiedad

string

privateEndpointConnections

Lista de conexiones de punto de conexión privado de este servicio.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Valor de propiedad

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Direcciones IP de carga equilibrada estática privada del servicio API Management en la región primaria que se implementa en un Virtual Network interno. Solo está disponible para la SKU básica, estándar, premium y aislada. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

privateIPAddresses?: string[]

Valor de propiedad

string[]

provisioningState

El estado de aprovisionamiento actual del servicio API Management que puede ser uno de los siguientes: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

provisioningState?: string

Valor de propiedad

string

publicIPAddresses

Direcciones IP públicas de carga equilibrada estática del servicio API Management en la región primaria. Solo está disponible para la SKU básica, estándar, premium y aislada. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

publicIPAddresses?: string[]

Valor de propiedad

string[]

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.

publicIpAddressId?: string

Valor de propiedad

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"

publicNetworkAccess?: string

Valor de propiedad

string

restore

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.

restore?: boolean

Valor de propiedad

boolean

scmUrl

Dirección URL del punto de conexión de SCM del servicio API Management. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

scmUrl?: string

Valor de propiedad

string

targetProvisioningState

El estado de aprovisionamiento del servicio API Management, que está destinado a la operación de larga duración iniciada en el servicio. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

targetProvisioningState?: string

Valor de propiedad

string

virtualNetworkConfiguration

Configuración de red virtual del servicio API Management.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Valor de propiedad

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.

virtualNetworkType?: string

Valor de propiedad

string