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

Set-AzApiManagementLogger

修改 API 管理记录器。

语法

EventHubLoggerSet (默认值)

Set-AzApiManagementLogger
    -Context <PsApiManagementContext>
    -LoggerId <String>
    [-Name <String>]
    [-ConnectionString <String>]
    [-Description <String>]
    [-IsBuffered]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ApplicationInsightsLoggerSet

Set-AzApiManagementLogger
    -Context <PsApiManagementContext>
    -LoggerId <String>
    [-InstrumentationKey <String>]
    [-Description <String>]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

Set-AzApiManagementLogger cmdlet 修改 Azure API 管理记录器的设置。

示例

示例 1:修改 EventHub 记录器

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementLogger -Context $apimContext -LoggerId "Logger123" -Name "ContosoSdkEventHub" -ConnectionString "Endpoint=sb://ContosoSdkEventHubs.servicebus.windows.net/;SharedAccessKeyName=SendKey;SharedAccessKey=<key>" -Description "updated SDK event hub logger" -PassThru

此命令修改 ID 为 Logger123 的记录器。

示例 2

修改 API 管理记录器。 (autogenerated)

Set-AzApiManagementLogger -Confirm -Context <PsApiManagementContext> -InstrumentationKey <String> -LoggerId 'Logger123'

参数

-Confirm

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

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ConnectionString

指定包含发送策略权限的 Azure 事件中心连接字符串。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

EventHubLoggerSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Context

指定 PsApiManagementContext 对象。

参数属性

类型:PsApiManagementContext
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Description

指定说明。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-InstrumentationKey

Application Insights 的检测密钥。 此参数是可选的。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ApplicationInsightsLoggerSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-IsBuffered

指定在发布之前缓冲记录器中的记录。 缓冲记录时,每 15 秒或缓冲区接收 256 KB 的消息时,它们每 15 秒发送到事件中心。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

EventHubLoggerSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-LoggerId

指定要更新的记录器 ID。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Name

从 Azure 经典门户指定事件中心的实体名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

EventHubLoggerSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-PassThru

指示此 cmdlet 返回此 cmdlet 修改的 PsApiManagementLogger

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

PsApiManagementContext

String

SwitchParameter

输出

PsApiManagementLogger