logger

Creates, updates, deletes, gets or lists a logger resource.

Overview

Name	logger
Type	Resource
Id	azure.api_management.logger

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
credentials	object	The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger.
description	string	Logger description.
isBuffered	boolean	Whether records are buffered in the logger before publishing. Default is assumed to be true.
loggerType	string	Logger type. Required. Known values are: "azureEventHub", "applicationInsights", and "azureMonitor". (azureEventHub, applicationInsights, azureMonitor)
resourceId	string	Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
credentials	object	The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger.
description	string	Logger description.
isBuffered	boolean	Whether records are buffered in the logger before publishing. Default is assumed to be true.
loggerType	string	Logger type. Required. Known values are: "azureEventHub", "applicationInsights", and "azureMonitor". (azureEventHub, applicationInsights, azureMonitor)
resourceId	string	Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, logger_id, subscription_id		Gets the details of the logger specified by its identifier.
list_by_service	select	resource_group_name, service_name, subscription_id	$filter, $top, $skip	Lists a collection of loggers in the specified service instance.
create_or_update	insert	resource_group_name, service_name, logger_id, subscription_id		Creates or Updates a logger.
update	update	resource_group_name, service_name, logger_id, subscription_id		Updates an existing logger.
create_or_update	replace	resource_group_name, service_name, logger_id, subscription_id		Creates or Updates a logger.
delete	delete	resource_group_name, service_name, logger_id, subscription_id		Deletes the specified logger.
get_entity_tag	exec	resource_group_name, service_name, logger_id, subscription_id		Gets the entity state (Etag) version of the logger specified by its identifier.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
logger_id	string	Logger identifier. Must be unique in the API Management service instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || loggerType | filter | eq | || resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the details of the logger specified by its identifier.

SELECT
id,
name,
credentials,
description,
isBuffered,
loggerType,
resourceId,
systemData,
type
FROM azure.api_management.logger
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND logger_id = '{{ logger_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists a collection of loggers in the specified service instance.

SELECT
id,
name,
credentials,
description,
isBuffered,
loggerType,
resourceId,
systemData,
type
FROM azure.api_management.logger
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates or Updates a logger.

INSERT INTO azure.api_management.logger (
properties,
resource_group_name,
service_name,
logger_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ logger_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: logger
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the logger resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the logger resource.
  - name: logger_id
    value: "{{ logger_id }}"
    description: Required parameter for the logger resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the logger resource.
  - name: properties
    description: |
      Logger entity contract properties.
    value:
      loggerType: "{{ loggerType }}"
      description: "{{ description }}"
      credentials: "{{ credentials }}"
      isBuffered: {{ isBuffered }}
      resourceId: "{{ resourceId }}"

UPDATE examples

update

Updates an existing logger.

UPDATE azure.api_management.logger
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND logger_id = '{{ logger_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or Updates a logger.

REPLACE azure.api_management.logger
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND logger_id = '{{ logger_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified logger.

DELETE FROM azure.api_management.logger
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND logger_id = '{{ logger_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

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

EXEC azure.api_management.logger.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@logger_id='{{ logger_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;