az monitor app-insights web-test

  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.55.0 以降) の application-insights 拡張機能の一部です。 拡張機能は、az monitor app-insights web-test コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

アプリケーションの分析情報を使用して Web テストを管理します。

コマンド

名前 説明 型 Status
az monitor app-insights web-test create

アプリケーション インサイト Web テスト定義を作成します。

 拡張子 GA
az monitor app-insights web-test delete

アプリケーション インサイト Web テストを削除します。

 拡張子 GA
az monitor app-insights web-test list

指定したコンポーネントに対して定義されているすべてのアプリケーション インサイト Web テストを取得します。 また、指定したリソース グループ内で定義されているすべてのアプリケーション インサイト Web テストを取得します。 また、サブスクリプション内のすべてのアプリケーション インサイト Web テスト アラート定義を取得します。

 拡張子 GA
az monitor app-insights web-test show

特定のアプリケーション インサイト Web テスト定義を取得します。

 拡張子 GA
az monitor app-insights web-test update

アプリケーション インサイト Web テスト定義を更新します。

 拡張子 GA

az monitor app-insights web-test create

アプリケーション インサイト Web テスト定義を作成します。

az monitor app-insights web-test create --name
                                        --resource-group
                                        [--content-validation]
                                        [--defined-web-test-name]
                                        [--description]
                                        [--enabled {false, true}]
                                        [--expected-status-code]
                                        [--follow-redirects {false, true}]
                                        [--frequency]
                                        [--headers]
                                        [--http-verb]
                                        [--ignore-status-code {false, true}]
                                        [--kind {multistep, ping}]
                                        [--location]
                                        [--locations]
                                        [--parse-requests {false, true}]
                                        [--request-body]
                                        [--request-url]
                                        [--retry-enabled {false, true}]
                                        [--ssl-check {false, true}]
                                        [--ssl-lifetime-check]
                                        [--synthetic-monitor-id]
                                        [--tags]
                                        [--timeout]
                                        [--web-test]
                                        [--web-test-kind {multistep, ping, standard}]

例

webTestCreate

az monitor app-insights web-test create --kind "ping" --location "South Central US" --web-test "<WebTest Name=\"my-webtest\" Id=\"678ddf96-1ab8-44c8-9274-123456789abc\" Enabled=\"True\" CssProjectStructure=\"\" CssIteration=\"\" Timeout=\"120\" WorkItemIds=\"\" xmlns=\"http://microsoft.com/schemas/VisualStudio/TeamTest/2010\" Description=\"\" CredentialUserName=\"\" CredentialPassword=\"\" PreAuthenticate=\"True\" Proxy=\"default\" StopOnError=\"False\" RecordedResultFile=\"\" ResultsLocale=\"\" ><Items><Request Method=\"GET\" Guid=\"a4162485-9114-fcfc-e086-123456789abc\" Version=\"1.1\" Url=\"http://my-component.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"120\" ParseDependentRequests=\"True\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>" --description "Ping web test alert for mytestwebapp" --enabled true --frequency 900 --web-test-kind "ping" --locations Id="us-fl-mia-edge" --defined-web-test-name "my-webtest-my-component" --retry-enabled true --synthetic-monitor-id "my-webtest-my-component" --timeout 120 --resource-group "my-resource-group" --name "my-webtest-my-component" --tags hidden-link:XX=XX

webTestCreateStandard

az monitor app-insights web-test create --location "South Central US" --description "Ping web test alert for mytestwebapp" --enabled true --frequency 900 --web-test-kind "standard" --locations Id="us-fl-mia-edge" --defined-web-test-name "my-webtest-my-component" --http-verb "POST" --request-body "SGVsbG8gd29ybGQ=" --request-url "https://bing.com" --retry-enabled true --synthetic-monitor-id "my-webtest-my-component" --timeout 120 --ssl-lifetime-check 100 --ssl-check true --resource-group "my-resource-group" --name "my-webtest-my-component" --tags hidden-link:XX=XX

必須のパラメーター

--name --web-test-name -n

Application インサイト WebTest リソースの名前。

--resource-group -g

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

省略可能のパラメーター

--content-validation

コンテンツ検証プロパティのコレクション。

使用法: --content-validation content-match=XX ignore-case=XX pass-if-text-found=XX

content-match: WebTest の戻り値で検索するコンテンツ。 null または空にすることはできません。 ignore-case: この値を設定すると、ContentMatch 検証の大文字と小文字が区別されなくなります。 pass-if-text-found: true の場合、ContentMatch 文字列に一致するものがある場合、検証は成功します。 false の場合、一致する場合、検証は失敗します。

--defined-web-test-name

この WebTest の場合、ユーザー定義の名前。

--description

この WebTest のユーザー定義の説明。

--enabled

