Set-AzApiManagementDiagnostic
グローバルスコープまたは API スコープで API Management 診断を変更します。
構文
Set-AzApiManagementDiagnostic
-Context <PsApiManagementContext>
-DiagnosticId <String>
[-ApiId <String>]
[-LoggerId <String>]
[-AlwaysLog <String>]
[-SamplingSetting <PsApiManagementSamplingSetting>]
[-FrontEndSetting <PsApiManagementPipelineDiagnosticSetting>]
[-BackendSetting <PsApiManagementPipelineDiagnosticSetting>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzApiManagementDiagnostic
-InputObject <PsApiManagementDiagnostic>
[-LoggerId <String>]
[-AlwaysLog <String>]
[-SamplingSetting <PsApiManagementSamplingSetting>]
[-FrontEndSetting <PsApiManagementPipelineDiagnosticSetting>]
[-BackendSetting <PsApiManagementPipelineDiagnosticSetting>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzApiManagementDiagnostic
-ResourceId <String>
[-LoggerId <String>]
[-AlwaysLog <String>]
[-SamplingSetting <PsApiManagementSamplingSetting>]
[-FrontEndSetting <PsApiManagementPipelineDiagnosticSetting>]
[-BackendSetting <PsApiManagementPipelineDiagnosticSetting>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
コマンドレット Set-AzApiManagementDiagnostic は、グローバル スコープまたは API スコープで構成されている診断を更新します。
例
例 1: グローバル スコープで診断を変更する
$context =New-AzApiManagementContext -ResourceGroupName Api-Default-WestUS -ServiceName contoso
$diagnostic=Get-AzApiManagementDiagnostic -Context $context -DiagnosticId "applicationinsights"
$diagnostic
DiagnosticId : applicationinsights
AlwaysLog : allErrors
LoggerId : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/loggers/backendapisachinc
Sampling : Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSamplingSetting
Frontend :
Backend :
Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/diagnostics/applicationinsights
ResourceGroupName : Api-Default-WestUS
ServiceName : contoso
$diagnostic.Sampling
SamplingType Percentage
------------ ----------
fixed 100
$diagnostic.Sampling.Percentage = 50
$diagnostic.Sampling
SamplingType Percentage
------------ ----------
fixed 50
Set-AzApiManagementDiagnostic -InputObject $diagnosticこのコマンドは、指定された診断サンプリング率を 100 から 50% に変更します。
例 2
グローバルスコープまたは API スコープで API Management 診断を変更します。 (自動生成)
Set-AzApiManagementDiagnostic -AlwaysLog allErrors -ApiId '0001' -Context <PsApiManagementContext> -DiagnosticId 'applicationinsights' -LoggerId 'Logger123' -SamplingSetting <PsApiManagementSamplingSetting>パラメーター
-AlwaysLog
適用しないメッセージ サンプリング設定の種類を指定します。 このパラメーターは省略可能です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApiId
既存の API の識別子。 このパラメーターは省略可能です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BackendSetting
バックエンドへの受信/送信 Http メッセージの診断設定。 このパラメーターは省略可能です。
| Type: | PsApiManagementPipelineDiagnosticSetting |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Context
PsApiManagementContext のインスタンス。 このパラメーターは必須です。
| Type: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DiagnosticId
既存の診断の識別子。 このパラメーターは必須です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FrontEndSetting
ゲートウェイへの受信/送信 Http メッセージの診断設定。 このパラメーターは省略可能です。
| Type: | PsApiManagementPipelineDiagnosticSetting |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
PsApiManagementDiagnostic のインスタンス。 このパラメーターは必須です。
| Type: | PsApiManagementDiagnostic |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LoggerId
診断をプッシュするロガーの識別子。 このパラメーターは必須です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
指定した場合、設定された診断を表す Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementDiagnostic 型のインスタンス。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceId
診断または API 診断の Arm ResourceId。 このパラメーターは必須です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SamplingSetting
診断のサンプリング設定。 このパラメーターは省略可能です。
| Type: | PsApiManagementSamplingSetting |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
PsApiManagementSamplingSetting
PsApiManagementPipelineDiagnosticSetting
出力
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Azure PowerShell
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示