az apic integration create
Note
This reference is part of the apic-extension extension for the Azure CLI (version 2.57.0 or higher). 拡張機能は、az apic integration create コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.
コマンド グループ 'az apic integration' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az apic integration create apim |
API ソースとして Azure APIM を追加します。 |
Extension | Preview |
az apic integration create aws |
API ソースとして Amazon API Gateway を追加します。 |
Extension | Preview |
az apic integration create apim
コマンド グループ 'az apic integration' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
API ソースとして Azure APIM を追加します。
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 API Center インスタンスと同じリソース グループに API ソースとして Azure APIM を追加する
az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim myapim
別のリソース グループに API ソースとして Azure APIM を追加する
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 インスタンスの名前またはリソース ID。
プロパティ | 値 |
---|---|
Parameter group: | AzureApiManagementSource Arguments |
統合の名前。
Azure API Center リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure API Center サービスの名前。
省略可能のパラメーター
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 |
規定値: | always |
指定可能な値: | always, never, ondemand |
API Management インスタンスにアクセスできるマネージド ID のリソース ID。
プロパティ | 値 |
---|---|
Parameter group: | AzureApiManagementSource Arguments |
ターゲット環境のリソース ID。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
ターゲット ライフサイクル ステージ。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | deprecated, design, development, preview, production, retired, testing |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az apic integration create aws
コマンド グループ 'az apic integration' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
API ソースとして Amazon API Gateway を追加します。
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 Gateway を追加する
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
必須のパラメーター
Amazon API Gateway アクセス キー。 Azure Key Vault シークレット参照である必要があります。
プロパティ | 値 |
---|---|
Parameter group: | AmazonApiGatewaySource Arguments |
Amazon API ゲートウェイリージョン (us-east-2 など)。
プロパティ | 値 |
---|---|
Parameter group: | AmazonApiGatewaySource Arguments |
Amazon API Gateway シークレット アクセス キー。 Azure Key Vault シークレット参照である必要があります。
プロパティ | 値 |
---|---|
Parameter group: | AmazonApiGatewaySource Arguments |
統合の名前。
Azure API Center リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure API Center サービスの名前。
省略可能のパラメーター
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 |
規定値: | always |
指定可能な値: | always, never, ondemand |
Azure Key Vault にアクセスできるマネージド ID のリソース ID。
プロパティ | 値 |
---|---|
Parameter group: | AmazonApiGatewaySource Arguments |
ターゲット環境のリソース ID。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
ターゲット ライフサイクル ステージ。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | deprecated, design, development, preview, production, retired, testing |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |