Compartir a través de

Api Management Service - MigrateToStv2

  • Referencia
Servicio:
API Management
Versión de la API:
2024-05-01

Actualiza un servicio API Management a la plataforma Stv2. Para obtener más información, consulte https://aka.ms/apim-migrate-stv2. Este cambio no es reversible. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2?api-version=2024-05-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nombre del servicio API Management.
subscriptionId
 path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre Tipo Description
mode

MigrateToStv2Mode

Modo de migración a stv2. El valor predeterminado es PreserveIp.

Respuestas

Nombre Tipo Description
200 OK

ApiManagementServiceResource

El servicio se migró correctamente.
202 Accepted

Solicitud de migración enviada.

Encabezados

location: string
Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

ApiManagementMigrateService

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/migrateToStv2?api-version=2024-05-01

{
  "mode": "PreserveIp"
}

Respuesta de muestra

status code:
202 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-05-01
status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1",
  "name": "apimservice1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West US",
  "etag": "AAAAAADqC0c=",
  "properties": {
    "publisherEmail": "abcs@contoso.com",
    "publisherName": "contoso publisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-02T01:42:09.1268424Z",
    "gatewayUrl": "https://apimservice1.azure-api.net",
    "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net",
    "portalUrl": "https://apimservice1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimservice1.management.azure-api.net",
    "scmUrl": "https://apimservice1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "apimgatewaytest.preview.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2019-08-16T16:51:34+00:00",
          "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476",
          "subject": "CN=*.preview.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Custom"
      }
    ],
    "publicIPAddresses": [
      "137.XXX.11.74"
    ],
    "privateIPAddresses": [
      "172.XX.0.5"
    ],
    "additionalLocations": [
      {
        "location": "West US 2",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "40.XXX.79.187"
        ],
        "privateIPAddresses": [
          "10.0.X.6"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub"
        },
        "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net",
        "disableGateway": false
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False"
    },
    "virtualNetworkType": "Internal",
    "disableGateway": false,
    "apiVersionConstraint": {},
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

Definiciones

Nombre Description
AdditionalLocation

Descripción de una ubicación de recursos de API Management adicional.
ApiManagementServiceIdentity

Propiedades de identidad del recurso del servicio Api Management.
ApiManagementServiceResource

Un único recurso del servicio API Management en Lista o Obtención de respuesta.
ApiManagementServiceSkuProperties

Propiedades de SKU de recursos del servicio API Management.
ApimIdentityType

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

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

Contenedor para un identificador de recurso de ARM
CertificateConfiguration

Configuración de certificados que constan de certificados raíz y intermedios que no son de confianza.
CertificateInformation

Información del certificado SSL.
CertificateSource

Origen del certificado.
CertificateStatus

Estado del certificado.
ConfigurationApi

Información sobre la API de configuración del servicio API Management.
createdByType

Tipo de identidad que creó el recurso.
developerPortalStatus

Estado del portal para desarrolladores en este servicio API Management.
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
HostnameConfiguration

Configuración de nombre de host personalizada.
HostnameType

Tipo de nombre de host.
LegacyApiState

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 se ha deshabilitado, la API de configuración heredada (v1) no estará disponible para las puertas de enlace autohospedados. El valor predeterminado es "Enabled"
LegacyPortalStatus

Estado del portal heredado en el servicio API Management.
MigrateToStv2Contract

Describe una SKU de API Management disponible.
MigrateToStv2Mode

Modo de migración a stv2. El valor predeterminado es PreserveIp.
NatGatewayState

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

Versión de la plataforma de proceso que ejecuta el servicio.
PrivateEndpointServiceConnectionStatus

Estado de conexión del punto de conexión privado.
PrivateLinkServiceConnectionState

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
PublicNetworkAccess

Indica si se permite o no el acceso al punto de conexión público para este servicio de 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"
RemotePrivateEndpointConnectionWrapper

