Share via

Logger interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a Logger.

Methods

createOrUpdate(string, string, string, LoggerContract, LoggerCreateOrUpdateOptionalParams)

Creates or Updates a logger.
delete(string, string, string, string, LoggerDeleteOptionalParams)

Deletes the specified logger.
get(string, string, string, LoggerGetOptionalParams)

Gets the details of the logger specified by its identifier.
getEntityTag(string, string, string, LoggerGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the logger specified by its identifier.
listByService(string, string, LoggerListByServiceOptionalParams)

Lists a collection of loggers in the specified service instance.
update(string, string, string, string, LoggerUpdateContract, LoggerUpdateOptionalParams)

Updates an existing logger.

Method Details

createOrUpdate(string, string, string, LoggerContract, LoggerCreateOrUpdateOptionalParams)

Creates or Updates a logger.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

options
LoggerCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<LoggerCreateOrUpdateResponse>

delete(string, string, string, string, LoggerDeleteOptionalParams)

Deletes the specified logger.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

options
LoggerDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, LoggerGetOptionalParams)

Gets the details of the logger specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

loggerId

string

Logger identifier. Must be unique in the API Management service instance.

options
LoggerGetOptionalParams

The options parameters.

Returns

Promise<LoggerGetResponse>

getEntityTag(string, string, string, LoggerGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the logger specified by its identifier.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

loggerId

string

Logger identifier. Must be unique in the API Management service instance.

options
LoggerGetEntityTagOptionalParams

The options parameters.

Returns

Promise<LoggerGetEntityTagHeaders>

listByService(string, string, LoggerListByServiceOptionalParams)

Lists a collection of loggers in the specified service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: LoggerListByServiceOptionalParams): PagedAsyncIterableIterator<LoggerContract, LoggerContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
LoggerListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LoggerContract, LoggerContract[], PageSettings>

update(string, string, string, string, LoggerUpdateContract, LoggerUpdateOptionalParams)

Updates an existing logger.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

options
LoggerUpdateOptionalParams

The options parameters.

Returns

Promise<LoggerUpdateResponse>