Api Management Service - Apply Network Configuration Updates

Referencia

Service:: API Management

API Version:: 2022-08-01

Novedades el recurso Microsoft.ApiManagement que se ejecuta en la red virtual para elegir los cambios de DNS actualizados.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName	path	True	string	Nombre del servicio API Management. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
location	string	Ubicación del servicio Api Management que se va a actualizar para un servicio de varias regiones. Para un servicio implementado en una sola región, este parámetro no es necesario.

Respuestas

Nombre	Tipo	Description
200 OK	ApiManagementServiceResource	Las actualizaciones de configuración de red se aplicaron correctamente en el servicio Api Management.
202 Accepted		Aceptado: el encabezado Location contiene la dirección URL donde se puede comprobar el estado de la operación de larga duración. Headers location: string
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Nombre

Tipo

Description

200 OK

ApiManagementServiceResource

Las actualizaciones de configuración de red se aplicaron correctamente en el servicio Api Management.

202 Accepted

Aceptado: el encabezado Location contiene la dirección URL donde se puede comprobar el estado de la operación de larga duración.

Headers

location: string

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ApiManagementApplyNetworkConfigurationUpdates

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/applynetworkconfigurationupdates?api-version=2022-08-01

{
  "location": "west us"
}

import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceApplyNetworkConfigurationParameters;

/** Samples for ApiManagementService ApplyNetworkConfigurationUpdates. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json
     */
    /**
     * Sample code: ApiManagementApplyNetworkConfigurationUpdates.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementApplyNetworkConfigurationUpdates(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiManagementServices()
            .applyNetworkConfigurationUpdates(
                "rg1",
                "apimService1",
                new ApiManagementServiceApplyNetworkConfigurationParameters().withLocation("west us"),
                com.azure.core.util.Context.NONE);
    }
}

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

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_apply_network_configuration_updates.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="subid",
    )

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


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementApplyNetworkConfigurationUpdates.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

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json
func ExampleServiceClient_BeginApplyNetworkConfigurationUpdates() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewServiceClient().BeginApplyNetworkConfigurationUpdates(ctx, "rg1", "apimService1", &armapimanagement.ServiceClientBeginApplyNetworkConfigurationUpdatesOptions{Parameters: &armapimanagement.ServiceApplyNetworkConfigurationParameters{
		Location: to.Ptr("west us"),
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("apimService1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 		"UID": to.Ptr("52ed5986-717b-45b4-b17c-3df8db372cff"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAXX6Y="),
	// 	Location: to.Ptr("East Asia"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2015-09-22T01:50:34.792Z"); return t}()),
	// 		GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 		HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 		},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("207.46.155.24")},
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
	// 				SubnetResourceID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet"),
	// 			},
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeExternal),
	// 			PublisherEmail: to.Ptr("admin@live.com"),
	// 			PublisherName: to.Ptr("Contoso"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 	}
}

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

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
 *
 * @summary Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated DNS changes.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json
 */
async function apiManagementApplyNetworkConfigurationUpdates() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    location: "west us",
  };
  const options = {
    parameters,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginApplyNetworkConfigurationUpdatesAndWait(
    resourceGroupName,
    serviceName,
    options
  );
  console.log(result);
}

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

Sample Response

