ApiCenterOnboardingPlugin

Verifica se as APIs usadas em um aplicativo estão registradas na instância especificada do Centro de API do Azure.

Definição da instância do plug-in

{
  "name": "ApiCenterOnboardingPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "apiCenterOnboardingPlugin"
}

Exemplo de configuração

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default",
    "createApicEntryForNewApis": true
  }
}

Propriedades de configuração

Propriedade	Descrição	Inadimplência
createApicEntryForNewApis	Defina como true fazer com que o Proxy de Desenvolvimento crie novas entradas de API para as APIs detectadas e que ainda não estão registradas no Centro de API. Quando definido como false Proxy de Desenvolvimento lista apenas as APIs não registradas no prompt de comando.	true
resourceGroupName	Nome do grupo de recursos em que o Centro de API do Azure está localizado.	Nenhum
serviceName	Nome da instância do Centro de API do Azure que o Proxy de Desenvolvimento deve usar para verificar se as APIs usadas no aplicativo estão registradas.	Nenhum
subscriptionId	ID da assinatura do Azure em que a instância do Centro de API do Azure está localizada.	Nenhum
workspace	Nome do workspace do Centro de API do Azure a ser usado.	default

Opções de linha de comando

Nenhum

Observações

O plug-in ApiCenterOnboardingPlugin verifica se as APIs usadas em um aplicativo estão registradas na instância especificada do Centro de API do Azure. Se as APIs não estiverem registradas, o plug-in poderá criar novas entradas de API na instância do Centro de API.

Para se conectar ao Centro de API do Azure, o plug-in usa credenciais do Azure (nesta ordem):

• Ambiente
• Identidade da carga de trabalho
• Identidade Gerenciada
• Visual Studio
• Visual Studio Code
• Azure CLI (Interface de Linha de Comando do Azure)
• Azure PowerShell
• CLI do Desenvolvedor do Azure

Se o plug-in não conseguir obter um token de acesso para acessar o Azure, ele mostrará um erro e o Proxy de Desenvolvimento o desabilitará. Entre no Azure usando qualquer uma dessas ferramentas e reinicie o Proxy de Desenvolvimento para usar o plug-in ApiCenterOnboardingPlugin.

Se você usar o Proxy de Desenvolvimento em pipelines de CI/CD, poderá passar valores para as propriedades subscriptionId, resourceGroupName, serviceNamee workspaceName como variáveis de ambiente. Para usar variáveis de ambiente, acrescente o nome do valor com um @, por exemplo:

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME",
    "createApicEntryForNewApis": true
  }
}

Neste exemplo, o plug-in ApiCenterOnboardingPlugin define as propriedades subscriptionId, resourceGroupName, serviceNamee workspaceName para os valores das variáveis de ambiente AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEe AZURE_APIC_WORKSPACE_NAME, respectivamente.

Próxima etapa

Como encontrar APIs de sombra