Quickstart: Uw API-centrum maken - Azure CLI

Artikel
07/04/2024

Maak uw API-centrum om een inventaris van de API's van uw organisatie te starten. Met Azure API Center kunt u API's bijhouden op een centrale locatie voor detectie, hergebruik en governance.

Nadat u uw API-centrum hebt gemaakt, volgt u de stappen in de zelfstudies om aangepaste metagegevens, API's, versies, definities en andere informatie toe te voegen.

Vereisten

Als u geen Azure-abonnement hebt, maakt u een gratis Azure-account voordat u begint.
Ten minste een roltoewijzing inzender of gelijkwaardige machtigingen in het Azure-abonnement.

Voor Azure CLI:
- Gebruik de Bash-omgeving in Azure Cloud Shell. Zie quickstart voor Bash in Azure Cloud Shell voor meer informatie.
- Installeer de Azure CLI, indien gewenst, om CLI-referentieopdrachten uit te voeren. Als u in Windows of macOS werkt, kunt u Azure CLI uitvoeren in een Docker-container. Zie De Azure CLI uitvoeren in een Docker-container voor meer informatie.
  - Als u een lokale installatie gebruikt, meldt u zich aan bij Azure CLI met behulp van de opdracht az login. Volg de stappen die worden weergegeven in de terminal, om het verificatieproces te voltooien. Raadpleeg Aanmelden bij Azure CLI voor aanvullende aanmeldingsopties.
  - Installeer de Azure CLI-extensie bij het eerste gebruik, wanneer u hierom wordt gevraagd. Raadpleeg Extensies gebruiken met Azure CLI voor meer informatie over extensies.
  - Voer az version uit om de geïnstalleerde versie en afhankelijke bibliotheken te vinden. Voer az upgrade uit om te upgraden naar de nieuwste versie.
Notitie

az apic voor opdrachten is de apic-extension Azure CLI-extensie vereist. Als u geen opdrachten hebt gebruikt az apic , kan de extensie dynamisch worden geïnstalleerd wanneer u uw eerste az apic opdracht uitvoert of kunt u de extensie handmatig installeren. Meer informatie over Azure CLI-extensies.

Zie de releaseopmerkingen voor de meest recente wijzigingen en updates in de apic-extension.

De Microsoft.ApiCenter-provider registreren

Als u dat nog niet hebt gedaan, moet u de Resourceprovider Microsoft.ApiCenter registreren in uw abonnement. U hoeft de resourceprovider slechts één keer te registreren.

Voer de volgende az provider register opdracht uit om de resourceprovider in uw abonnement te registreren met behulp van de Azure CLI:

az provider register --namespace Microsoft.ApiCenter

U kunt de registratiestatus controleren door de volgende az provider show opdracht uit te voeren:

az provider show --namespace Microsoft.ApiCenter

Een brongroep maken

Azure API Center-exemplaren, zoals alle Azure-resources, moeten worden geïmplementeerd in een resourcegroep. Met resourcegroepen kunt u gerelateerde Azure-resources organiseren en beheren.

Maak een resourcegroep met behulp van de az group create opdracht. In het volgende voorbeeld wordt een groep met de naam MyGroup gemaakt op de locatie VS - oost:

az group create --name MyGroup --location eastus

Een API-centrum maken

Maak een API-centrum met behulp van de az apic create opdracht.

In het volgende voorbeeld wordt een API-centrum met de naam MyApiCenter gemaakt in de MyGroup-resourcegroep . In dit voorbeeld wordt het API-centrum geïmplementeerd op de locatie Europa - west. Vervang de naam van het API-centrum door uw keuze en voer een van de beschikbare locaties in voor uw API-centrum.

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

De uitvoer van de opdracht ziet er ongeveer als volgt uit. Standaard wordt het API-centrum gemaakt in het gratis abonnement.

{
  "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"
}

Na de implementatie is uw API-centrum klaar voor gebruik.

Volgende stappen

U kunt nu beginnen met het toevoegen van informatie aan de inventaris in uw API-centrum. Als u uw API's en andere informatie wilt ordenen, begint u met het definiëren van aangepaste metagegevens in uw API-centrum.

Aangepaste metagegevens definiëren

Delen via