Api Management Service - Apply Network Configuration Updates

Riferimento

Service:: API Management

API Version:: 2022-08-01

Aggiornamenti la risorsa Microsoft.ApiManagement in esecuzione nella rete virtuale per selezionare le modifiche DNS aggiornate.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
serviceName	path	True	string	Nome del servizio di Gestione API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
location	string	Posizione del servizio Gestione API da aggiornare per un servizio in più aree. Per un servizio distribuito in una singola area, questo parametro non è obbligatorio.

Risposte

Nome	Tipo	Descrizione
200 OK	ApiManagementServiceResource	Gli aggiornamenti della configurazione di rete sono stati applicati correttamente al servizio Gestione API.
202 Accepted		Accettato: l'intestazione Location contiene l'URL in cui è possibile controllare lo stato dell'operazione a esecuzione prolungata. Headers location: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

ApiManagementServiceResource

Gli aggiornamenti della configurazione di rete sono stati applicati correttamente al servizio Gestione API.

202 Accepted

Accettato: l'intestazione Location contiene l'URL in cui è possibile controllare lo stato dell'operazione a esecuzione prolungata.

Headers

location: string

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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
  }
}

Definizioni

Nome	Descrizione
AdditionalLocation	Descrizione di un percorso aggiuntivo Gestione API risorsa.
ApiManagementServiceApplyNetworkConfigurationParameters	Parametro fornito all'operazione applica configurazione di rete.
ApiManagementServiceIdentity	Proprietà di identità della risorsa del servizio Gestione API.
ApiManagementServiceResource	Una singola risorsa del servizio Gestione API in Elenco o Ottieni risposta.
ApiManagementServiceSkuProperties	Gestione API proprietà sku della risorsa del servizio.
ApimIdentityType	Tipo di identità usata per la risorsa. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.
ApiVersionConstraint	Vincolo di versione api del piano di controllo per il servizio Gestione API.
ArmIdWrapper	Wrapper per un ID risorsa ARM
CertificateConfiguration	Configurazione del certificato costituita da intermedi non attendibili e certificati radice.
CertificateInformation	Informazioni sul certificato SSL.
CertificateSource	Origine certificato.
CertificateStatus	Stato certificato.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorFieldContract	Contratto campo di errore.
ErrorResponse	Risposta errore.
HostnameConfiguration	Configurazione personalizzata del nome host.
HostnameType	Tipo nome host.
NatGatewayState	La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.
PlatformVersion	Versione della piattaforma di calcolo che esegue il servizio.
PrivateEndpointServiceConnectionStatus	Stato della connessione dell'endpoint privato.
PrivateLinkServiceConnectionState	Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider.
PublicNetworkAccess	Indica se l'accesso all'endpoint pubblico è consentito per questo servizio Gestione API. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'. Se "Disabilitato", gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled'
RemotePrivateEndpointConnectionWrapper	Risorsa Connessione endpoint privato remoto.
SkuType	Nome dello SKU.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UserIdentityProperties
VirtualNetworkConfiguration	Configurazione di una rete virtuale in cui viene distribuito Gestione API servizio.
VirtualNetworkType	Tipo di VPN in cui Gestione API servizio deve essere configurato. Nessuno (valore predefinito) indica che il servizio Gestione API non fa parte di alcuna Rete virtuale, external indica che la distribuzione Gestione API è configurata all'interno di un Rete virtuale con un endpoint con connessione Internet e internal significa che Gestione API distribuzione è configurata all'interno di un Rete virtuale avere solo un endpoint con connessione Intranet.

AdditionalLocation

Descrizione di un percorso aggiuntivo Gestione API risorsa.

