LoggerImpl | @azure/arm-apimanagement

Class containing Logger operations.

Hierarchy

LoggerImpl

Implements

Logger

Index

Constructors

constructor

Methods

Constructors

constructor

new LoggerImpl(client: ApiManagementClientContext): LoggerImpl

- Defined in operations/logger.ts:36
Initialize a new instance of the class Logger class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns LoggerImpl

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, loggerId: string, parameters: LoggerContract, options?: LoggerCreateOrUpdateOptionalParams): Promise<LoggerCreateOrUpdateResponse>

Implementation of Logger.createOrUpdate
- Defined in operations/logger.ts:180
Creates or Updates a logger.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- loggerId: string
  
  Logger identifier. Must be unique in the API Management service instance.
- parameters: LoggerContract
  
  Create parameters.
- Optional options: LoggerCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<LoggerCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, loggerId: string, ifMatch: string, options?: LoggerDeleteOptionalParams): Promise<void>

Implementation of Logger.delete
- Defined in operations/logger.ts:233
Deletes the specified logger.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- loggerId: string
  
  Logger identifier. Must be unique in the API Management service instance.
- ifMatch: string
  
  ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- Optional options: LoggerDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, loggerId: string, options?: LoggerGetOptionalParams): Promise<LoggerGetResponse>

Implementation of Logger.get
- Defined in operations/logger.ts:160
Gets the details of the logger specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- loggerId: string
  
  Logger identifier. Must be unique in the API Management service instance.
- Optional options: LoggerGetOptionalParams
  
  The options parameters.
Returns Promise<LoggerGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, loggerId: string, options?: LoggerGetEntityTagOptionalParams): Promise<LoggerGetEntityTagResponse>

Implementation of Logger.getEntityTag
- Defined in operations/logger.ts:141
Gets the entity state (Etag) version of the logger specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- loggerId: string
  
  Logger identifier. Must be unique in the API Management service instance.
- Optional options: LoggerGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<LoggerGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: LoggerListByServiceOptionalParams): PagedAsyncIterableIterator<LoggerContract>

Implementation of Logger.listByService
- Defined in operations/logger.ts:52
Lists a collection of loggers in the specified service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: LoggerListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LoggerContract>

update

update(resourceGroupName: string, serviceName: string, loggerId: string, ifMatch: string, parameters: LoggerUpdateContract, options?: LoggerUpdateOptionalParams): Promise<LoggerUpdateResponse>

Implementation of Logger.update
- Defined in operations/logger.ts:203
Updates an existing logger.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- loggerId: string
  
  Logger identifier. Must be unique in the API Management service instance.
- ifMatch: string
  
  ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- parameters: LoggerUpdateContract
  
  Update parameters.
- Optional options: LoggerUpdateOptionalParams
  
  The options parameters.
Returns Promise<LoggerUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns LoggerImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

loggerId: string

parameters: LoggerContract

Optional options: LoggerCreateOrUpdateOptionalParams

Returns Promise<LoggerCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

loggerId: string

ifMatch: string

Optional options: LoggerDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

loggerId: string

Optional options: LoggerGetOptionalParams

Returns Promise<LoggerGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

loggerId: string

Optional options: LoggerGetEntityTagOptionalParams

Returns Promise<LoggerGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: LoggerListByServiceOptionalParams

Returns PagedAsyncIterableIterator<LoggerContract>

update

Parameters

resourceGroupName: string

serviceName: string

loggerId: string

ifMatch: string

parameters: LoggerUpdateContract

Optional options: LoggerUpdateOptionalParams

Returns Promise<LoggerUpdateResponse>