Api Management Service - Apply Network Configuration Updates

Referência

Serviço:: API Management

Versão da API:: 2021-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=2021-08-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string	O nome do serviço Gestão de API. Padrão Regex: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Corpo do Pedido

Name	Tipo	Description
location	string	Localização do serviço de Gestão de API a atualizar para um serviço de várias regiões. Para um serviço implementado numa única região, este parâmetro não é necessário.

Respostas

Name	Tipo	Description
200 OK	ApiManagementServiceResource	As atualizações de configuração de rede foram aplicadas com êxito no serviço de Gestão de API.
202 Accepted		Aceite: o cabeçalho de localização contém o URL onde o estado da operação de execução prolongada pode ser verificado.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementApplyNetworkConfigurationUpdates

Pedido de amostra

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

{
  "location": "west us"
}

import com.azure.core.util.Context;
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/2021-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"),
                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/2021-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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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.7921566Z"); 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/2021-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

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json
// this example is just showing the usage of "ApiManagementService_ApplyNetworkConfigurationUpdates" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation
ApiManagementServiceApplyNetworkConfigurationContent content = new ApiManagementServiceApplyNetworkConfigurationContent()
{
    Location = new AzureLocation("west us"),
};
ArmOperation<ApiManagementServiceResource> lro = await apiManagementService.ApplyNetworkConfigurationUpdatesAsync(WaitUntil.Completed, content: content);
ApiManagementServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta da amostra

Código de estado:: 202

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

Código de estado:: 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

Name	Description
AdditionalLocation	Descrição de uma localização de recursos Gestão de API adicional.
ApiManagementServiceApplyNetworkConfigurationParameters	Parâmetro fornecido para a operação de configuração Aplicar Rede.
ApiManagementServiceIdentity	Propriedades de identidade do recurso do serviço de Gestão de API.
ApiManagementServiceResource	Um único recurso de serviço Gestão de API em Listar ou Obter resposta.
ApiManagementServiceSkuProperties	Gestão de API propriedades do SKU do recurso de serviço.
ApimIdentityType	O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.
ApiVersionConstraint	Restrição da versão das Apis do Plano de Controlo para o serviço Gestão de API.
ArmIdWrapper	Um wrapper para um ID de recurso do ARM
CertificateConfiguration	Configuração do certificado que consiste em intermediários e certificados de raiz não fidedignos.
CertificateInformation	Informações do certificado SSL.
CertificateSource	Origem do Certificado.
CertificateStatus	Estado do Certificado.
createdByType	O tipo de identidade que criou o recurso.
ErrorFieldContract	Contrato de Campo de Erro.
ErrorResponse	Resposta do Erro.
HostnameConfiguration	Configuração personalizada do nome de anfitrião.
HostnameType	Tipo de nome de anfitrião.
PlatformVersion	Versão da Plataforma de Computação a executar o serviço.
PrivateEndpointServiceConnectionStatus	O estado da ligação do ponto final privado.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor do serviço.
PublicNetworkAccess	Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado"
RemotePrivateEndpointConnectionWrapper	Recurso ligação de ponto final privado remoto.
SkuType	Nome do SKU.
systemData	Metadados relativos à criação e última modificação do recurso.
UserIdentityProperties
VirtualNetworkConfiguration	Configuração de uma rede virtual na qual o serviço Gestão de API é implementado.
VirtualNetworkType	O tipo de VPN na qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhuma Rede Virtual, Externo significa que a implementação Gestão de API está configurada num Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet.

AdditionalLocation

Descrição de uma localização de recursos Gestão de API adicional.

Name	Tipo	Default value	Description
disableGateway	boolean	False	Propriedade apenas válida para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway nesta localização adicional.
gatewayRegionalUrl	string		URL do gateway do serviço Gestão de API na Região.
location	string		O nome da localização da região adicional entre as regiões do Datacenter do Azure.
platformVersion	PlatformVersion		Versão da Plataforma de Computação a executar o serviço.
privateIPAddresses	string[]		Endereços IP com Balanceamento de Carga Estático Privado do serviço de Gestão de API que é implementado num Rede Virtual Interno numa localização adicional específica. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
publicIPAddresses	string[]		Endereços IP públicos com Balanceamento de Carga Estático do serviço de Gestão de API na localização adicional. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
publicIpAddressId	string		Endereço IP V4 de IP do SKU Standard Público a ser associado a Rede Virtual serviço implementado na localização. Suportada apenas para o SKU Premium que está a ser implementado no Rede Virtual.
sku	ApiManagementServiceSkuProperties		Propriedades do SKU do serviço Gestão de API.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuração de rede virtual para a localização.
zones	string[]		Uma lista de zonas de disponibilidade que indica de onde o recurso precisa de vir.

ApiManagementServiceApplyNetworkConfigurationParameters

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

Name	Tipo	Description
location	string	Localização do serviço de Gestão de API a atualizar para um serviço de várias regiões. Para um serviço implementado numa única região, este parâmetro não é necessário.

ApiManagementServiceIdentity

Propriedades de identidade do recurso do serviço de Gestão de API.

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

ApiManagementServiceResource

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

Name	Tipo	Default value	Description
etag	string		ETag do recurso.
id	string		ID do Recurso.
identity	ApiManagementServiceIdentity		Identidade de serviço gerida do serviço de Gestão de API.
location	string		Localização do recurso.
name	string		Nome do recurso.
properties.additionalLocations	AdditionalLocation[]		Localizações adicionais do datacenter do serviço Gestão de API.
properties.apiVersionConstraint	ApiVersionConstraint		Restrição da versão das Apis do Plano de Controlo para o serviço Gestão de API.
properties.certificates	CertificateConfiguration[]		Lista de Certificados que têm de ser instalados no serviço Gestão de API. O máximo de certificados suportados que podem ser instalados é 10.
properties.createdAtUtc	string		Data UTC de criação do serviço Gestão de API. A data está em conformidade com o seguinte formato: `yyyy-MM-ddTHH:mm:ssZ` conforme especificado pela norma ISO 8601.
properties.customProperties	object		Propriedades personalizadas do serviço Gestão de API. A definição `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168` irá desativar a cifra TLS_RSA_WITH_3DES_EDE_CBC_SHA para todos os TLS(1.0, 1.1 e 1.2). A definição `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11` pode ser utilizada para desativar apenas o TLS 1.1. A definição `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10` pode ser utilizada para desativar o TLS 1.0 num serviço Gestão de API. A definição `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11` pode ser utilizada para desativar apenas o TLS 1.1 para comunicações com back-ends. A definição `Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10` pode ser utilizada para desativar o TLS 1.0 para comunicações com back-ends. A definição `Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2` pode ser utilizada para ativar o protocolo HTTP2 num serviço Gestão de API. Não especificar nenhuma destas propriedades na operação PATCH irá repor os valores das propriedades omitidas para as respetivas predefinições. Para todas as definições exceto Http2, o valor predefinido é `True` se o serviço foi criado em ou antes de 1 de abril de 2018 e `False` de outra forma. O valor predefinido da definição http2 é `False`. Pode desativar qualquer uma das seguintes cifras com as definiçõ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 predefinido é `true` para eles. Nota: as cifras seguintes não podem ser desativadas, uma vez que são necessárias 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 final do Portal do DEveloper do serviço Gestão de API.
properties.disableGateway	boolean	False	Propriedade apenas válida para um serviço de Gestão de API implementado em várias localizações. Isto pode ser utilizado para desativar o gateway na região mestra.
properties.enableClientCertificate	boolean	False	A propriedade destina-se apenas a ser utilizada para o Serviço SKU de Consumo. Isto impõe a apresentação de um certificado de cliente em cada pedido ao gateway. Isto também permite autenticar o certificado na política no gateway.
properties.gatewayRegionalUrl	string		URL do gateway do serviço Gestão de API na Região Predefinida.
properties.gatewayUrl	string		URL do gateway do serviço Gestão de API.
properties.hostnameConfigurations	HostnameConfiguration[]		Configuração personalizada do nome de anfitrião do serviço Gestão de API.
properties.managementApiUrl	string		URL do ponto final da API de Gestão do serviço Gestão de API.
properties.notificationSenderEmail	string		Email endereço a partir do qual a notificação será enviada.
properties.platformVersion	PlatformVersion		Versão da Plataforma de Computação a executar o serviço nesta localização.
properties.portalUrl	string		Url de ponto final do portal do Publisher do serviço Gestão de API.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista de Ligações de Ponto Final Privado deste serviço.
properties.privateIPAddresses	string[]		Endereços IP com Balanceamento de Carga Estático Privado do serviço de Gestão de API na região Primária que é implementado numa Rede Virtual Interna. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
properties.provisioningState	string		O estado de aprovisionamento atual do serviço Gestão de API, que pode ser um dos seguintes: Criado/Ativado/Com Êxito/Atualização/Com Falhas/Parado/Terminação/Terminação Falhada/Eliminada.
properties.publicIPAddresses	string[]		Endereços IP com Balanceamento de Carga Estático Público do serviço Gestão de API na região Primária. Disponível apenas para SKU Básico, Standard, Premium e Isolado.
properties.publicIpAddressId	string		Endereço IP V4 baseado em IP do SKU Standard Público a ser associado a Rede Virtual serviço implementado na região. Suportada apenas para o Programador e o SKU Premium que está a ser implementado no Rede Virtual.
properties.publicNetworkAccess	PublicNetworkAccess		Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado"
properties.publisherEmail	string		E-mail do publicador.
properties.publisherName	string		Nome do publicador.
properties.restore	boolean	False	Anular a eliminação do Serviço de Gestão de API se tiver sido eliminado de forma recuperável anteriormente. Se este sinalizador for especificado e definido como Verdadeiro, todas as outras propriedades serão ignoradas.
properties.scmUrl	string		URL do ponto final SCM do serviço Gestão de API.
properties.targetProvisioningState	string		O estado de aprovisionamento do serviço Gestão de API, que é visado pela operação de execução prolongada iniciada no serviço.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Configuração da rede virtual do serviço Gestão de API.
properties.virtualNetworkType	VirtualNetworkType	None	O tipo de VPN na qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhuma Rede Virtual, Externo significa que a implementação Gestão de API está configurada num Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet.
sku	ApiManagementServiceSkuProperties		Propriedades do SKU do serviço Gestão de API.
systemData	systemData		Metadados relativos à criação e última modificação do recurso.
tags	object		Etiquetas de recursos.
type	string		O tipo de recurso para Gestão de API recurso está definido como Microsoft.ApiManagement.
zones	string[]		Uma lista de zonas de disponibilidade que indica de onde o recurso precisa de vir.