Nome	Tipo	Valore predefinito	Descrizione
disableGateway	boolean	False	Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Questa opzione può essere usata per disabilitare il gateway in questo percorso aggiuntivo.
gatewayRegionalUrl	string		URL del gateway del servizio Gestione API nell'area.
location	string		Nome della località dell'area aggiuntiva tra le aree del data center di Azure.
natGatewayState	NatGatewayState	Disabled	La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.
outboundPublicIPAddresses	string[]		Prefissi di indirizzi IPV4 pubblici in uscita associati al servizio distribuito gateway NAT. Disponibile solo per lo SKU Premium nella piattaforma stv2.
platformVersion	PlatformVersion		Versione della piattaforma di calcolo che esegue il servizio.
privateIPAddresses	string[]		Indirizzi IP con carico bilanciato statico privato del servizio Gestione API distribuito in un Rete virtuale interno in una determinata posizione aggiuntiva. Disponibile solo per SKU Basic, Standard, Premium e Isolato.
publicIPAddresses	string[]		Indirizzi IP statici statici con carico bilanciato pubblico del servizio Gestione API nella posizione aggiuntiva. Disponibile solo per SKU Basic, Standard, Premium e Isolato.
publicIpAddressId	string		Indirizzo IP pubblico standard basato su IP V4 da associare a Rete virtuale servizio distribuito nel percorso. Supportato solo per lo SKU Premium distribuito in Rete virtuale.
sku	ApiManagementServiceSkuProperties		Proprietà SKU del servizio Gestione API.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Configurazione della rete virtuale per il percorso.
zones	string[]		Elenco di zone di disponibilità che indicano da cui deve provenire la risorsa.

ApiManagementServiceApplyNetworkConfigurationParameters

Parametro fornito all'operazione applica configurazione di rete.

Nome	Tipo	Descrizione
location	string	Posizione del servizio Gestione API da aggiornare per un servizio in più aree. Per un servizio distribuito in una singola area, questo parametro non è obbligatorio.

ApiManagementServiceIdentity

Proprietà di identità della risorsa del servizio Gestione API.

Nome	Tipo	Descrizione
principalId	string	ID dell'entità dell'identità.
tenantId	string	ID tenant client dell'identità.
type	ApimIdentityType	Tipo di identità usata per la risorsa. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.
userAssignedIdentities	<string, UserIdentityProperties>	Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Una singola risorsa del servizio Gestione API in Elenco o Ottieni risposta.

