Api Management Service - Refresh Hostnames

Servicio:: API Management

Versión de la API:: 2025-03-01-preview

Forzar la actualización del certificado SSL adjunto a los nombres de host personalizados configurados usando secret desde KeyVault en el servicio de gestión de API.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/refreshHostnames?api-version=2025-03-01-preview

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 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 minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ApiManagementServiceResource	La operación de Azure se completó correctamente.
202 Accepted		Operación de recurso aceptada. Encabezados Retry-After: integer location: string
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Nombre

Tipo

Description

200 OK

ApiManagementServiceResource

La operación de Azure se completó correctamente.

202 Accepted

Operación de recurso aceptada.

Encabezados

Retry-After: integer
location: string

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

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

ApiManagementServiceRefreshKeyVaultHostnames

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/refreshHostnames?api-version=2025-03-01-preview

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_service_refresh_key_vault_hostnames.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.api_management_service.begin_refresh_hostnames(
        resource_group_name="rg1",
        service_name="apimService1",
    ).result()
    print(response)


# x-ms-original-file: 2025-03-01-preview/ApiManagementServiceRefreshKeyVaultHostnames.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "etag": "AAAAAAK5GpM=",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "b413456e-a9c8-4242-9754-0a01c061bd41",
    "tenantId": "b413456e-a9c8-4242-9754-0a01c061bd41"
  },
  "location": "West Europe",
  "properties": {
    "additionalLocations": [
      {
        "disableGateway": false,
        "gatewayRegionalUrl": "https://apimService1-northeurope-01.regional.azure-api.net",
        "location": "North Europe",
        "outboundPublicIPAddresses": [
          "4.xxx.40.176"
        ],
        "platformVersion": "stv2",
        "publicIPAddresses": [
          "4.xxx.40.176"
        ],
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apimVnet/subnets/default2"
        }
      }
    ],
    "createdAtUtc": "2016-04-12T00:20:15.6018952Z",
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True"
    },
    "developerPortalStatus": "Enabled",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "disableGateway": false,
    "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "certificateSource": "BuiltIn",
        "defaultSslBinding": false,
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false
      },
      {
        "type": "Proxy",
        "certificate": {
          "expiry": "2025-12-18T11:11:47+00:00",
          "subject": "CN=*.msitesting.net",
          "thumbprint": "9833D531D7A45XXXXXXXXXXXX8BD392E0BD3F"
        },
        "certificateSource": "KeyVault",
        "defaultSslBinding": true,
        "hostName": "proxy.msitesting.net",
        "keyVaultId": "https://apim-msi-keyvault.vault.azure.net/secrets/sslcertificate",
        "negotiateClientCertificate": false
      }
    ],
    "legacyPortalStatus": "Disabled",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "natGatewayState": "Disabled",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "outboundPublicIPAddresses": [
      "57.xxx.61.xx"
    ],
    "platformVersion": "stv2.1",
    "provisioningState": "Succeeded",
    "publicIPAddresses": [
      "XX.153.XX.94"
    ],
    "publicNetworkAccess": "Enabled",
    "publisherEmail": "autorest@contoso.com",
    "publisherName": "Microsoft",
    "releaseChannel": "Default",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1/subnets/default"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "systemData": {
    "lastModifiedAt": "2024-06-14T17:33:34.8195595Z",
    "lastModifiedBy": "autorest@contoso.com",
    "lastModifiedByType": "User"
  },
  "tags": {}
}

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=2025-03-01-preview

Definiciones

Nombre	Description
AdditionalLocation	Descripción de una ubicación de recursos de API Management adicional.
ApiManagementServiceIdentity	Propiedades de identidad del recurso de servicio de Api Management.
ApiManagementServiceResource	Un único recurso de servicio de API Management en List o Get response.
ApiManagementServiceSkuProperties	Propiedades de SKU de recursos de servicio de 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	Un contenedor para un identificador de recurso de ARM
CertificateConfiguration	Configuración de certificados que constan de certificados intermedios y certificados raíz que no son de confianza.
CertificateConfigurationStoreName	Ubicación del almacén de certificados System.Security.Cryptography.x509certificates.StoreName. Solo root y CertificateAuthority son ubicaciones válidas.
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.
NatGatewayState	La propiedad se puede usar para habilitar NAT Gateway para este servicio de API Management.
PlatformVersion	Versión de la plataforma informática 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"
ReleaseChannel	Canal de versión de este servicio de API Management.
RemotePrivateEndpointConnectionWrapper	Recurso de 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 API Management Gateway.