ApiManagementServiceSkuProperties

Gestão de API propriedades do SKU do recurso de serviço.

Name	Tipo	Description
capacity	integer	Capacidade do SKU (número de unidades implementadas do SKU). Para a capacidade de SKU de Consumo tem de ser especificada como 0.
name	SkuType	Nome do SKU.

ApimIdentityType

O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá quaisquer identidades do serviço.

Name	Tipo	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

Restrição da versão das Apis do Plano de Controlo para o serviço Gestão de API.

Name	Tipo	Description
minApiVersion	string	Limite as chamadas à API do plano de controlo para Gestão de API serviço com uma versão igual ou mais recente do que este valor.

ArmIdWrapper

Um wrapper para um ID de recurso do ARM

Name	Tipo	Description
id	string

CertificateConfiguration

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

Name	Tipo	Description
certificate	CertificateInformation	Informações do certificado.
certificatePassword	string	Palavra-passe do Certificado.
encodedCertificate	string	Certificado codificado Base64.
storeName	enum: CertificateAuthority Root	A localização do arquivo de certificados System.Security.Cryptography.x509certificates.StoreName. Apenas Root e CertificateAuthority são localizações válidas.

CertificateInformation

Informações do certificado SSL.

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

CertificateSource

Origem do Certificado.

Name	Tipo	Description
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Estado do Certificado.

Name	Tipo	Description
Completed	string
Failed	string
InProgress	string

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

Contrato de Campo de Erro.

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

ErrorResponse

Resposta do Erro.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados no pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.

HostnameConfiguration

Configuração personalizada do nome de anfitrião.

Name	Tipo	Default value	Description
certificate	CertificateInformation		Informações do certificado.
certificatePassword	string		Palavra-passe do Certificado.
certificateSource	CertificateSource		Origem do Certificado.
certificateStatus	CertificateStatus		Estado do Certificado.
defaultSslBinding	boolean	False	Especifique true para configurar o certificado associado a este Nome de Anfitrião como o Certificado SSL Predefinido. Se um cliente não enviar o cabeçalho SNI, este será o certificado que será contestado. A propriedade é útil se um serviço tiver vários nomes de anfitrião personalizados ativados e precisar de decidir sobre o certificado ssl predefinido. A definição só foi aplicada ao Tipo de Nome de Anfitrião Proxy.
encodedCertificate	string		Certificado codificado Base64.
hostName	string		Nome do anfitrião a configurar no serviço de Gestão de API.
identityClientId	string		ClientId de identidade gerida atribuída pelo sistema ou pelo utilizador, tal como gerado pelo Azure AD, que tem acesso GET ao keyVault que contém o certificado SSL.
keyVaultId	string		Url para o Segredo do KeyVault que contém o Certificado SSL. Se for fornecido um URL absoluto que contenha a versão, a atualização automática do certificado SSL não funcionará. Isto requer que o serviço de Gestão de API seja configurado com aka.ms/apimmsi. O segredo deve ser do tipo application/x-pkcs12
negotiateClientCertificate	boolean	False	Especifique true para negociar sempre o certificado de cliente no nome do anfitrião. O Valor Predefinido é falso.
type	HostnameType		Tipo de nome de anfitrião.

