Snabbstart: Skapa ditt API-center – Azure CLI

Artikel
07/04/2024

Skapa api-centret för att starta en inventering av organisationens API:er. Med Azure API Center kan du spåra API:er på en central plats för identifiering, återanvändning och styrning.

När du har skapat api-centret följer du stegen i självstudierna för att lägga till anpassade metadata, API:er, versioner, definitioner och annan information.

Förutsättningar

Om du inte har en Azure-prenumeration skapar du ett kostnadsfritt Azure-konto innan du börjar.
Minst en rolltilldelning för deltagare eller motsvarande behörigheter i Azure-prenumerationen.

För Azure CLI:
- Använd Bash-miljön i Azure Cloud Shell. Mer information finns i Snabbstart för Bash i Azure Cloud Shell.
- Om du föredrar att köra CLI-referenskommandon lokalt installerar du Azure CLI. Om du kör i Windows eller macOS kan du köra Azure CLI i en Docker-container. Mer information finns i Så här kör du Azure CLI i en Docker-container.
  - Om du använder en lokal installation loggar du in på Azure CLI med hjälp av kommandot az login. Slutför autentiseringsprocessen genom att följa stegen som visas i terminalen. Andra inloggningsalternativ finns i Logga in med Azure CLI.
  - När du uppmanas att installera Azure CLI-tillägget vid första användningen. Mer information om tillägg finns i Använda tillägg med Azure CLI.
  - Kör az version om du vill hitta versionen och de beroende bibliotek som är installerade. Om du vill uppgradera till den senaste versionen kör du az upgrade.
Kommentar

az apic kommandon kräver Azure CLI-tillägget apic-extension . Om du inte har använt az apic kommandon kan tillägget installeras dynamiskt när du kör ditt första az apic kommando, eller så kan du installera tillägget manuellt. Läs mer om Azure CLI-tillägg.

Se viktig information för de senaste ändringarna och uppdateringarna apic-extensioni .

Registrera Microsoft.ApiCenter-providern

Om du inte redan har gjort det måste du registrera resursprovidern Microsoft.ApiCenter i din prenumeration. Du behöver bara registrera resursprovidern en gång.

Om du vill registrera resursprovidern i din prenumeration med hjälp av Azure CLI kör du följande az provider register kommando:

az provider register --namespace Microsoft.ApiCenter

Du kan kontrollera registreringsstatusen genom att köra följande az provider show kommando:

az provider show --namespace Microsoft.ApiCenter

Skapa en resursgrupp

Azure API Center-instanser, precis som alla Azure-resurser, måste distribueras till en resursgrupp. Med resursgrupper kan du organisera och hantera relaterade Azure-resurser.

Skapa en resursgrupp med kommandot az group create . I följande exempel skapas en grupp med namnet MyGroup på platsen USA , östra:

az group create --name MyGroup --location eastus

Skapa ett API-center

Skapa ett API-center med kommandot az apic create .

I följande exempel skapas ett API-center med namnet MyApiCenter i resursgruppen MyGroup . I det här exemplet distribueras API-centret på platsen Europa , västra. Ersätt ett API Center-namn och ange en av de tillgängliga platserna för ditt API-center.

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

Utdata från kommandot ser ut ungefär så här. Som standard skapas API-centret i den kostnadsfria planen.

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

Efter distributionen är api-centret redo att användas!

Nästa steg

Nu kan du börja lägga till information i inventeringen i API-centret. Börja med att definiera anpassade metadata i API-centret för att hjälpa dig att organisera dina API:er och annan information.

Definiera anpassade metadata

Dela via