Set-​Azure​Rm​Api​Management​Logger

Modifies an API Management Logger.

Syntax

Set-AzureRmApiManagementLogger
   [-ConnectionString <String>]
   -Context <PsApiManagementContext>
   [-Description <String>]
   [-IsBuffered]
   -LoggerId <String>
   [-Name <String>]
   [-PassThru]
   [<CommonParameters>]

Description

The Set-AzureRmApiManagementLogger cmdlet modifies settings of an Azure API Management Logger.

Examples

Example 1: Modify a logger

PS C:\>Set-AzureRmApiManagementLogger -Context $ApimContext -LoggerId "Logger123" -Name "ContosoSdkEventHub" -ConnectionString "Endpoint=sb://ContosoSdkEventHubs.servicebus.windows.net/;SharedAccessKeyName=SendKey;SharedAccessKey=<key>" -Description "updated SDK event hub logger" -PassThru

This command modifies a logger that has the ID Logger123.

Required Parameters

-Context

Specifies a PsApiManagementContext object.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-LoggerId

Specifies the ID of the logger to update.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-ConnectionString

Specifies an Azure Event Hubs connection string that includes Send policy rights.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Description

Specifies a description.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-IsBuffered

Specifies that the records in the logger are buffered before publishing. When records are buffered, they are sent to Event Hubs every 15 seconds, or whenever the buffer receives 256 KB of messages.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the entity name of an event hub from Azure classic portal.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-PassThru

Indicates that this cmdlet returns the PsApiManagementLogger that this cmdlet modifies.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger