Edit

New-AzApiManagementLogger

  • Reference
Module:
Az.ApiManagement

Creates an API Management Logger.

Syntax

New-AzApiManagementLogger
   -Context <PsApiManagementContext>
   [-LoggerId <String>]
   -Name <String>
   -ConnectionString <String>
   [-Description <String>]
   [-IsBuffered <Boolean>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
New-AzApiManagementLogger
   -Context <PsApiManagementContext>
   [-LoggerId <String>]
   -InstrumentationKey <String>
   [-Description <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzApiManagementLogger cmdlet creates an Azure API Management Logger.

Examples

Example 1: Create a logger

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

This command creates a logger named ContosoSdkEventHub by using the specified connection string.

Example 2

Creates an API Management Logger. (autogenerated)

New-AzApiManagementLogger -Context <PsApiManagementContext> -InstrumentationKey <String> -LoggerId 'Logger123'

Parameters

-ConnectionString

Specifies an Azure Event Hubs connection string that starts with the following: Endpoint=endpoint and key from Azure classic portal The Key with Send Rights in the connection string must be configured.

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

-Context

Specifies a PsApiManagementContext object.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description.

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

-InstrumentationKey

Instrumentation Key of the application Insights. This parameter is optional.

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

-IsBuffered

Specifies whether the records in the logger are buffered before publishing. The default value is $True. When records are buffered, they are sent to Event Hubs every 15 seconds, or whenever the buffer receives 256 KB of messages.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LoggerId

Specifies an ID for the logger. If you do not specify an ID, this cmdlet generates one.

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

-Name

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

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

Inputs

PsApiManagementContext

String

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Outputs

PsApiManagementLogger