Краткое руководство. Создание центра API в Azure CLI

Статья
07/04/2024

Создайте центр API для запуска инвентаризации API вашей организации. Центр API Azure позволяет отслеживать API в централизованном расположении для обнаружения, повторного использования и управления.

После создания центра API выполните действия, описанные в руководствах, чтобы добавить пользовательские метаданные, API, версии, определения и другие сведения.

Необходимые компоненты

Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.
По крайней мере назначение роли участника или эквивалентные разрешения в подписке Azure.

При использовании Azure CLI выполните следующее:
- Используйте среду Bash в Azure Cloud Shell. Дополнительные сведения см . в кратком руководстве по Bash в Azure Cloud Shell.
- Если вы предпочитаете выполнять справочные команды CLI локально, установите Azure CLI. Если вы работаете в Windows или macOS, Azure CLI можно запустить в контейнере Docker. Дополнительные сведения см. в статье Как запустить Azure CLI в контейнере Docker.
  - Если вы используете локальную установку, выполните вход в Azure CLI с помощью команды az login. Чтобы выполнить аутентификацию, следуйте инструкциям в окне терминала. Сведения о других возможностях, доступных при входе, см. в статье Вход с помощью Azure CLI.
  - Установите расширение Azure CLI при первом использовании, когда появится соответствующий запрос. Дополнительные сведения о расширениях см. в статье Использование расширений с Azure CLI.
  - Выполните команду az version, чтобы узнать установленную версию и зависимые библиотеки. Чтобы обновиться до последней версии, выполните команду az upgrade.
Примечание.

az apic для команд требуется apic-extension расширение Azure CLI. Если вы не использовали az apic команды, расширение можно установить динамически при выполнении первой az apic команды или установить расширение вручную. Дополнительные сведения о расширениях Azure CLI.

Дополнительные сведения о последних изменениях и обновлениях см. в заметках о выпускеapic-extension. Для некоторых функций может потребоваться предварительная версия или определенная версия расширения.

Регистрация поставщика Microsoft.ApiCenter

Если вы еще не сделали этого, необходимо зарегистрировать поставщик ресурсов Microsoft.ApiCenter в подписке. Необходимо зарегистрировать поставщика ресурсов только один раз.

Чтобы зарегистрировать поставщика ресурсов в подписке с помощью Azure CLI, выполните следующую az provider register команду:

az provider register --namespace Microsoft.ApiCenter

Чтобы проверить состояние регистрации, выполните следующую az provider show команду:

az provider show --namespace Microsoft.ApiCenter

Создание или изменение группы ресурсов

Экземпляры Центра API Azure, как и все ресурсы Azure, должны быть развернуты в группе ресурсов. Группы ресурсов позволяют организовать соответствующие ресурсы Azure и управлять ими.

Создайте группу ресурсов с помощью az group create команды. В следующем примере создается группа с именем MyGroup в расположении "Восточная часть США ".

az group create --name MyGroup --location eastus

Создание центра API

Создайте центр API с помощью az apic create команды.

В следующем примере создается центр API MyApiCenter в группе ресурсов MyGroup . В этом примере центр API развертывается в расположении Западной Европы . Замените выбранное вами имя центра API и введите одно из доступных расположений для центра API.

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

Выходные данные команды выглядят следующим образом. По умолчанию центр API создается в бесплатном плане.

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

После развертывания центр API готов к использованию!

Следующие шаги

Теперь вы можете приступить к добавлению сведений в инвентаризацию в центре API. Чтобы упорядочить API и другие сведения, начните с определения пользовательских метаданных в центре API.

Определение пользовательских метаданных

Поделиться через