ApiCenterProductionVersionPlugin

Verifica se as APIs usadas em um aplicativo são a versão de produção das APIs registradas na instância especificada do Centro de API do Azure.

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

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

Exemplo de configuração

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

Propriedades de configuração

Opções de linha de comando

Nenhum

Observações

O plug-in ApiCenterProductionVersionPlugin verifica se as APIs usadas em um aplicativo são a versão de produção das APIs registradas na instância especificada do Centro de API do Azure. Se as APIs corresponderem a versões de não produção, o plug-in mostrará um aviso.

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 ApiCenterProductionVersionPlugin.

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:

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

Neste exemplo, o plug-in ApiCenterProductionVersionPlugin 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