你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzApiManagementDiagnostic

  • 参考
模块:
Az.ApiManagement

修改全局或 API 范围内的API 管理诊断。

语法

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>]

说明

cmdlet 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 管理诊断。 （自动生成）

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

提示你在运行 cmdlet 之前进行确认。

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

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

PsApiManagementContext

String

PsApiManagementDiagnostic

PsApiManagementSamplingSetting

PsApiManagementPipelineDiagnosticSetting

SwitchParameter

输出

PsApiManagementDiagnostic