az apim backend

Azure API Managementバックエンドを管理します。

コマンド

名前	説明	型	状態
az apim backend create	API Management バックエンドを作成または更新します。	Core	GA
az apim backend delete	API Management バックエンドを削除します。	Core	GA
az apim backend list	API Management バックエンドを一覧表示します。	Core	GA
az apim backend show	API Management バックエンドの詳細を表示します。	Core	GA
az apim backend update	API Management バックエンドを更新します。	Core	GA

az apim backend create

編集

API Management バックエンドを作成または更新します。

az apim backend create --backend-id
                       --protocol {http, soap}
                       --resource-group
                       --service-name
                       --url
                       [--acquire-policy-token]
                       [--change-reference]
                       [--description]
                       [--if-match]

例

バックエンドを作成します。

az apim backend create --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mybackend.com --protocol http

必須のパラメーター

--backend-id

作成または更新するバックエンドの一意の名前。

現在の API Management サービスインスタンスで一意である必要があります。

プロパティ	値
パラメーターグループ:	Backend Arguments

--protocol

バックエンドサービスとの通信に使用されるプロトコル。

プロパティ	値
指定可能な値:	http, soap

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name -n

API Management サービスインスタンスの名前。

--url

バックエンドサービスの URL。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーターグループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーターグループ:	Global Policy Arguments

--description

バックエンドの説明。 HTML 書式設定タグを含めることができます。

--if-match

エンティティの ETag。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apim backend delete

編集

API Management バックエンドを削除します。

az apim backend delete --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--change-reference]
                       [--if-match]
                       [--yes]

例

APIM インスタンスのバックエンドを削除します。

az apim backend delete --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

必須のパラメーター

--backend-id

バックエンドの識別子。

プロパティ	値
パラメーターグループ:	Backend Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name -n

API Management サービスインスタンスの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーターグループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーターグループ:	Global Policy Arguments

--if-match

エンティティの ETag。

--yes -y

確認のダイアログを表示しません。

プロパティ	値
規定値:	False

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apim backend list

編集

API Management バックエンドを一覧表示します。

az apim backend list --resource-group
                     --service-name

例

APIM インスタンス内のすべてのバックエンドを一覧表示します。

az apim backend list --resource-group MyResourceGroup --service-name MyServiceName

必須のパラメーター

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name -n

API Management サービスインスタンスの名前。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apim backend show

編集

API Management バックエンドの詳細を表示します。

az apim backend show --backend-id
                     --resource-group
                     --service-name

例

APIM インスタンスのバックエンドの詳細を表示します。

az apim backend show --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

必須のパラメーター

--backend-id

バックエンドの識別子。

プロパティ	値
パラメーターグループ:	Backend Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name -n

API Management サービスインスタンスの名前。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apim backend update

編集

API Management バックエンドを更新します。

az apim backend update --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--add]
                       [--change-reference]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--protocol {http, soap}]
                       [--remove]
                       [--set]
                       [--url]

例

バックエンドを更新します。

az apim backend update --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mynewbackend.com

必須のパラメーター

--backend-id

更新するバックエンドの一意の名前。

現在の API Management サービスインスタンスで一意である必要があります。

プロパティ	値
パラメーターグループ:	Backend Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name -n

API Management サービスインスタンスの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーターグループ:	Global Policy Arguments

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
パラメーターグループ:	Generic Update Arguments
規定値:	[]

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーターグループ:	Global Policy Arguments

--description

バックエンドの説明。 HTML 書式設定タグを含めることができます。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
パラメーターグループ:	Generic Update Arguments
規定値:	False

--if-match

エンティティの ETag。エンティティを作成する場合は必要ありませんが、エンティティを更新する場合は必須です。既定値は None です。

--protocol

バックエンドサービスとの通信に使用されるプロトコル。使用可能な値は、 http、 soapです。

プロパティ	値
指定可能な値:	http, soap

--remove

リストからプロパティまたは要素を削除します。例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
パラメーターグループ:	Generic Update Arguments
規定値:	[]

--set

設定するプロパティパスと値を指定して、オブジェクトを更新します。例: --set property1.property2=<value>。

プロパティ	値
パラメーターグループ:	Generic Update Arguments
規定値:	[]

--url

バックエンドサービスの URL。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

フィードバック

このページはお役に立ちましたか?