Recurso conexión de punto de conexión privado remoto.
SkuType

Nombre de la SKU.
systemData

Metadatos relativos a la creación y última modificación del recurso.
UserIdentityProperties
VirtualNetworkConfiguration

Configuración de una red virtual en la que se implementa el servicio API Management.
VirtualNetworkType

Tipo de VPN en el que se debe configurar el servicio API Management. Ninguno (valor predeterminado) significa que el servicio API Management no forma parte de ninguna red virtual, external significa que la implementación de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde Internet y que la implementación interna de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde intranet solo.

AdditionalLocation

Object

Descripción de una ubicación de recursos de API Management adicional.

Nombre Tipo Valor predeterminado Description
disableGateway

boolean

False

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

string

Dirección URL de puerta de enlace del servicio API Management en la región.
location

string

Nombre de ubicación de la región adicional entre las regiones del centro de datos de Azure.
natGatewayState

NatGatewayState

Disabled

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

string[]

Prefijos de dirección IPV4 públicos salientes asociados al servicio implementado de puerta de enlace NAT. Disponible solo para la SKU Premium en la plataforma stv2.
platformVersion

PlatformVersion

Versión de la plataforma de proceso que ejecuta el servicio.
privateIPAddresses

string[]

Direcciones IP estáticas de carga equilibrada privada del servicio API Management que se implementa en una red virtual interna en una ubicación adicional determinada. Solo está disponible para la SKU básica, estándar, premium y aislada.
publicIPAddresses

string[]

Direcciones IP estáticas públicas con equilibrio de carga del servicio API Management en la ubicación adicional. Solo está disponible para la SKU básica, estándar, premium y aislada.
publicIpAddressId

string

Dirección IP V4 basada en SKU estándar pública que se va a asociar al servicio implementado de red virtual en la ubicación. Solo se admite para la SKU Premium que se implementa en Virtual Network.
sku

ApiManagementServiceSkuProperties

Propiedades de SKU del servicio API Management.
virtualNetworkConfiguration

VirtualNetworkConfiguration

Configuración de red virtual para la ubicación.
zones

string[]

Lista de zonas de disponibilidad de las que se indica dónde debe proceder el recurso.

ApiManagementServiceIdentity

Object

Propiedades de identidad del recurso del servicio Api Management.

Nombre Tipo Description
principalId

string (uuid)

Identificador de entidad de seguridad de la identidad.
tenantId

string (uuid)

Identificador de inquilino del cliente de la identidad.
type

ApimIdentityType

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

<string,  UserIdentityProperties>

Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Object

Un único recurso del servicio API Management en Lista o Obtención de respuesta.

Nombre Tipo Valor predeterminado Description
etag

string

ETag del recurso.
id

string

Identificador de recurso.
identity

ApiManagementServiceIdentity

Identidad de servicio administrada del servicio Api Management.
location

string

Ubicación del recurso.
name

string

Nombre del recurso.
properties.additionalLocations

AdditionalLocation[]

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

ApiVersionConstraint

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

CertificateConfiguration[]

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.
properties.configurationApi

ConfigurationApi

Configuración de la configuración de la API del servicio API Management.
properties.createdAtUtc

string (date-time)

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.
properties.customProperties

object

Propiedades personalizadas del servicio API Management.
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).
configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 se puede usar para deshabilitar solo TLS 1.1.
configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 se puede usar para deshabilitar TLS 1.0 en un servicio de API Management.
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.
configuración Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 se puede usar para deshabilitar TLS 1.0 para las comunicaciones con back-end.
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 a 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 y False de 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 porque los componentes internos de la plataforma los requieren: 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
properties.developerPortalStatus

developerPortalStatus

Enabled

Estado del portal para desarrolladores en este servicio API Management.
properties.developerPortalUrl

string

Dirección URL del punto de conexión del portal de DEveloper del servicio API Management.
properties.disableGateway

boolean

False

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.
properties.enableClientCertificate

boolean

False

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 en la puerta de enlace.
properties.gatewayRegionalUrl

string

Dirección URL de puerta de enlace del servicio API Management en la región predeterminada.
properties.gatewayUrl

string

Dirección URL de puerta de enlace del servicio API Management.
properties.hostnameConfigurations

HostnameConfiguration[]

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

LegacyPortalStatus

Enabled

Estado del portal heredado en el servicio API Management.
properties.managementApiUrl

string

Dirección URL del punto de conexión de api de administración del servicio API Management.
properties.natGatewayState

NatGatewayState

Disabled

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

string

maxLength: 100

Dirección de correo electrónico desde la que se enviará la notificación.
properties.outboundPublicIPAddresses

string[]

Prefijos de dirección IPV4 públicos salientes asociados al servicio implementado de puerta de enlace NAT. Disponible solo para la SKU Premium en la plataforma stv2.
properties.platformVersion

PlatformVersion

Versión de la plataforma de proceso que ejecuta el servicio en esta ubicación.
properties.portalUrl

string

Dirección URL del punto de conexión del portal del publicador del servicio API Management.
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

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

string[]

Direcciones IP estáticas de carga equilibrada privada del servicio API Management en la región primaria que se implementa en una red virtual interna. Solo está disponible para la SKU básica, estándar, premium y aislada.
properties.provisioningState

string

El estado de aprovisionamiento actual del servicio API Management que puede ser uno de los siguientes: Created/Activating/Succeeded/Update/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses

string[]

Direcciones IP públicas con equilibrio de carga estática del servicio API Management en la región primaria. Solo está disponible para la SKU básica, estándar, premium y aislada.
properties.publicIpAddressId

string

Dirección IP V4 basada en la SKU estándar pública que se va a asociar al servicio implementado por Virtual Network en la región. Solo se admite para la SKU De desarrollador y Premium que se implementa en Virtual Network.
properties.publicNetworkAccess

PublicNetworkAccess

Indica si se permite o no el acceso al punto de conexión público para este servicio de 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"
properties.publisherEmail

string

maxLength: 100

Correo electrónico del publicador.
properties.publisherName

string

maxLength: 100

Nombre del publicador.
properties.restore

boolean

False

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

string

Dirección URL del punto de conexión de SCM del servicio API Management.
properties.targetProvisioningState

string

El estado de aprovisionamiento del servicio API Management, que está dirigido por la operación de ejecución prolongada iniciada en el servicio.
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

Configuración de red virtual del servicio API Management.
properties.virtualNetworkType

VirtualNetworkType

None

Tipo de VPN en el que se debe configurar el servicio API Management. Ninguno (valor predeterminado) significa que el servicio API Management no forma parte de ninguna red virtual, external significa que la implementación de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde Internet y que la implementación interna de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde intranet solo.
sku

ApiManagementServiceSkuProperties

Propiedades de SKU del servicio API Management.
systemData

systemData

Metadatos relativos a la creación y última modificación del recurso.
tags

object

Etiquetas de recursos.
type

string

El tipo de recurso de API Management se establece en Microsoft.ApiManagement.
zones

string[]

Lista de zonas de disponibilidad de las que se indica dónde debe proceder el recurso.

ApiManagementServiceSkuProperties

Object

Propiedades de SKU de recursos del servicio API Management.

Nombre Tipo Description
capacity

integer (int32)

Capacidad de la SKU (número de unidades implementadas de la SKU). Para la capacidad de SKU de consumo debe especificarse como 0.
name

SkuType

Nombre de la SKU.

ApimIdentityType

Enumeración

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.

Valor Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ApiVersionConstraint

Object

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

Nombre Tipo Description
minApiVersion

string

Limite las llamadas API del plano de control al servicio API Management con la versión igual o posterior a este valor.

ArmIdWrapper

Object

Contenedor para un identificador de recurso de ARM

Nombre Tipo Description
id

string

CertificateConfiguration

Object

Configuración de certificados que constan de certificados raíz y intermedios que no son de confianza.

Nombre Tipo Description
certificate

CertificateInformation

Información del certificado.
certificatePassword

string

Contraseña del certificado.
encodedCertificate

string

Certificado codificado en Base64.
storeName enum:
  • CertificateAuthority
  • Root

Ubicación del almacén de certificados System.Security.Cryptography.x509certificates.StoreName. Solo root y CertificateAuthority son ubicaciones válidas.

CertificateInformation

Object

Información del certificado SSL.

Nombre Tipo Description
expiry

string (date-time)

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

string

Asunto del certificado.
thumbprint

string

Huella digital del certificado.

CertificateSource

Enumeración

Origen del certificado.

Valor Description
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

Enumeración

Estado del certificado.

Valor Description
Completed
Failed
InProgress

ConfigurationApi

Object

Información sobre la API de configuración del servicio API Management.

Nombre Tipo Valor predeterminado Description
legacyApi

LegacyApiState

Enabled

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 se ha deshabilitado, la API de configuración heredada (v1) no estará disponible para las puertas de enlace autohospedados. El valor predeterminado es "Enabled"

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor Description
Application
Key
ManagedIdentity
User

developerPortalStatus

Enumeración

Estado del portal para desarrolladores en este servicio API Management.

Valor Description
Disabled

El Portal para desarrolladores está deshabilitado para el servicio.
Enabled

El Portal para desarrolladores está habilitado para el servicio.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

HostnameConfiguration

Object

Configuración de nombre de host personalizada.

Nombre Tipo Valor predeterminado Description
certificate

CertificateInformation

Información del certificado.
certificatePassword

string

Contraseña del certificado.
certificateSource

CertificateSource

Origen del certificado.
certificateStatus

CertificateStatus

Estado del certificado.
defaultSslBinding

boolean

False

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, este 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.
encodedCertificate

string

Certificado codificado en Base64.
hostName

string

Nombre de host que se va a configurar en el servicio Api Management.
identityClientId

string

ClientId de identidad administrada asignada por el sistema o el usuario generados por Azure AD, que tiene acceso GET al keyVault que contiene el certificado SSL.
keyVaultId

string

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
negotiateClientCertificate

boolean

False

Especifique true para negociar siempre el certificado de cliente en el nombre de host. El valor predeterminado es false.
type

HostnameType

Tipo de nombre de host.

HostnameType

Enumeración

Tipo de nombre de host.

Valor Description
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

Enumeración

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 se ha deshabilitado, la API de configuración heredada (v1) no estará disponible para las puertas de enlace autohospedados. El valor predeterminado es "Enabled"

Valor Description
Disabled

La API de configuración heredada (v1) está deshabilitada para el servicio y las puertas de enlace autohospedados no se pueden conectar a ella.
Enabled

La API de configuración heredada (v1) está habilitada para el servicio y las puertas de enlace autohospedados pueden conectarse a ella.

LegacyPortalStatus

Enumeración

Estado del portal heredado en el servicio API Management.

Valor Description
Disabled

El portal heredado está deshabilitado para el servicio.
Enabled

El portal heredado está habilitado para el servicio.

MigrateToStv2Contract

Object

Describe una SKU de API Management disponible.

Nombre Tipo Description
mode

MigrateToStv2Mode

Modo de migración a stv2. El valor predeterminado es PreserveIp.

MigrateToStv2Mode

Enumeración

Modo de migración a stv2. El valor predeterminado es PreserveIp.

Valor Description
NewIP

Migre el servicio API Management a stv2 desde stv1. Esto no tendrá tiempo de inactividad, ya que la configuración del servicio se migrará a la nueva infraestructura, pero la dirección IP cambiará.
PreserveIp

