Set-AzApiManagementLogger

  • リファレンス
モジュール:
Az.ApiManagement

API Management ロガーを変更します。

構文

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

説明

Set-AzApiManagementLogger コマンドレットは、Azure API Management ロガーの設定を変更します。

例

例 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 Management ロガーを変更します。 (自動生成)

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

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-ConnectionString

ポリシーの送信権限を含む Azure Event Hubs 接続文字列を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

-Description

説明を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InstrumentationKey

アプリケーション インサイトのインストルメンテーション キー。 このパラメーターは省略可能です。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-IsBuffered

パブリッシュする前にロガー内のレコードをバッファーに格納することを指定します。 レコードがバッファーされると、15 秒ごとに、またはバッファーが 256 KB (キロバイト)のメッセージを受信するたびに Event Hubs に送信されます。

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

-LoggerId

更新するロガーの ID を指定します。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Azure クラシック ポータルからのイベント ハブのエンティティ名を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

このコマンドレットが変更する PsApiManagementLogger を返すコマンドレットを示します。

Type:SwitchParameter
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

入力

PsApiManagementContext

String

SwitchParameter

出力

PsApiManagementLogger