< Back
Set-AzureRmApiManagementLogger
Post
NAME Set-AzureRmApiManagementLogger
SYNOPSIS
Modifies an API Management Logger.
SYNTAX
Set-AzureRmApiManagementLogger [-ConnectionString <String>] -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>]
[-Description <String>] [-IsBuffered] -LoggerId <String> [-Name <String>] [-PassThru] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmApiManagementLogger cmdlet modifies settings of an Azure API Management Logger .
PARAMETERS
-ConnectionString <String>
Specifies an Azure Event Hubs connection string that includes Send policy rights.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Specifies a PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies a description.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-IsBuffered [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LoggerId <String>
Specifies the ID of the logger to update.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the entity name of an event hub from Azure classic portal.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns the PsApiManagementLogger that this cmdlet modifies.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger
NOTES
Example 1: Modify a logger
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... mentlogger
Get-AzureRmApiManagementLogger
New-AzureRmApiManagementLogger
Remove-AzureRmApiManagementLogger
SYNOPSIS
Modifies an API Management Logger.
SYNTAX
Set-AzureRmApiManagementLogger [-ConnectionString <String>] -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>]
[-Description <String>] [-IsBuffered] -LoggerId <String> [-Name <String>] [-PassThru] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmApiManagementLogger cmdlet modifies settings of an Azure API Management Logger .
PARAMETERS
-ConnectionString <String>
Specifies an Azure Event Hubs connection string that includes Send policy rights.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Specifies a PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies a description.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-IsBuffered [<SwitchParameter>]
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.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LoggerId <String>
Specifies the ID of the logger to update.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the entity name of an event hub from Azure classic portal.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Indicates that this cmdlet returns the PsApiManagementLogger that this cmdlet modifies.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger
NOTES
Example 1: Modify a logger
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... mentlogger
Get-AzureRmApiManagementLogger
New-AzureRmApiManagementLogger
Remove-AzureRmApiManagementLogger