Api Management Service - Apply Network Configuration Updates

Referência

Service:: API Management

API Version:: 2022-08-01

Atualizações o recurso Microsoft.ApiManagement em execução na rede virtual para escolher as alterações de DNS atualizadas.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName	path	True	string	O nome do serviço Gerenciamento de API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
location	string	Local do serviço de Gerenciamento de API a ser atualizado para um serviço de várias regiões. Para um serviço implantado em uma única região, esse parâmetro não é necessário.

Respostas

Nome	Tipo	Description
200 OK	ApiManagementServiceResource	As atualizações de configuração de rede foram aplicadas com êxito no serviço de Gerenciamento de API.
202 Accepted		Aceito: o cabeçalho de local contém a URL em que o status da operação de execução prolongada pode ser verificado. Headers location: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

ApiManagementServiceResource

As atualizações de configuração de rede foram aplicadas com êxito no serviço de Gerenciamento de API.

202 Accepted

Aceito: o cabeçalho de local contém a URL em que o status da operação de execução prolongada pode ser verificado.

Headers

location: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
AdditionalLocation	Descrição de um local de recurso de Gerenciamento de API adicional.
ApiManagementServiceApplyNetworkConfigurationParameters	Parâmetro fornecido para a operação de configuração Aplicar Rede.
ApiManagementServiceIdentity	Propriedades de identidade do recurso de serviço de Gerenciamento de API.
ApiManagementServiceResource	Um único recurso de serviço Gerenciamento de API em Listar ou Obter resposta.
ApiManagementServiceSkuProperties	Gerenciamento de API propriedades de SKU do recurso de serviço.
ApimIdentityType	O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço.
ApiVersionConstraint	Restrição de versão das Apis do Painel de Controle para o serviço Gerenciamento de API.
ArmIdWrapper	Um wrapper para uma ID de recurso do ARM
CertificateConfiguration	Configuração de certificado que consiste em intermediários não confiáveis e certificados raiz.
CertificateInformation	Informações de certificado SSL.
CertificateSource	Origem do certificado.
CertificateStatus	Status do Certificado.
createdByType	O tipo de identidade que criou o recurso.
ErrorFieldContract	Contrato de Campo de Erro.
ErrorResponse	Resposta de erro.
HostnameConfiguration	Configuração de nome de host personalizado.
HostnameType	Tipo de nome do host.
NatGatewayState	A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API.
PlatformVersion	Versão da Plataforma de Computação executando o serviço.
PrivateEndpointServiceConnectionStatus	A conexão do ponto de extremidade privado status.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
PublicNetworkAccess	Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço de Gerenciamento de API. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'. Se 'Disabled', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled'
RemotePrivateEndpointConnectionWrapper	Recurso conexão de ponto de extremidade privado remoto.
SkuType	Nome da SKU.
systemData	Metadados relativos à criação e à última modificação do recurso.
UserIdentityProperties
VirtualNetworkConfiguration	Configuração de uma rede virtual na qual Gerenciamento de API serviço é implantado.
VirtualNetworkType	O tipo de VPN no qual Gerenciamento de API serviço precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação do Gerenciamento de API está configurada dentro de um Rede Virtual ter um ponto de extremidade voltado para a Internet e interno significa que Gerenciamento de API A implantação é configurada dentro de uma Rede Virtual ter apenas um ponto de extremidade voltado para a intranet.

AdditionalLocation

Descrição de um local de recurso de Gerenciamento de API adicional.