Status code:: 202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "UID": "52ed5986-717b-45b4-b17c-3df8db372cff"
  },
  "location": "East Asia",
  "etag": "AAAAAAAXX6Y=",
  "properties": {
    "publisherEmail": "admin@live.com",
    "publisherName": "Contoso",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2015-09-22T01:50:34.7921566Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [],
    "publicIPAddresses": [
      "207.46.155.24"
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/eastUsVirtualNetwork/subnets/apimSubnet"
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

Definiciones

Nombre	Description
AdditionalLocation	Descripción de una ubicación de recursos de API Management adicional.
ApiManagementServiceApplyNetworkConfigurationParameters	Parámetro proporcionado a la operación Aplicar configuración de red.
ApiManagementServiceIdentity	Propiedades de identidad del recurso del servicio Api Management.
ApiManagementServiceResource	Un único recurso de servicio API Management en list or Get response (Enumerar u obtener respuesta).
ApiManagementServiceSkuProperties	API Management propiedades de SKU de recursos de servicio.
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 certificado que consta de certificados intermedios y certificados raíz que no son de confianza.
CertificateInformation	Información del certificado SSL.
CertificateSource	Origen del certificado.
CertificateStatus	Estado del certificado.
createdByType	Tipo de identidad que creó el recurso.
ErrorFieldContract	Contrato de campo de error.
ErrorResponse	Respuesta de error.
HostnameConfiguration	Configuración de nombre de host personalizada.
HostnameType	Tipo de nombre de host.
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 de servicios y el proveedor.
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"
RemotePrivateEndpointConnectionWrapper	Recurso de conexión de punto de conexión privado remoto.
SkuType	Nombre de la SKU.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
UserIdentityProperties
VirtualNetworkConfiguration	Configuración de una red virtual en la que se implementa API Management servicio.
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.

AdditionalLocation

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úblicas de salida asociados al servicio implementado de NAT Gateway. 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 de carga equilibrada estática privada del servicio de API Management que se implementa en un Virtual Network interno 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 de carga equilibrada 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 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.
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.

ApiManagementServiceApplyNetworkConfigurationParameters

Parámetro proporcionado a la operación Aplicar configuración de red.

Nombre	Tipo	Description
location	string	Ubicación del servicio Api Management que se va a actualizar para un servicio de varias regiones. Para un servicio implementado en una sola región, este parámetro no es necesario.

ApiManagementServiceIdentity

Propiedades de identidad del recurso del servicio Api Management.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad.
tenantId	string	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 del diccionario de identidades de usuario serán identificadores de recurso de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Un único recurso de servicio API Management en list or Get response (Enumerar u obtener respuesta).

Nombre	Tipo	Valor predeterminado	Description
etag	string		ETag del recurso.
id	string		Identificador del 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.createdAtUtc	string		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. 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 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_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
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. Se puede usar para deshabilitar la puerta de enlace en la región maestra.
properties.enableClientCertificate	boolean	False	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.
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.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		Email dirección desde la que se enviará la notificación.
properties.outboundPublicIPAddresses	string[]		Prefijos de dirección IPV4 públicas de salida asociados al servicio implementado de NAT Gateway. 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 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.
properties.provisioningState	string		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.
properties.publicIPAddresses	string[]		Direcciones IP estáticas públicas con equilibrio de carga 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 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.
properties.publicNetworkAccess	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"
properties.publisherEmail	string		Correo electrónico del publicador.
properties.publisherName	string		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á destinado a 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 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.
sku	ApiManagementServiceSkuProperties		Propiedades de SKU del servicio API Management.
systemData	systemData		Metadatos relacionados con la creación y la última modificación del recurso.
tags	object		Etiquetas del recurso.
type	string		El tipo de recurso para API Management recurso se establece en Microsoft.ApiManagement.
zones	string[]		Lista de zonas de disponibilidad de las que se indica dónde debe proceder el recurso.

ApiManagementServiceSkuProperties

API Management propiedades de SKU de recursos de servicio.

Nombre	Tipo	Description
capacity	integer	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

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.

Nombre	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

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 a API Management servicio con la versión igual o posterior a este valor.

ArmIdWrapper

Contenedor para un identificador de recurso de ARM

Nombre	Tipo	Description
id	string

CertificateConfiguration

Configuración de certificado que consta 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	enum: CertificateAuthority Root	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.

Nombre	Tipo	Description
expiry	string	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	Sujeto del certificado.
thumbprint	string	Huella digital del certificado

CertificateSource

Origen del certificado.

Nombre	Tipo	Description
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Estado del certificado.

Nombre	Tipo	Description
Completed	string
Failed	string
InProgress	string

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

Contrato de campo de error.

Nombre	Tipo	Description
code	string	Código de error de nivel de propiedad.
message	string	Representación legible del error de nivel de propiedad.
target	string	Nombre de propiedad.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error.code	string	Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.
error.details	ErrorFieldContract[]	La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.
error.message	string	Representación legible del error.

HostnameConfiguration

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, 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 generado por Azure AD, que tiene acceso GET al almacén de claves 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

Tipo de nombre de host.

Nombre	Tipo	Description
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

NatGatewayState

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

Nombre	Tipo	Description
Disabled	string	Nat Gateway está deshabilitado para el servicio.
Enabled	string	Nat Gateway está habilitado para el servicio.

PlatformVersion

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

Nombre	Tipo	Description
mtv1	string	Plataforma que ejecuta el servicio en la plataforma multiinquilino V1.
stv1	string	Plataforma que ejecuta el servicio en la plataforma single tenant V1.
stv2	string	Plataforma que ejecuta el servicio en la plataforma single tenant V2.
undetermined	string	No se puede determinar la versión de la plataforma, ya que no se implementa la plataforma de proceso.

PrivateEndpointServiceConnectionStatus

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

Nombre	Tipo	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Colección de información sobre el estado de la conexión entre el consumidor de servicios 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, rechazado o quitado la conexión.

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"

Nombre	Tipo	Description
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

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 del 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 de servicios 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

Nombre de la SKU.

Nombre	Tipo	Description
Basic	string	SKU básica de Api Management.
Consumption	string	SKU de consumo de Api Management.
Developer	string	SKU para desarrolladores de Api Management.
Isolated	string	SKU aislada de Api Management.
Premium	string	SKU Premium de Api Management.
Standard	string	SKU estándar de Api Management.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	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	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

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la identidad asignada por el usuario.
principalId	string	Identificador de entidad de seguridad de la identidad asignada por el usuario.

VirtualNetworkConfiguration

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

Nombre	Tipo	Description
subnetResourceId	string	Identificador de recurso completo de una subred en una red virtual en la que 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

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.

Nombre	Tipo	Description
External	string	El servicio forma parte de Virtual Network y es accesible desde Internet.
Internal	string	El servicio forma parte de Virtual Network y solo es accesible desde dentro de la red virtual.
None	string	El servicio no forma parte de ninguna Virtual Network.

Api Management Service - Apply Network Configuration Updates

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Ejemplos

ApiManagementApplyNetworkConfigurationUpdates

Sample Request

Sample Response

Definiciones

AdditionalLocation

ApiManagementServiceApplyNetworkConfigurationParameters

ApiManagementServiceIdentity

ApiManagementServiceResource

ApiManagementServiceSkuProperties

ApimIdentityType

ApiVersionConstraint

ArmIdWrapper

CertificateConfiguration

CertificateInformation

CertificateSource

CertificateStatus

createdByType

ErrorFieldContract

ErrorResponse

HostnameConfiguration

HostnameType

NatGatewayState

PlatformVersion

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

PublicNetworkAccess

RemotePrivateEndpointConnectionWrapper

SkuType

systemData

UserIdentityProperties

VirtualNetworkConfiguration

VirtualNetworkType

Recursos adicionales