Migre el servicio API Management a stv2 desde stv1 reservando la dirección IP del servicio. Esto tendrá un tiempo de inactividad de hasta 15 minutos, mientras que la dirección IP se está migrando a una nueva infraestructura.

NatGatewayState

Enumeración

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

Valor Description
Disabled

Nat Gateway está deshabilitado para el servicio.
Enabled

Nat Gateway está habilitado para el servicio.

PlatformVersion

Enumeración

Versión de la plataforma de proceso que ejecuta el servicio.

Valor Description
mtv1

Plataforma que ejecuta el servicio en la plataforma multiinquilino V1.
stv1

Plataforma que ejecuta el servicio en la plataforma V1 de un solo inquilino.
stv2

Plataforma que ejecuta el servicio en la plataforma single tenant V2.
stv2.1

Plataforma que ejecuta el servicio en la plataforma Single Tenant V2 en hardware más reciente.
undetermined

No se puede determinar la versión de la plataforma, ya que no se implementa la plataforma de proceso.

PrivateEndpointServiceConnectionStatus

Enumeración

Estado de conexión del punto de conexión privado.

Valor Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

Nombre Tipo Description
actionsRequired

string

Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description

string

Motivo de aprobación o rechazo de la conexión.
status

PrivateEndpointServiceConnectionStatus

Indica si el propietario del servicio ha aprobado o rechazado o eliminado la conexión.

PublicNetworkAccess

Enumeración

Indica si se permite o no el acceso al punto de conexión público para este servicio de 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"

Valor Description
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Object

Recurso conexión de punto de conexión privado remoto.

Nombre Tipo Description
id

string

Identificador de recurso de conexión de punto de conexión privado
name

string

Nombre de conexión de punto de conexión privado
properties.groupIds

string[]

Todos los identificadores de grupo.
properties.privateEndpoint

ArmIdWrapper

Recurso del punto de conexión privado.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
properties.provisioningState

string

Estado de aprovisionamiento del recurso de conexión de punto de conexión privado.
type

string

Tipo de recurso de conexión de punto de conexión privado

SkuType

Enumeración

Nombre de la SKU.

Valor Description
Basic

SKU básica de Api Management.
BasicV2

SKU BasicV2 de Api Management.
Consumption

SKU de consumo de Api Management.
Developer

SKU de desarrollador de Api Management.
Isolated

SKU aislada de Api Management.
Premium

SKU Premium de Api Management.
Standard

SKU estándar de Api Management.
StandardV2

SKU StandardV2 de Api Management.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string (date-time)

Marca de tiempo de creación de recursos (UTC).
createdBy

string

Identidad que creó el recurso.
createdByType

createdByType

Tipo de identidad que creó el recurso.
lastModifiedAt

string (date-time)

Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy

string

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

UserIdentityProperties

Object
Nombre Tipo Description
clientId

string

Identificador de cliente de la identidad asignada por el usuario.
principalId

string

Identificador principal de la identidad asignada por el usuario.

VirtualNetworkConfiguration

Object

Configuración de una red virtual en la que se implementa el servicio API Management.

Nombre Tipo Description
subnetResourceId

string

pattern: ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Identificador de recurso completo de una subred de una red virtual en la que se va a implementar el servicio API Management.
subnetname

string

Nombre de la subred.
vnetid

string

Identificador de red virtual. Normalmente, se trata de un GUID. Espere un GUID nulo de forma predeterminada.

VirtualNetworkType

Enumeración

Tipo de VPN en el que se debe configurar el servicio API Management. Ninguno (valor predeterminado) significa que el servicio API Management no forma parte de ninguna red virtual, external significa que la implementación de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde Internet y que la implementación interna de API Management está configurada dentro de una red virtual que tiene un punto de conexión accesible desde intranet solo.

Valor Description
External

El servicio forma parte de Virtual Network y es accesible desde Internet.
Internal

El servicio forma parte de Virtual Network y solo es accesible desde dentro de la red virtual.
None

El servicio no forma parte de ninguna red virtual.