ApiCenterOnboardingPlugin

Artigo
05/25/2024

Verifica se as APIs utilizadas numa aplicação estão registadas na instância do Centro de API do Azure especificada.

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

{
  "name": "ApiCenterOnboardingPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "apiCenterOnboardingPlugin"
}

Exemplo de configuração

{
  "apiCenterOnboardingPlugin": {
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default",
    "createApicEntryForNewApis": true
  }
}

Propriedades de configuração

Propriedade	Descrição	Predefinição
`createApicEntryForNewApis`	Defina como fazer `true` com que o Proxy deV crie novas entradas de API para as APIs que detetou e que ainda não estão registadas no Centro de API. Quando definido como `false` Proxy de Programador, lista apenas as APIs não registadas na linha de comandos.	`true`
`resourceGroupName`	Nome do grupo de recursos onde está localizado o Centro de API do Azure.	Nenhuma
`serviceName`	Nome da instância do Centro de API do Azure que o Proxy de Programador deve utilizar para verificar se as APIs utilizadas na aplicação estão registadas.	Nenhuma
`subscriptionId`	ID da subscrição do Azure onde está localizada a instância do Centro de API do Azure.	Nenhuma
`workspace`	Nome da área de trabalho do Centro de API do Azure a utilizar.	`default`

Opções da linha de comandos

Nenhum

Observações

O ApiCenterOnboardingPlugin plug-in verifica se as APIs utilizadas numa aplicação estão registadas na instância do Centro de API do Azure especificada. Se as APIs não estiverem registadas, o plug-in pode criar novas entradas de API na instância do Centro de API.

Para ligar ao Centro de API do Azure, o plug-in utiliza as credenciais do Azure (por esta ordem):

Ambiente
Identidade da Carga de Trabalho
Identidade Gerida
Visual Studio
Visual Studio Code
CLI do Azure
Azure PowerShell
Azure Developer CLI

Se o plug-in não conseguir obter um token de acesso para aceder ao Azure, será apresentado um erro e o Proxy dev desativa-o. Inicie sessão no Azure com qualquer uma destas ferramentas e reinicie o Proxy de Programador para utilizar o ApiCenterOnboardingPlugin plug-in.

Se utilizar o Proxy Dev em pipelines de CI/CD, pode transmitir valores para as subscriptionIdpropriedades , resourceGroupName, serviceNamee workspaceName como variáveis de ambiente. Para utilizar variáveis de ambiente, prepare o nome do valor com um @, por exemplo:

{
  "apiCenterOnboardingPlugin": {
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME",
    "createApicEntryForNewApis": true
  }
}

Neste exemplo, o ApiCenterOnboardingPlugin plug-in define subscriptionIdas propriedades , resourceGroupName, serviceNamee para workspaceName os valores das AZURE_SUBSCRIPTION_IDvariáveis de ambiente , AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAMEe AZURE_APIC_WORKSPACE_NAME , respetivamente.

Partilhar via