Avvio rapido: Creare il centro API - Interfaccia della riga di comando di Azure

Articolo
07/12/2024

Crea il centro API per avviare un inventario delle API dell'organizzazione. Il Centro API di Azure abilita le API di rilevamento in una posizione centralizzata per l'individuazione, il riutilizzo e la governance.

Dopo aver creato il centro API, segui la procedura descritta nelle esercitazioni per aggiungere metadati personalizzati, API, versioni, definizioni e altre informazioni.

Prerequisiti

Se non hai un abbonamento di Azure, crea un account Azure gratuito prima di iniziare.
Almeno un'assegnazione di ruolo Collaboratore o autorizzazioni equivalenti nell’abbonamento di Azure.

Per l'interfaccia della riga di comando di Azure:
- Usare l'ambiente Bash in Azure Cloud Shell. Per altre informazioni, vedere Avvio rapido su Bash in Azure Cloud Shell.
- Se si preferisce eseguire i comandi di riferimento dell'interfaccia della riga di comando in locale, installare l'interfaccia della riga di comando di Azure. Per l'esecuzione in Windows o macOS, è consigliabile eseguire l'interfaccia della riga di comando di Azure in un contenitore Docker. Per altre informazioni, vedere Come eseguire l'interfaccia della riga di comando di Azure in un contenitore Docker.
  - Se si usa un'installazione locale, accedere all'interfaccia della riga di comando di Azure con il comando az login. Per completare il processo di autenticazione, seguire la procedura visualizzata nel terminale. Per altre opzioni di accesso, vedere Accedere tramite l'interfaccia della riga di comando di Azure.
  - Quando richiesto, al primo utilizzo installare l'estensione dell'interfaccia della riga di comando di Azure. Per altre informazioni sulle estensioni, vedere Usare le estensioni con l'interfaccia della riga di comando di Azure.
  - Eseguire az version per trovare la versione e le librerie dipendenti installate. Per eseguire l'aggiornamento alla versione più recente, eseguire az upgrade.
Nota

I comandi az apic richiedono l'estensione dell'interfaccia della riga di comando di Azure apic-extension. Se non sono stati usati comandi az apic, l'estensione può essere installata in modo dinamico quando si esegue il primo comando az apic oppure è possibile installarla manualmente. Altre informazioni sulle estensioni dell'interfaccia della riga di comando di Azure.

Vedere le note sulla versione per le modifiche e gli aggiornamenti più recenti in apic-extension.

Registra il provider Microsoft.ApiCenter

Se non è stato già fatto, registrare il provider di risorse Microsoft.ApiCenter nella sottoscrizione. Solo devi registrare il provider di risorse una sola volta.

Per registrare il provider di risorse nella sottoscrizione usando l'interfaccia della riga di comando di Azure, eseguire il comando seguente az provider register:

az provider register --namespace Microsoft.ApiCenter

È possibile controllare lo stato della registrazione eseguendo il comando seguente az provider show:

az provider show --namespace Microsoft.ApiCenter

Creare un gruppo di risorse

Le Istanze di Centro API di Azure, analogamente a tutte le risorse di Azure, devono essere distribuite in un gruppo di risorse. I gruppi di risorse consentono di organizzare e gestire le risorse di Azure correlate.

Creare un gruppo di risorse usando il comando az group create. L'esempio seguente crea un gruppo denominato MyGroup nella località Stati Uniti orientali:

az group create --name MyGroup --location eastus

Creare un centro API

Creare un centro API usando il comando az apic create.

L'esempio seguente crea un centro API denominato MyApiCenter nel gruppo di risorse MyGroup . In questo esempio il centro API viene distribuito nella località Europa occidentale. Sostituire un nome del centro API preferito e immettere una delle posizioni disponibili per il centro API.

az apic create --name MyApiCenter --resource-group MyGroup --location westeurope

L'output del comando è simile al seguente. Per impostazione predefinita, il centro API viene creato nel piano gratuito.

{
  "dataApiHostname": "myapicenter.data.westeurope.azure-apicenter.ms",
  "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/mygroup/providers/Microsoft.ApiCenter/services/myapicenter",
  "location": "westeurope",
  "name": "myapicenter",
  "resourceGroup": "mygroup",
  "sku": {
    "name": "Free"
  },
  "systemData": {
    "createdAt": "2024-06-22T21:40:35.2541624Z",
    "lastModifiedAt": "2024-06-22T21:40:35.2541624Z"
  },
  "tags": {},
  "type": "Microsoft.ApiCenter/services"
}

Dopo la distribuzione, il centro API è pronto per l'uso.

Passaggi successivi

Ora puoi iniziare ad aggiungere informazioni all'inventario nel centro API. Per organizzare le API e altre informazioni, inizia definendo metadati personalizzati nel centro API.

Definire metadati personalizzati

Condividi tramite