テストがアクティブに監視されているか。

承認された値: false, true
--expected-status-code

指定された http 状態コードが WebTest から返されることを検証します。

--follow-redirects

この Web テストのリダイレクトに従います。

承認された値: false, true
--frequency

この WebTest のテストの実行間隔 (秒単位)。 既定値は 300 です。

--headers

WebTest 呼び出しに追加するヘッダーとその値の一覧。

使用法: --headers key=XX value=XX

key: ヘッダーの名前。 value: ヘッダーの値。

複数の --headers 引数を使用して、複数のアクションを指定できます。

--http-verb

この Web テストに使用する Http 動詞。

--ignore-status-code

設定すると、検証は状態コードを無視します。

承認された値: false, true
--kind

この Web テストで監視される WebTest の種類。 選択肢は ping と multistep です。

承認された値: multistep, ping
--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--locations

アプリケーションのアクセシビリティをグローバルにカバーするためにテストを物理的に実行する場所の一覧。

使用法: --locations Id=XX

Id: 実行する WebTest の場所 ID。

複数の --locations 引数を使用して、複数のアクションを指定できます。

--parse-requests

この WebTest の依存要求を解析します。

承認された値: false, true
--request-body

この Web テストで送信する Base64 でエンコードされた文字列本文。

--request-url

テストする URL の場所。

--retry-enabled

この WebTest が失敗した場合は再試行を許可します。

承認された値: false, true
--ssl-check

SSL 証明書がまだ有効かどうかを確認します。

承認された値: false, true
--ssl-lifetime-check

既存の SSL 証明書の有効期限が切れるまでメインチェック日数。 値は正の値で、SSLCheck は true に設定する必要があります。

--synthetic-monitor-id

この WebTest の一意の ID。 これは通常、[名前] フィールドと同じ値です。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--timeout

この WebTest がタイムアウトして失敗するまでの秒数。 既定値は 30 です。

--web-test

アプリケーションに対して実行する WebTest の XML 仕様。

--web-test-kind

これは、有効な選択肢は ping、multistep、standard の Web テストの種類です。

承認された値: multistep, ping, standard
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az monitor app-insights web-test delete

アプリケーション インサイト Web テストを削除します。

az monitor app-insights web-test delete --name
                                        --resource-group
                                        [--yes]

例

webTestDelete

az monitor app-insights web-test delete --resource-group "my-resource-group" --name "my-webtest-01-mywebservice"

必須のパラメーター

--name --web-test-name -n

Application インサイト WebTest リソースの名前。

--resource-group -g

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

省略可能のパラメーター

--yes -y

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

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az monitor app-insights web-test list

指定したコンポーネントに対して定義されているすべてのアプリケーション インサイト Web テストを取得します。 また、指定したリソース グループ内で定義されているすべてのアプリケーション インサイト Web テストを取得します。 また、サブスクリプション内のすべてのアプリケーション インサイト Web テスト アラート定義を取得します。

az monitor app-insights web-test list [--component-name]
                                      [--resource-group]

例

webTestListByComponent

az monitor app-insights web-test list --component-name "my-component" --resource-group "my-resource-group"

webTestListByResourceGroup

az monitor app-insights web-test list --resource-group "my-resource-group"

webTestList

az monitor app-insights web-test list

省略可能のパラメーター

--component-name

Application インサイト コンポーネント リソースの名前。

--resource-group -g

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

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az monitor app-insights web-test show

特定のアプリケーション インサイト Web テスト定義を取得します。

az monitor app-insights web-test show --name
                                      --resource-group

例

webTestGet

az monitor app-insights web-test show --resource-group "my-resource-group" --name "my-webtest-01-mywebservice"

必須のパラメーター

--name --web-test-name -n

Application インサイト WebTest リソースの名前。

--resource-group -g

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

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az monitor app-insights web-test update

アプリケーション インサイト Web テスト定義を更新します。

az monitor app-insights web-test update --name
                                        --resource-group
                                        [--add]
                                        [--content-validation]
                                        [--defined-web-test-name]
                                        [--description]
                                        [--enabled {false, true}]
                                        [--expected-status-code]
                                        [--follow-redirects {false, true}]
                                        [--force-string]
                                        [--frequency]
                                        [--headers]
                                        [--http-verb]
                                        [--ignore-status-code {false, true}]
                                        [--kind {multistep, ping}]
                                        [--location]
                                        [--locations]
                                        [--parse-requests {false, true}]
                                        [--remove]
                                        [--request-body]
                                        [--request-url]
                                        [--retry-enabled {false, true}]
                                        [--set]
                                        [--ssl-check {false, true}]
                                        [--ssl-lifetime-check]
                                        [--synthetic-monitor-id]
                                        [--tags]
                                        [--timeout]
                                        [--web-test]
                                        [--web-test-kind {multistep, ping, standard}]

