az apic integration create
Note
Эта ссылка является частью расширения apic-extension для Azure CLI (версия 2.57.0 или более поздней). Расширение автоматически установит первый запуск команды az apic integration create. Подробнее о расширениях.
Команды
Имя | Описание | Тип | Состояние |
---|---|---|---|
az apic integration create apim |
Добавьте Azure APIM в качестве источника API. |
Extension | Генеральная Ассамблея |
az apic integration create aws |
Добавьте Шлюз API Amazon в качестве источника API. |
Extension | Генеральная Ассамблея |
az apic integration create apim
Добавьте Azure APIM в качестве источника API.
az apic integration create apim --azure-apim
--integration-name
--resource-group
--service-name
[--import-specification {always, never, ondemand}]
[--msi-resource-id]
[--target-environment-id]
[--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
Примеры
Добавление Azure APIM в ту же группу ресурсов, что и экземпляр Центра API Azure в качестве источника API
az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim myapim
Добавление AZURE APIM в другую группу ресурсов в качестве источника API
az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim /subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/samplegroup/providers/Microsoft.ApiManagement/service/sampleapim
Обязательные параметры
Имя или идентификатор ресурса исходного экземпляра APIM.
Свойство | Значение |
---|---|
Parameter group: | AzureApiManagementSource Arguments |
Имя интеграции.
Имя группы ресурсов Центра API Azure. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя службы Центра API Azure.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Указывает, следует ли импортировать спецификацию вместе с метаданными.
Свойство | Значение |
---|---|
Parameter group: | Properties Arguments |
Default value: | always |
Допустимые значения: | always, never, ondemand |
Идентификатор ресурса управляемого удостоверения, имеющего доступ к экземпляру службы управления API.
Свойство | Значение |
---|---|
Parameter group: | AzureApiManagementSource Arguments |
Идентификатор ресурса целевой среды.
Свойство | Значение |
---|---|
Parameter group: | Properties Arguments |
Целевой этап жизненного цикла.
Свойство | Значение |
---|---|
Parameter group: | Properties Arguments |
Допустимые значения: | deprecated, design, development, preview, production, retired, testing |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Свойство | Значение |
---|---|
Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Свойство | Значение |
---|---|
Default value: | False |
Формат вывода.
Свойство | Значение |
---|---|
Default value: | json |
Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
Свойство | Значение |
---|---|
Default value: | False |
az apic integration create aws
Добавьте Шлюз API Amazon в качестве источника API.
az apic integration create aws --aws-access-key-reference
--aws-region-name
--aws-secret-access-key-reference
--integration-name
--resource-group
--service-name
[--import-specification {always, never, ondemand}]
[--msi-resource-id]
[--target-environment-id]
[--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
Примеры
Добавление шлюза API Amazon в качестве источника API
az apic integration create aws -g contoso-resources -n contoso -i sync-from-my-amazon-api-gateway -a https://{keyvaultName}.vault.azure.net/secrets/{secretName1} -s https://{keyvaultName}.vault.azure.net/secrets/{secretName2} -r us-east-2
Обязательные параметры
Ключ доступа к шлюзу API Amazon. Должен быть ссылкой на секрет Azure Key Vault.
Свойство | Значение |
---|---|
Parameter group: | AmazonApiGatewaySource Arguments |
Регион шлюза API Amazon (например, us-east-2).
Свойство | Значение |
---|---|
Parameter group: | AmazonApiGatewaySource Arguments |
Секретный ключ доступа к шлюзу API Amazon. Должен быть ссылкой на секрет Azure Key Vault.
Свойство | Значение |
---|---|
Parameter group: | AmazonApiGatewaySource Arguments |
Имя интеграции.
Имя группы ресурсов Центра API Azure. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>
.
Имя службы Центра API Azure.
Необязательные параметры
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Указывает, следует ли импортировать спецификацию вместе с метаданными.
Свойство | Значение |
---|---|
Parameter group: | Properties Arguments |
Default value: | always |
Допустимые значения: | always, never, ondemand |
Идентификатор ресурса управляемого удостоверения, имеющего доступ к Azure Key Vault.
Свойство | Значение |
---|---|
Parameter group: | AmazonApiGatewaySource Arguments |
Идентификатор ресурса целевой среды.
Свойство | Значение |
---|---|
Parameter group: | Properties Arguments |
Целевой этап жизненного цикла.
Свойство | Значение |
---|---|
Parameter group: | Properties Arguments |
Допустимые значения: | deprecated, design, development, preview, production, retired, testing |
Глобальные параметры
Повышение уровня детализации журнала для включения всех журналов отладки.
Свойство | Значение |
---|---|
Default value: | False |
Показать это сообщение справки и выйти.
Отображать только ошибки, не показывая предупреждения.
Свойство | Значение |
---|---|
Default value: | False |
Формат вывода.
Свойство | Значение |
---|---|
Default value: | json |
Допустимые значения: | json, jsonc, none, table, tsv, yaml, yamlc |
Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.
Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID
.
Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.
Свойство | Значение |
---|---|
Default value: | False |