Nome	Tipo	Valor padrão	Description
disableGateway	boolean	False	Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway nesse local adicional.
gatewayRegionalUrl	string		URL do gateway do serviço Gerenciamento de API na Região.
location	string		O nome do local da região adicional entre as regiões do Data center do Azure.
natGatewayState	NatGatewayState	Disabled	A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API.
outboundPublicIPAddresses	string[]		Prefixos de endereço IPV4 públicos de saída associados ao serviço implantado do Gateway da NAT. Disponível somente para SKU Premium na plataforma stv2.
platformVersion	PlatformVersion		Versão da Plataforma de Computação executando o serviço.
privateIPAddresses	string[]		Endereços IP com balanceamento de carga estático privados do serviço Gerenciamento de API que é implantado em um Rede Virtual Interno em um local adicional específico. Disponível somente para SKU Básico, Standard, Premium e Isolado.
publicIPAddresses	string[]		Endereços IP públicos com balanceamento de carga estático do serviço Gerenciamento de API no local adicional. Disponível somente para SKU Básico, Standard, Premium e Isolado.
publicIpAddressId	string		Endereço IP baseado em IP de SKU Padrão Público V4 a ser associado a Rede Virtual serviço implantado no local. Compatível apenas com o SKU Premium que está sendo implantado no Rede Virtual.
sku	ApiManagementServiceSkuProperties		Propriedades de SKU do serviço Gerenciamento de API.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuração de rede virtual para o local.
zones	string[]		Uma lista de zonas de disponibilidade que indica de onde o recurso precisa vir.

ApiManagementServiceApplyNetworkConfigurationParameters

Parâmetro fornecido para a operação de configuração Aplicar Rede.

Nome	Tipo	Description
location	string	Local do serviço de Gerenciamento de API a ser atualizado para um serviço de várias regiões. Para um serviço implantado em uma única região, esse parâmetro não é necessário.

ApiManagementServiceIdentity

Propriedades de identidade do recurso de serviço de Gerenciamento de API.

Nome	Tipo	Description
principalId	string	A ID da entidade de segurança da identidade.
tenantId	string	A ID do locatário do cliente da identidade.
type	ApimIdentityType	O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço.
userAssignedIdentities	<string, UserIdentityProperties>	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Um único recurso de serviço Gerenciamento de API em Listar ou Obter resposta.