AdditionalLocation

Objeto

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ública saliente asociados con el servicio implementado de puerta de enlace NAT. Disponible solo para SKU Premium en la plataforma stv2.
platformVersion	PlatformVersion		Versión de la plataforma informática que ejecuta el servicio.
privateIPAddresses	string[]		Direcciones IP privadas estáticas con equilibrio de carga del servicio API Management que se implementa en una red virtual interna en una ubicación adicional determinada. Disponible solo para SKU Basic, Standard, Premium y Isolated (SKU) Basic, Standard, Premium y Isolated (SKU).
publicIPAddresses	string[]		Direcciones IP públicas estáticas con equilibrio de carga del servicio API Management en la ubicación adicional. Disponible solo para SKU Basic, Standard, Premium y Isolated (SKU) Basic, Standard, Premium y Isolated (SKU).
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

Objeto

Propiedades de identidad del recurso de servicio de Api Management.

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de seguridad de la identidad.
tenantId	string (uuid)	El identificador de inquilino de 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

Objeto

Un único recurso de servicio de API Management en List o Get response.

Nombre	Tipo	Valor predeterminado	Description
etag	string		ETag del recurso.
id	string		Identificador de recurso completo para el recurso. Ej: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ApiManagementServiceIdentity		Identidad de servicio administrada del servicio Api Management.
location	string		Ubicación geográfica donde reside el 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 la norma ISO 8601.
properties.customProperties	object		Propiedades personalizadas del servicio API Management. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` deshabilitará el TLS_RSA_WITH_3DES_EDE_CBC_SHA de cifrado para todos los 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-ends. La configuración `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` se puede usar para deshabilitar TLS 1.0 para las comunicaciones con back-ends. 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 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 inhabilitar, ya que son necesarios para los componentes internos de la plataforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
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 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 la 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ública saliente asociados con el servicio implementado de puerta de enlace NAT. Disponible solo para SKU Premium en la plataforma stv2.
properties.platformVersion	PlatformVersion		Versión de la plataforma informática que ejecuta el servicio en esta ubicación.
properties.portalUrl	string		Dirección URL del punto de conexión del portal del editor del servicio API Management.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista de conexiones de punto de conexión privado de este servicio.
properties.privateIPAddresses	string[]		Direcciones IP privadas estáticas con equilibrio de carga del servicio API Management en la región primaria que se implementa en una red virtual interna. Disponible solo para SKU Basic, Standard, Premium y Isolated (SKU) Basic, Standard, Premium y Isolated (SKU).
properties.provisioningState	string		El estado de aprovisionamiento actual del servicio API Management, que puede ser uno de los siguientes: Creado/Activando/Correcto/Actualizando/Error/Detenido/Terminando/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		Direcciones IP públicas estáticas con equilibrio de carga del servicio API Management en la región primaria. Disponible solo para SKU Basic, Standard, Premium y Isolated (SKU) Basic, Standard, Premium y Isolated (SKU).
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.releaseChannel	ReleaseChannel		Canal de versión de este servicio de API Management.
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, al que se dirige la operación de larga duración 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.
properties.zoneRedundant	boolean	False	Requisito de redundancia de zonas al crear StandardV2 y PremiumV2. Si esta bandera está configurada en Verdadero, devolverá un servicio APIM con Zona redundante o fallará la solicitud si alguno componente inferior no puede ser redundante en zona.
sku	ApiManagementServiceSkuProperties		Propiedades de SKU del servicio API Management.
systemData	systemData		Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object		Etiquetas de recursos.
type	string		Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"
zones	string[]		Zonas de disponibilidad.

ApiManagementServiceSkuProperties

Objeto

Propiedades de SKU de recursos de servicio de 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
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ApiVersionConstraint

Objeto

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

Objeto

Un contenedor para un identificador de recurso de ARM

Nombre	Tipo	Description
id	string

CertificateConfiguration

Objeto

Configuración de certificados que constan de certificados intermedios y certificados raíz 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	CertificateConfigurationStoreName	Ubicación del almacén de certificados System.Security.Cryptography.x509certificates.StoreName. Solo root y CertificateAuthority son ubicaciones válidas.

CertificateConfigurationStoreName

Enumeración

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

Valor	Description
CertificateAuthority
Root

CertificateInformation

Objeto

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
Managed
KeyVault
Custom
BuiltIn

CertificateStatus

Enumeración

Estado del certificado.

Valor	Description
Completed
Failed
InProgress

ConfigurationApi

Objeto

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
User
Application
ManagedIdentity
Key

DeveloperPortalStatus

Enumeración

Estado del portal para desarrolladores en este servicio API Management.

Valor	Description
Enabled	El Portal para desarrolladores está habilitado para el servicio.
Disabled	El Portal para desarrolladores está deshabilitado para el servicio.

ErrorAdditionalInfo

Objeto

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

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

HostnameConfiguration

Objeto

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
Proxy
Portal
Management
Scm
DeveloperPortal
ConfigurationApi

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
Enabled	La API de configuración heredada (v1) está habilitada para el servicio y las puertas de enlace autohospedadas pueden conectarse a ella.
Disabled	La API de configuración heredada (v1) está deshabilitada para el servicio y las puertas de enlace autohospedadas no pueden conectarse a ella.

LegacyPortalStatus

Enumeración

Estado del portal heredado en el servicio API Management.

Valor	Description
Enabled	El Portal heredado está habilitado para el servicio.
Disabled	El portal heredado está deshabilitado para el servicio.

NatGatewayState

Enumeración

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

Valor	Description
Enabled	Nat Gateway está habilitado para el servicio.
Disabled	Nat Gateway está deshabilitado para el servicio.

PlatformVersion

Enumeración

Versión de la plataforma informática que ejecuta el servicio.

Valor	Description
undetermined	No se puede determinar la versión de la plataforma, ya que la plataforma informática no está implementada.
stv1	Plataforma que ejecuta el servicio en la plataforma Single Tenant V1.
stv2	Plataforma que ejecuta el servicio en la plataforma Single Tenant V2.
mtv1	Plataforma que ejecuta el servicio en la plataforma Multi Tenant V1.
stv2.1	Plataforma que ejecuta el servicio en la plataforma Single Tenant V2 en hardware más reciente.

PrivateEndpointServiceConnectionStatus

Enumeración

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

Valor	Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

Objeto

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
Enabled
Disabled

ReleaseChannel

Enumeración

Canal de versión de este servicio de API Management.

Valor	Description
Preview	Canal de vista previa del servicio.
Default	Canal predeterminado del servicio.
Stable	Canal estable del servicio.

RemotePrivateEndpointConnectionWrapper

Objeto

Recurso de 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
Developer	SKU para desarrolladores de Api Management.
Standard	SKU estándar de Api Management.
Premium	SKU Premium de Api Management.
Basic	SKU básica de Api Management.
Consumption	SKU de consumo de Api Management.
Isolated	SKU aislada de Api Management.
BasicV2	SKU BasicV2 de Api Management.
StandardV2	SKU StandardV2 de Api Management.
PremiumV2	SKU PremiumV2 de la gestión de APIs.

systemData

Objeto

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

Objeto

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

Objeto

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	El 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 API Management Gateway.

Valor	Description
None	La puerta de enlace de API Management no forma parte de ninguna red virtual.
External	La puerta de enlace de API Management forma parte de Virtual Network y se puede acceder a ella desde Internet.
Internal	La puerta de enlace de API Management forma parte de Virtual Network y solo se puede acceder a ella desde la red virtual.

Compartir a través de

Api Management Service - Refresh Hostnames

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ApiManagementServiceRefreshKeyVaultHostnames

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AdditionalLocation

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateConfigurationStoreName

CertificateInformation

CertificateSource

CertificateStatus

ConfigurationApi

createdByType

DeveloperPortalStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HostnameConfiguration

HostnameType

LegacyApiState

LegacyPortalStatus

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

ReleaseChannel

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType