Edit

Share via


Get-AzApiManagementLogger

Gets API Management Logger objects.

Syntax

GetAllLoggers (Default)

Get-AzApiManagementLogger
    -Context <PsApiManagementContext>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByLoggerId

Get-AzApiManagementLogger
    -Context <PsApiManagementContext>
    -LoggerId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzApiManagementLogger cmdlet gets an Azure API Management Logger or all the loggers.

Examples

Example 1: Get all loggers

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementLogger -Context $apimContext

This command gets all the loggers for the specified context.

Example 2: Get a specific logger

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementLogger -Context $apimContext -LoggerId "Logger123"

This command removes a logger that has the ID Logger123.

Parameters

-Context

Specifies a PsApiManagementContext object.

Parameter properties

Type:PsApiManagementContext
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LoggerId

Specifies the ID of the specific logger to get.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetByLoggerId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PsApiManagementContext

String

Outputs

PsApiManagementLogger