Plugin da Versão de Produção do ApiCenter

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.

Exemplo de configuração

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "ApiCenterProductionVersionPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "apiCenterProductionVersionPlugin"
    }
  ],
  "apiCenterProductionVersionPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/apicenterproductionversionplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default"
  }
}

Propriedades de configuração

Propriedade	Descrição	Inadimplência
resourceGroupName	Nome do grupo de recursos onde 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 onde a instância do Centro de API do Azure está localizada.	Nenhum
workspaceName	Nome do espaço de trabalho do Centro de API do Azure a ser usado.	default

Opções de linha de comando

Nenhum

Comentários

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 que não sejam de 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):

• Meio Ambiente
• Identidade da carga de trabalho
• Identidade gerenciada
• Visual Studio
• Código do Visual Studio
• CLI do Azure (Interface de Linha de Comando da Azure)
• Azure PowerShell
• Azure Developer CLI

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 desativará. Entre no Azure usando qualquer uma dessas ferramentas e reinicie o Dev Proxy 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, insira o nome do valor com um @, por exemplo:

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "ApiCenterProductionVersionPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "apiCenterProductionVersionPlugin"
    }
  ],
  "apiCenterProductionVersionPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.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 subscriptionId, resourceGroupName, serviceNamee workspaceName propriedades para os valores das variáveis de ambiente AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEe AZURE_APIC_WORKSPACE_NAME, respectivamente.

Se uma variável de ambiente referenciada na configuração não estiver definida ou vazia, o plugin mostra um erro, por exemplo Environment variable AZURE_SUBSCRIPTION_ID referenced by subscriptionId isn't set., e o Dev Proxy desativa-o. Define a variável de ambiente e reinicia o Dev Proxy para usar o ApiCenterProductionVersionPlugin plugin.

Próximo passo

Como verificar se meu aplicativo está usando APIs de nível de produção