HostnameType

Tipo de nome de anfitrião.

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

PlatformVersion

Versão da Plataforma de Computação a executar o serviço.

Name	Tipo	Description
mtv1	string	Plataforma a executar o serviço na plataforma Multi-Inquilino V1.
stv1	string	Plataforma a executar o serviço na plataforma V1 de Inquilino Único.
stv2	string	Plataforma a executar o serviço na plataforma Inquilino Único V2.
undetermined	string	Não é possível determinar a versão da plataforma, uma vez que a plataforma de computação não está implementada.

PrivateEndpointServiceConnectionStatus

O estado da ligação do ponto final privado.

Name	Tipo	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor do serviço.

Name	Tipo	Description
actionsRequired	string	Uma mensagem a indicar se as alterações no fornecedor de serviços requerem atualizações no consumidor.
description	string	O motivo da aprovação/rejeição da ligação.
status	PrivateEndpointServiceConnectionStatus	Indica se a ligação foi Aprovada/Rejeitada/Removida pelo proprietário do serviço.

PublicNetworkAccess

Se o acesso ao ponto final público é ou não permitido para este serviço de Gestão de API. O valor é opcional, mas, se for transmitido, tem de ser "Ativado" ou "Desativado". Se "Desativado", os pontos finais privados são o método de acesso exclusivo. O valor predefinido é "Ativado"

Name	Tipo	Description
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

Recurso ligação de ponto final privado remoto.

Name	Tipo	Description
id	string	ID do recurso de ligação de Ponto Final Privado
name	string	Nome da Ligação do Ponto Final Privado
properties.groupIds	string[]	Todos os IDs do Grupo.
properties.privateEndpoint	ArmIdWrapper	O recurso do ponto final privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da ligação entre o consumidor e o fornecedor do serviço.
properties.provisioningState	string	O estado de aprovisionamento do recurso de ligação de ponto final privado.
type	string	Tipo de Recurso de Ligação de Ponto Final Privado

SkuType

Nome do SKU.

Name	Tipo	Description
Basic	string	SKU Básico da Gestão de API.
Consumption	string	SKU de Consumo da Gestão de API.
Developer	string	SKU de Programador da Gestão de API.
Isolated	string	SKU isolado da Gestão de API.
Premium	string	SKU Premium da Gestão de API.
Standard	string	SKU Standard da Gestão de API.

systemData

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

Name	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

Name	Tipo	Description
clientId	string	O ID de cliente da identidade atribuída pelo utilizador.
principalId	string	O ID principal da identidade atribuída pelo utilizador.

VirtualNetworkConfiguration

Configuração de uma rede virtual na qual o serviço Gestão de API é implementado.

Name	Tipo	Description
subnetResourceId	string	O ID de recurso completo de uma sub-rede numa rede virtual para implementar o serviço Gestão de API.
subnetname	string	O nome da sub-rede.
vnetid	string	O ID da rede virtual. Normalmente, trata-se de um GUID. Por predefinição, espera-se um GUID nulo.

VirtualNetworkType

O tipo de VPN na qual Gestão de API serviço tem de ser configurado. Nenhum (Valor Predefinido) significa que o serviço Gestão de API não faz parte de nenhuma Rede Virtual, Externo significa que a implementação Gestão de API está configurada num Rede Virtual ter um Ponto Final Com Acesso à Internet e Interno significa que Gestão de API implementação está configurada dentro de um Rede Virtual ter apenas um Ponto Final Com Acesso à Intranet.

Name	Tipo	Description
External	string	O serviço faz parte do Rede Virtual e está acessível a partir da Internet.
Internal	string	O serviço faz parte do Rede Virtual e só está acessível a partir da rede virtual.
None	string	O serviço não faz parte de nenhuma Rede Virtual.