Nome	Tipo	Valor padrão	Description
etag	string		ETag do recurso.
id	string		ID do recurso.
identity	ApiManagementServiceIdentity		Identidade de serviço gerenciada do serviço de Gerenciamento de API.
location	string		Local do recurso.
name	string		Nome do recurso.
properties.additionalLocations	AdditionalLocation[]		Locais de datacenter adicionais do serviço Gerenciamento de API.
properties.apiVersionConstraint	ApiVersionConstraint		Restrição de versão do Control Plane Apis para o serviço Gerenciamento de API.
properties.certificates	CertificateConfiguration[]		Lista de certificados que precisam ser instalados no serviço Gerenciamento de API. O máximo de certificados com suporte que podem ser instalados é 10.
properties.createdAtUtc	string		Data utc de criação do serviço Gerenciamento de API. A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pelo padrão ISO 8601.
properties.customProperties	object		Propriedades personalizadas do serviço Gerenciamento de API. A configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` desabilitará a TLS_RSA_WITH_3DES_EDE_CBC_SHA de criptografia para todos os TLS(1.0, 1.1 e 1.2). A configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` pode ser usada para desabilitar apenas o TLS 1.1. A configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` pode ser usada para desabilitar o TLS 1.0 em um serviço Gerenciamento de API. A configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` pode ser usada para desabilitar apenas o TLS 1.1 para comunicações com back-ends. A configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` pode ser usada para desabilitar o TLS 1.0 para comunicações com back-ends. A configuração `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` pode ser usada para habilitar o protocolo HTTP2 em um serviço Gerenciamento de API. Não especificar nenhuma dessas propriedades na operação PATCH redefinirá os valores das propriedades omitidas para seus padrões. Para todas as configurações, exceto Http2, o valor padrão será `True` se o serviço tiver sido criado em ou antes de 1º de abril de 2018 e `False` de outra forma. O valor padrão da configuração http2 é `False`. Você pode desabilitar qualquer uma das seguintes codificações usando as configurações `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 exemplo, `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256`:`false`. O valor padrão é `true` para eles. Observação: as seguintes criptografias não podem ser desabilitadas, pois são exigidas por componentes internos da 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.developerPortalUrl	string		URL do ponto de extremidade do Portal do DEveloper do serviço Gerenciamento de API.
properties.disableGateway	boolean	False	Propriedade válida somente para um serviço de Gerenciamento de API implantado em vários locais. Isso pode ser usado para desabilitar o gateway em master região.
properties.enableClientCertificate	boolean	False	Propriedade destinada apenas a ser usada para o Serviço de SKU de Consumo. Isso impõe que um certificado do cliente seja apresentado em cada solicitação para o gateway. Isso também permite a capacidade de autenticar o certificado na política no gateway.
properties.gatewayRegionalUrl	string		URL do gateway do serviço de Gerenciamento de API na Região Padrão.
properties.gatewayUrl	string		URL do gateway do serviço Gerenciamento de API.
properties.hostnameConfigurations	HostnameConfiguration[]		Configuração de nome de host personalizado do serviço Gerenciamento de API.
properties.managementApiUrl	string		URL do ponto de extremidade da API de gerenciamento do serviço Gerenciamento de API.
properties.natGatewayState	NatGatewayState	Disabled	A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API.
properties.notificationSenderEmail	string		Email endereço do qual a notificação será enviada.
properties.outboundPublicIPAddresses	string[]		Prefixos de endereço IPV4 públicos de saída associados ao serviço implantado do Gateway da NAT. Disponível apenas para SKU Premium na plataforma stv2.
properties.platformVersion	PlatformVersion		Versão da Plataforma de Computação executando o serviço neste local.
properties.portalUrl	string		Url do ponto de extremidade do portal do editor do serviço Gerenciamento de API.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista de conexões de ponto de extremidade privado desse serviço.
properties.privateIPAddresses	string[]		Endereços IP com balanceamento de carga estático privado do serviço Gerenciamento de API na região Primária, que é implantado em uma Rede Virtual Interna. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
properties.provisioningState	string		O estado de provisionamento atual do serviço de Gerenciamento de API que pode ser um dos seguintes: Criado/Ativando/Bem-sucedido/Atualizando/Com Falha/Parado/Encerrando/Terminando Com Falha/Excluído.
properties.publicIPAddresses	string[]		Endereços IP de balanceamento de carga estáticos públicos do serviço Gerenciamento de API na região Primária. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
properties.publicIpAddressId	string		Endereço IP baseado em IP de SKU padrão público V4 a ser associado a Rede Virtual serviço implantado na região. Compatível apenas com o SKU Premium e desenvolvedor que está sendo implantado no Rede Virtual.
properties.publicNetworkAccess	PublicNetworkAccess		Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço Gerenciamento de API. O valor é opcional, mas, se passado, deve ser "Habilitado" ou "Desabilitado". Se 'Desabilitado', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled'
properties.publisherEmail	string		Email do publicador.
properties.publisherName	string		Nome do publicador.
properties.restore	boolean	False	Desmarque o Serviço de Gerenciamento de API se ele tiver sido excluído anteriormente. Se esse sinalizador for especificado e definido como True, todas as outras propriedades serão ignoradas.
properties.scmUrl	string		URL do ponto de extremidade SCM do serviço Gerenciamento de API.
properties.targetProvisioningState	string		O estado de provisionamento do serviço Gerenciamento de API, que é direcionado pela operação de execução prolongada iniciada no serviço.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuração de rede virtual do serviço Gerenciamento de API.
properties.virtualNetworkType	VirtualNetworkType	None	O tipo de VPN no qual Gerenciamento de API serviço precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço de Gerenciamento de API não faz parte de nenhum Rede Virtual, Externo significa que a implantação do Gerenciamento de API está configurada dentro de um Rede Virtual ter um ponto de extremidade voltado para a Internet e o interno significa que Gerenciamento de API a implantação é configurada dentro de um Rede Virtual ter apenas um ponto de extremidade voltado para intranet.
sku	ApiManagementServiceSkuProperties		Propriedades de SKU do serviço Gerenciamento de API.
systemData	systemData		Metadados relativos à criação e à última modificação do recurso.
tags	object		Marcas de recurso.
type	string		O tipo de recurso para Gerenciamento de API recurso é definido como Microsoft.ApiManagement.
zones	string[]		Uma lista de zonas de disponibilidade que indica de onde o recurso precisa vir.