例

webTestUpdate

az monitor app-insights web-test update --kind "ping" --location "South Central US" --web-test "<WebTest Name=\"my-webtest\" Id=\"678ddf96-1ab8-44c8-9274-123456789abc\" Enabled=\"True\" CssProjectStructure=\"\" CssIteration=\"\" Timeout=\"30\" WorkItemIds=\"\" xmlns=\"http://microsoft.com/schemas/VisualStudio/TeamTest/2010\" Description=\"\" CredentialUserName=\"\" CredentialPassword=\"\" PreAuthenticate=\"True\" Proxy=\"default\" StopOnError=\"False\" RecordedResultFile=\"\" ResultsLocale=\"\" ><Items><Request Method=\"GET\" Guid=\"a4162485-9114-fcfc-e086-123456789abc\" Version=\"1.1\" Url=\"http://my-component.azurewebsites.net\" ThinkTime=\"0\" Timeout=\"30\" ParseDependentRequests=\"True\" FollowRedirects=\"True\" RecordResult=\"True\" Cache=\"False\" ResponseTimeGoal=\"0\" Encoding=\"utf-8\" ExpectedHttpStatusCode=\"200\" ExpectedResponseUrl=\"\" ReportingName=\"\" IgnoreHttpStatusCode=\"False\" /></Items></WebTest>" --frequency 600 --web-test-kind "ping" --locations Id="us-fl-mia-edge" --locations Id="apac-hk-hkn-azr" --defined-web-test-name "my-webtest-my-component" --synthetic-monitor-id "my-webtest-my-component" --timeout 30 --resource-group "my-resource-group" --name "my-webtest-my-component"

必須のパラメーター

--name --web-test-name -n

Application インサイト WebTest リソースの名前。

--resource-group -g

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

省略可能のパラメーター

--add

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

既定値: []
--content-validation

コンテンツ検証プロパティのコレクション。

使用法: --content-validation content-match=XX ignore-case=XX pass-if-text-found=XX

content-match: WebTest の戻り値で検索するコンテンツ。 null または空にすることはできません。 ignore-case: この値を設定すると、ContentMatch 検証の大文字と小文字が区別されなくなります。 pass-if-text-found: true の場合、ContentMatch 文字列に一致するものがある場合、検証は成功します。 false の場合、一致する場合、検証は失敗します。

--defined-web-test-name

この WebTest の場合、ユーザー定義の名前。

--description

この WebTest のユーザー定義の説明。

--enabled

テストがアクティブに監視されているか。

承認された値: false, true
--expected-status-code

指定された http 状態コードが WebTest から返されることを検証します。

--follow-redirects

この Web テストのリダイレクトに従います。

承認された値: false, true
--force-string

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

既定値: False
--frequency

この WebTest のテストの実行間隔 (秒単位)。 既定値は 300 です。

--headers

WebTest 呼び出しに追加するヘッダーとその値の一覧。

使用法: --headers key=XX value=XX

key: ヘッダーの名前。 value: ヘッダーの値。

複数の --headers 引数を使用して、複数のアクションを指定できます。

--http-verb

この Web テストに使用する Http 動詞。

--ignore-status-code

設定すると、検証は状態コードを無視します。

承認された値: false, true
--kind

この Web テストで監視される WebTest の種類。 選択肢は ping と multistep です。

承認された値: multistep, ping
--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--locations

アプリケーションのアクセシビリティをグローバルにカバーするためにテストを物理的に実行する場所の一覧。

使用法: --locations Id=XX

Id: 実行する WebTest の場所 ID。

複数の --locations 引数を使用して、複数のアクションを指定できます。

--parse-requests

この WebTest の依存要求を解析します。

承認された値: false, true
--remove

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

既定値: []
--request-body

この Web テストで送信する Base64 でエンコードされた文字列本文。

--request-url

テストする URL の場所。

--retry-enabled

この WebTest が失敗した場合は再試行を許可します。

承認された値: false, true
--set

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

既定値: []
--ssl-check

SSL 証明書がまだ有効かどうかを確認します。

承認された値: false, true
--ssl-lifetime-check

既存の SSL 証明書の有効期限が切れるまでメインチェック日数。 値は正の値で、SSLCheck は true に設定する必要があります。

--synthetic-monitor-id

この WebTest の一意の ID。 これは通常、[名前] フィールドと同じ値です。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--timeout

この WebTest がタイムアウトして失敗するまでの秒数。 既定値は 30 です。

--web-test

アプリケーションに対して実行する WebTest の XML 仕様。

--web-test-kind

これは、有効な選択肢は ping、multistep、standard の Web テストの種類です。

承認された値: multistep, ping, standard
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。