Nome	Tipo	Valore predefinito	Descrizione
etag	string		ETag della risorsa.
id	string		ID risorsa.
identity	ApiManagementServiceIdentity		Identità del servizio gestito del servizio Gestione API.
location	string		Percorso della risorsa.
name	string		Nome risorsa.
properties.additionalLocations	AdditionalLocation[]		Località del data center aggiuntive del servizio Gestione API.
properties.apiVersionConstraint	ApiVersionConstraint		Vincolo di versione api del piano di controllo per il servizio Gestione API.
properties.certificates	CertificateConfiguration[]		Elenco di certificati che devono essere installati nel servizio Gestione API. Il numero massimo di certificati supportati che è possibile installare è 10.
properties.createdAtUtc	string		Data UTC di creazione del servizio Gestione API. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.
properties.customProperties	object		Proprietà personalizzate del servizio Gestione API. L'impostazione `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` disabilita il TLS_RSA_WITH_3DES_EDE_CBC_SHA di crittografia per tutti i protocolli TLS(1.0, 1.1 e 1.2). L'impostazione `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` può essere usata per disabilitare solo TLS 1.1. L'impostazione `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` può essere usata per disabilitare TLS 1.0 in un servizio Gestione API. L'impostazione `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` può essere usata per disabilitare solo TLS 1.1 per le comunicazioni con back-end. L'impostazione `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` può essere usata per disabilitare TLS 1.0 per le comunicazioni con back-end. L'impostazione `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` può essere usata per abilitare il protocollo HTTP2 in un servizio Gestione API. Se non si specifica alcuna di queste proprietà nell'operazione PATCH, i valori delle proprietà verranno reimpostati sui valori predefiniti. Per tutte le impostazioni ad eccezione di Http2, il valore predefinito è `True` se il servizio è stato creato il 1° aprile 2018 e `False` in caso contrario. Il valore predefinito dell'impostazione Http2 è `False`. È possibile disabilitare una delle crittografie seguenti usando le impostazioni `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. Ad esempio, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. Il valore predefinito è `true` per loro. Nota: le crittografie seguenti non possono essere disabilitate perché sono richieste dai componenti interni della piattaforma: 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		URL dell'endpoint del portale DEveloper del servizio Gestione API.
properties.disableGateway	boolean	False	Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Può essere usato per disabilitare il gateway nell'area master.
properties.enableClientCertificate	boolean	False	La proprietà deve essere usata solo per il servizio SKU a consumo. In questo modo viene applicato un certificato client da presentare a ogni richiesta al gateway. In questo modo è anche possibile autenticare il certificato nei criteri nel gateway.
properties.gatewayRegionalUrl	string		URL del gateway del servizio Gestione API nell'area predefinita.
properties.gatewayUrl	string		URL del gateway del servizio Gestione API.
properties.hostnameConfigurations	HostnameConfiguration[]		Configurazione personalizzata del nome host del servizio di Gestione API.
properties.managementApiUrl	string		URL dell'endpoint dell'API di gestione del servizio Gestione API.
properties.natGatewayState	NatGatewayState	Disabled	La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.
properties.notificationSenderEmail	string		Email indirizzo da cui verrà inviata la notifica.
properties.outboundPublicIPAddresses	string[]		Prefissi di indirizzi IPV4 pubblici in uscita associati al servizio distribuito gateway NAT. Disponibile solo per lo SKU Premium nella piattaforma stv2.
properties.platformVersion	PlatformVersion		Versione della piattaforma di calcolo che esegue il servizio in questa posizione.
properties.portalUrl	string		URL dell'endpoint del portale di pubblicazione del servizio Gestione API.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Elenco delle connessioni endpoint privato di questo servizio.
properties.privateIPAddresses	string[]		Indirizzi IP con carico bilanciato statico privato del servizio Gestione API nell'area primaria distribuita in un Rete virtuale interno. Disponibile solo per SKU Basic, Standard, Premium e Isolato.
properties.provisioningState	string		Stato di provisioning corrente del servizio di Gestione API che può essere uno dei seguenti: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
properties.publicIPAddresses	string[]		Indirizzi IP con carico bilanciato statico pubblico del servizio Gestione API nell'area primaria. Disponibile solo per SKU Basic, Standard, Premium e Isolato.
properties.publicIpAddressId	string		Indirizzo IP pubblico standard basato su IP V4 da associare a Rete virtuale servizio distribuito nell'area. Supportato solo per lo SKU Developer e Premium distribuito in Rete virtuale.
properties.publicNetworkAccess	PublicNetworkAccess		Indica se l'accesso all'endpoint pubblico è consentito per questo servizio Gestione API. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'. Se "Disabilitato", gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled'
properties.publisherEmail	string		Indirizzo di posta elettronica dell'editore.
properties.publisherName	string		Nome del server di pubblicazione.
properties.restore	boolean	False	Annullare l'eliminazione del servizio Gestione API se è stato eliminato soft in precedenza. Se questo flag viene specificato e impostato su True, tutte le altre proprietà verranno ignorate.
properties.scmUrl	string		URL dell'endpoint SCM del servizio Gestione API.
properties.targetProvisioningState	string		Stato di provisioning del servizio Gestione API, destinato all'operazione a esecuzione prolungata avviata nel servizio.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Configurazione della rete virtuale del servizio Gestione API.
properties.virtualNetworkType	VirtualNetworkType	None	Tipo di VPN in cui Gestione API servizio deve essere configurato. Nessuno (valore predefinito) indica che il servizio Gestione API non fa parte di alcuna Rete virtuale, external indica che la distribuzione Gestione API è configurata all'interno di un Rete virtuale con un endpoint con connessione Internet e internal significa che Gestione API distribuzione è configurata all'interno di un Rete virtuale avere solo un endpoint con connessione Intranet.
sku	ApiManagementServiceSkuProperties		Proprietà SKU del servizio Gestione API.
systemData	systemData		Metadati relativi alla creazione e all'ultima modifica della risorsa.
tags	object		Tag delle risorse.
type	string		Il tipo di risorsa per Gestione API risorsa è impostato su Microsoft.ApiManagement.
zones	string[]		Elenco di zone di disponibilità che indicano da cui deve provenire la risorsa.

ApiManagementServiceSkuProperties

Gestione API proprietà sku della risorsa del servizio.

Nome	Tipo	Descrizione
capacity	integer	Capacità dello SKU (numero di unità distribuite dello SKU). Per la capacità SKU a consumo deve essere specificato come 0.
name	SkuType	Nome dello SKU.

ApimIdentityType

Tipo di identità usata per la risorsa. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio.

Nome	Tipo	Descrizione
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

Vincolo di versione api del piano di controllo per il servizio Gestione API.

Nome	Tipo	Descrizione
minApiVersion	string	Limitare le chiamate API del piano di controllo a Gestione API servizio con versione uguale o successiva a questo valore.

ArmIdWrapper

Wrapper per un ID risorsa ARM

Nome	Tipo	Descrizione
id	string

CertificateConfiguration

Configurazione del certificato costituita da intermedi non attendibili e certificati radice.

Nome	Tipo	Descrizione
certificate	CertificateInformation	Informazioni sul certificato.
certificatePassword	string	Password del certificato.
encodedCertificate	string	Certificato con codifica Base64.
storeName	enum: CertificateAuthority Root	Percorso dell'archivio certificati System.Security.Cryptography.x509certificates.StoreName. Solo Root e CertificateAuthority sono percorsi validi.

CertificateInformation

Informazioni sul certificato SSL.

Nome	Tipo	Descrizione
expiry	string	Data di scadenza del certificato. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.
subject	string	Oggetto del certificato.
thumbprint	string	Identificazione personale del certificato.

CertificateSource

Origine certificato.

Nome	Tipo	Descrizione
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Stato certificato.

Nome	Tipo	Descrizione
Completed	string
Failed	string
InProgress	string

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

Contratto campo di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore a livello di proprietà.
message	string	Rappresentazione leggibile dell'errore a livello di proprietà.
target	string	Nome della proprietà.

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
error.code	string	Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message	string	Rappresentazione leggibile dell'errore.

HostnameConfiguration

Configurazione personalizzata del nome host.

Nome	Tipo	Valore predefinito	Descrizione
certificate	CertificateInformation		Informazioni sul certificato.
certificatePassword	string		Password del certificato.
certificateSource	CertificateSource		Origine certificato.
certificateStatus	CertificateStatus		Stato certificato.
defaultSslBinding	boolean	False	Specificare true per configurare il certificato associato a questo nome host come certificato SSL predefinito. Se un client non invia l'intestazione SNI, questo sarà il certificato che verrà contestato. La proprietà è utile se un servizio dispone di più nomi host personalizzati abilitati e deve decidere il certificato SSL predefinito. L'impostazione viene applicata solo al tipo di nome host del gateway.
encodedCertificate	string		Certificato con codifica Base64.
hostName	string		Nome host da configurare nel servizio Gestione API.
identityClientId	string		ClientId identità gestita assegnata dal sistema o dall'utente generato da Azure AD, che ha accesso GET all'insieme di credenziali delle chiavi contenente il certificato SSL.
keyVaultId	string		URL del segreto KeyVault contenente il certificato SSL. Se viene fornito l'URL assoluto contenente la versione, l'aggiornamento automatico del certificato SSL non funzionerà. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi. Il segreto deve essere di tipo application/x-pkcs12
negotiateClientCertificate	boolean	False	Specificare true per negoziare sempre il certificato client nel nome host. Il valore predefinito è false.
type	HostnameType		Tipo nome host.

HostnameType

Tipo nome host.

Nome	Tipo	Descrizione
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

NatGatewayState

La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.

Nome	Tipo	Descrizione
Disabled	string	Il gateway NAT è disabilitato per il servizio.
Enabled	string	Il gateway NAT è abilitato per il servizio.

PlatformVersion

Versione della piattaforma di calcolo che esegue il servizio.

Nome	Tipo	Descrizione
mtv1	string	Piattaforma che esegue il servizio nella piattaforma Multi-Tenant V1.
stv1	string	Piattaforma che esegue il servizio nella piattaforma V1 a tenant singolo.
stv2	string	Piattaforma che esegue il servizio nella piattaforma V2 a tenant singolo.
undetermined	string	Non è possibile determinare la versione della piattaforma, perché la piattaforma di calcolo non viene distribuita.

PrivateEndpointServiceConnectionStatus

Stato della connessione dell'endpoint privato.

Nome	Tipo	Descrizione
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider.

Nome	Tipo	Descrizione
actionsRequired	string	Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer.
description	string	Motivo dell'approvazione/rifiuto della connessione.
status	PrivateEndpointServiceConnectionStatus	Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio.

PublicNetworkAccess

Indica se l'accesso all'endpoint pubblico è consentito per questo servizio Gestione API. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'. Se "Disabilitato", gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled'

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

Risorsa Connessione endpoint privato remoto.

Nome	Tipo	Descrizione
id	string	ID risorsa connessione endpoint privato
name	string	Nome connessione endpoint privato
properties.groupIds	string[]	Tutti gli ID gruppo.
properties.privateEndpoint	ArmIdWrapper	Risorsa dell'endpoint privato.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider.
properties.provisioningState	string	Stato di provisioning della risorsa di connessione dell'endpoint privato.
type	string	Tipo di risorsa connessione endpoint privato

SkuType

Nome dello SKU.

Nome	Tipo	Descrizione
Basic	string	SKU di base di Gestione API.
Consumption	string	SKU a consumo di Gestione API.
Developer	string	SKU per sviluppatori di Gestione API.
Isolated	string	SKU isolato di Gestione API.
Premium	string	SKU Premium di Gestione API.
Standard	string	SKU standard di Gestione API.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

UserIdentityProperties

Nome	Tipo	Descrizione
clientId	string	ID client dell'identità assegnata dall'utente.
principalId	string	ID principale dell'identità assegnata dall'utente.

VirtualNetworkConfiguration

Configurazione di una rete virtuale in cui viene distribuito Gestione API servizio.

Nome	Tipo	Descrizione
subnetResourceId	string	ID risorsa completo di una subnet in una rete virtuale in cui distribuire il servizio Gestione API.
subnetname	string	Nome della subnet.
vnetid	string	ID della rete virtuale. Si tratta in genere di un GUID. Per impostazione predefinita, è previsto un GUID Null.

VirtualNetworkType

Tipo di VPN in cui Gestione API servizio deve essere configurato. Nessuno (valore predefinito) indica che il servizio Gestione API non fa parte di alcuna Rete virtuale, external indica che la distribuzione Gestione API è configurata all'interno di un Rete virtuale con un endpoint con connessione Internet e internal significa che Gestione API distribuzione è configurata all'interno di un Rete virtuale avere solo un endpoint con connessione Intranet.

Nome	Tipo	Descrizione
External	string	Il servizio fa parte di Rete virtuale ed è accessibile da Internet.
Internal	string	Il servizio fa parte di Rete virtuale ed è accessibile solo dall'interno della rete virtuale.
None	string	Il servizio non fa parte di alcuna Rete virtuale.

Api Management Service - Apply Network Configuration Updates

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Esempio

ApiManagementApplyNetworkConfigurationUpdates

Sample Request

Sample Response

Definizioni

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

Risorse aggiuntive