ApiManagementServiceSkuProperties

Gerenciamento de API propriedades de SKU do recurso de serviço.

Nome	Tipo	Description
capacity	integer	Capacidade do SKU (número de unidades implantadas do SKU). Para a capacidade de SKU de Consumo, deve ser especificado como 0.
name	SkuType	Nome do Sku.

ApimIdentityType

O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço.

Nome	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

Restrição de versão das Apis do Painel de Controle para o serviço Gerenciamento de API.

Nome	Tipo	Description
minApiVersion	string	Limite as chamadas à API do painel de controle para Gerenciamento de API serviço com versão igual ou mais recente que esse valor.

ArmIdWrapper

Um wrapper para uma ID de recurso do ARM

Nome	Tipo	Description
id	string

CertificateConfiguration

Configuração de certificado que consiste em intermediários não confiáveis e certificados raiz.

Nome	Tipo	Description
certificate	CertificateInformation	Informações de certificado.
certificatePassword	string	Senha do certificado.
encodedCertificate	string	Certificado codificado em Base64.
storeName	enum: CertificateAuthority Root	O local do repositório de certificados System.Security.Cryptography.x509certificates.StoreName. Somente Root e CertificateAuthority são locais válidos.

CertificateInformation

Informações de certificado SSL.

Nome	Tipo	Description
expiry	string	Data de validade do certificado. A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pelo padrão ISO 8601.
subject	string	Assunto do certificado.
thumbprint	string	Impressão digital do certificado.

CertificateSource

Origem do certificado.

Nome	Tipo	Description
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Status do Certificado.

Nome	Tipo	Description
Completed	string
Failed	string
InProgress	string

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

Contrato de Campo de Erro.

Nome	Tipo	Description
code	string	Código de erro no nível da propriedade.
message	string	Representação legível por humanos do erro no nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message	string	Representação legível ao olho humano do erro.

HostnameConfiguration

Configuração de nome de host personalizado.

Nome	Tipo	Valor padrão	Description
certificate	CertificateInformation		Informações de certificado.
certificatePassword	string		Senha do certificado.
certificateSource	CertificateSource		Origem do certificado.
certificateStatus	CertificateStatus		Status do Certificado.
defaultSslBinding	boolean	False	Especifique true para configurar o certificado associado a esse Nome de Host como o Certificado SSL Padrão. Se um cliente não enviar o cabeçalho SNI, esse será o certificado que será desafiado. A propriedade será útil se um serviço tiver vários nomes de host personalizados habilitados e precisar decidir sobre o certificado ssl padrão. A configuração aplicada somente ao tipo de nome do host do gateway.
encodedCertificate	string		Certificado codificado em Base64.
hostName	string		Nome do host a ser configurado no serviço de Gerenciamento de API.
identityClientId	string		System ou User Assigned Managed identity clientId, conforme gerado por Azure AD, que tem acesso GET ao keyVault que contém o certificado SSL.
keyVaultId	string		Url para o Segredo KeyVault que contém o Certificado SsL. Se a URL absoluta que contém a versão for fornecida, a atualização automática do certificado SSL não funcionará. Isso exige que o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo application/x-pkcs12
negotiateClientCertificate	boolean	False	Especifique true para sempre negociar o certificado do cliente no nome do host. O valor padrão é false.
type	HostnameType		Tipo de nome do host.

HostnameType

Tipo de nome do host.

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

NatGatewayState

A propriedade pode ser usada para habilitar o Gateway da NAT para esse serviço de Gerenciamento de API.

Nome	Tipo	Description
Disabled	string	O Gateway da Nat está desabilitado para o serviço.
Enabled	string	O Gateway da Nat está habilitado para o serviço.

PlatformVersion

Versão da Plataforma de Computação executando o serviço.

Nome	Tipo	Description
mtv1	string	Plataforma que executa o serviço na plataforma multilocatário V1.
stv1	string	Plataforma que executa o serviço na plataforma de Locatário Único V1.
stv2	string	Plataforma que executa o serviço na plataforma de Locatário Único V2.
undetermined	string	A versão da plataforma não pode ser determinada, pois a plataforma de computação não está implantada.

PrivateEndpointServiceConnectionStatus

A conexão do ponto de extremidade privado status.

Nome	Tipo	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

Nome	Tipo	Description
actionsRequired	string	Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.
description	string	O motivo da aprovação/rejeição da conexão.
status	PrivateEndpointServiceConnectionStatus	Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

PublicNetworkAccess

Se o acesso ao ponto de extremidade público é permitido ou não para esse serviço de Gerenciamento de API. O valor é opcional, mas, se passado, deve ser 'Habilitado' ou 'Desabilitado'. Se 'Disabled', os pontos de extremidade privados serão o método de acesso exclusivo. O valor padrão é 'Enabled'

Nome	Tipo	Description
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

Recurso conexão de ponto de extremidade privado remoto.

Nome	Tipo	Description
id	string	ID do recurso de conexão do ponto de extremidade privado
name	string	Nome da conexão do ponto de extremidade privado
properties.groupIds	string[]	Todas as IDs do grupo.
properties.privateEndpoint	ArmIdWrapper	O recurso do ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
properties.provisioningState	string	O estado de provisionamento do recurso de conexão de ponto de extremidade privado.
type	string	Tipo de recurso de conexão de ponto de extremidade privado

SkuType

Nome da SKU.

Nome	Tipo	Description
Basic	string	SKU básica do Gerenciamento de API.
Consumption	string	SKU de consumo do Gerenciamento de API.
Developer	string	SKU do desenvolvedor do Gerenciamento de API.
Isolated	string	SKU isolada do Gerenciamento de API.
Premium	string	SKU Premium do Gerenciamento de API.
Standard	string	SKU Padrão do Gerenciamento de API.

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserIdentityProperties

Nome	Tipo	Description
clientId	string	A ID do cliente da identidade atribuída pelo usuário.
principalId	string	A ID principal da identidade atribuída pelo usuário.

VirtualNetworkConfiguration

Configuração de uma rede virtual na qual Gerenciamento de API serviço é implantado.

Nome	Tipo	Description
subnetResourceId	string	A ID de recurso completa de uma sub-rede em uma rede virtual na qual implantar o serviço Gerenciamento de API.
subnetname	string	O nome da sub-rede.
vnetid	string	A ID da rede virtual. Normalmente, esse é um GUID. Espere um GUID nulo por padrão.

VirtualNetworkType

O tipo de VPN no qual Gerenciamento de API serviço precisa ser configurado. Nenhum (Valor Padrão) significa que o serviço Gerenciamento de API não faz parte de nenhuma Rede Virtual, Externo significa que a implantação do Gerenciamento de API está configurada dentro de um Rede Virtual ter um ponto de extremidade voltado para a Internet e interno significa que Gerenciamento de API A implantação é configurada dentro de uma Rede Virtual ter apenas um ponto de extremidade voltado para a intranet.

Nome	Tipo	Description
External	string	O serviço faz parte do Rede Virtual e pode ser acessado pela Internet.
Internal	string	O serviço faz parte do Rede Virtual e só pode ser acessado de dentro da rede virtual.
None	string	O serviço não faz parte de nenhuma Rede Virtual.

Api Management Service - Apply Network Configuration Updates

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

ApiManagementApplyNetworkConfigurationUpdates

Sample Request

Sample Response

Definições

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 adicionais