openapi-directory/api/azure.com/apimanagement-apimloggers.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing operations on logger entity Azure API Management deployment.The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure EventHub.","title":"ApiManagementClient","version":"2019-12-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimloggers.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimloggers","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers":{"get":{"description":"Lists a collection of loggers in the specified service instance.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-log-event-hubs"},"operationId":"Logger_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListLoggers":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListLoggers":{"value":"apimService1"}}},{"description":"|   Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| loggerType | filter | eq |     | </br>| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListLoggers":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListLoggers":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Logger entities.","content":{"application/json":{"schema":{"description":"Paged Logger list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Logger values.","items":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Logger details.","properties":{"properties":{"description":"The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.","properties":{"credentials":{"additionalProperties":{"type":"string"},"description":"The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger.","example":{"connectionString":"Endpoint=sb://contoso-ns.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=...","name":"apim"},"type":"object"},"description":{"description":"Logger description.","maxLength":256,"type":"string"},"isBuffered":{"description":"Whether records are buffered in the logger before publishing. Default is assumed to be true.","type":"boolean"},"loggerType":{"description":"Logger type.","enum":["azureEventHub","applicationInsights"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"LoggerType","values":[{"description":"Azure Event Hub as log destination.","value":"azureEventHub"},{"description":"Azure Application Insights as log destination.","value":"applicationInsights"}]}},"resourceId":{"description":"Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).","type":"string"}},"required":["loggerType","credentials"]}}},"type":"array"}}},"examples":{"ApiManagementListLoggers":{"$ref":"#/components/examples/ApiManagementListLoggers"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Logger"],"x-ms-odata":"./definitions.json#/definitions/LoggerContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}":{"delete":{"description":"Deletes the specified logger.","operationId":"Logger_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteLogger":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementDeleteLogger":{"value":"apimService1"}}},{"description":"Logger identifier. Must be unique in the API Management service instance.","in":"path","name":"loggerId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementDeleteLogger":{"value":"loggerId"}}},{"description":"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.","in":"header","name":"If-Match","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteLogger":{"value":"*"}}},{"description":"Force deletion even if diagnostic is attached.","in":"query","name":"force","required":false,"schema":{"type":"boolean"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteLogger":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteLogger":{"value":"subid"}}}],"responses":{"200":{"description":"The logger was successfully deleted."},"204":{"description":"The logger was successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Logger"]},"get":{"description":"Gets the details of the logger specified by its identifier.","operationId":"Logger_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetLogger":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetLogger":{"value":"apimService1"}}},{"description":"Logger identifier. Must be unique in the API Management service instance.","in":"path","name":"loggerId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementGetLogger":{"value":"templateLogger"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetLogger":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetLogger":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified Logger entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Logger details.","properties":{"properties":{"description":"The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.","properties":{"credentials":{"additionalProperties":{"type":"string"},"description":"The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger.","example":{"connectionString":"Endpoint=sb://contoso-ns.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=...","name":"apim"},"type":"object"},"description":{"description":"Logger description.","maxLength":256,"type":"string"},"isBuffered":{"description":"Whether records are buffered in the logger before publishing. Default is assumed to be true.","type":"boolean"},"loggerType":{"description":"Logger type.","enum":["azureEventHub","applicationInsights"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"LoggerType","values":[{"description":"Azure Event Hub as log destination.","value":"azureEventHub"},{"description":"Azure Application Insights as log destination.","value":"applicationInsights"}]}},"resourceId":{"description":"Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).","type":"string"}},"required":["loggerType","credentials"]}}},"examples":{"ApiManagementGetLogger":{"$ref":"#/components/examples/ApiManagementGetLogger"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Logger"]},"head":{"description":"Gets the entity state (Etag) version of the logger specified by its identifier.","operationId":"Logger_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadLogger":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementHeadLogger":{"value":"apimService1"}}},{"description":"Logger identifier. Must be unique in the API Management service instance.","in":"path","name":"loggerId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementHeadLogger":{"value":"templateLogger"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadLogger":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadLogger":{"value":"subid"}}}],"responses":{"200":{"description":"Specified logger entity exists and current entity state version is present in the ETag header.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Logger"]},"patch":{"description":"Updates an existing logger.","operationId":"Logger_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateLogger":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementUpdateLogger":{"value":"apimService1"}}},{"description":"Logger identifier. Must be unique in the API Management service instance.","in":"path","name":"loggerId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementUpdateLogger":{"value":"loggerId"}}},{"description":"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.","in":"header","name":"If-Match","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateLogger":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateLogger":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateLogger":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Logger update contract.","properties":{"properties":{"description":"Parameters supplied to the Update Logger operation.","properties":{"credentials":{"additionalProperties":{"type":"string"},"description":"Logger credentials.","type":"object"},"description":{"description":"Logger description.","type":"string"},"isBuffered":{"description":"Whether records are buffered in the logger before publishing. Default is assumed to be true.","type":"boolean"},"loggerType":{"description":"Logger type.","enum":["azureEventHub","applicationInsights"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"LoggerType","values":[{"description":"Azure Event Hub as log destination.","value":"azureEventHub"},{"description":"Azure Application Insights as log destination.","value":"applicationInsights"}]}}}}}}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"The existing logger was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Logger"]},"put":{"description":"Creates or Updates a logger.","operationId":"Logger_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateAILogger":{"value":"rg1"},"ApiManagementCreateEHLogger":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementCreateAILogger":{"value":"apimService1"},"ApiManagementCreateEHLogger":{"value":"apimService1"}}},{"description":"Logger identifier. Must be unique in the API Management service instance.","in":"path","name":"loggerId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"},"examples":{"ApiManagementCreateAILogger":{"value":"loggerId"},"ApiManagementCreateEHLogger":{"value":"loggerId"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateAILogger":{"value":"2019-12-01-preview"},"ApiManagementCreateEHLogger":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateAILogger":{"value":"subid"},"ApiManagementCreateEHLogger":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Logger details.","properties":{"properties":{"description":"The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.","properties":{"credentials":{"additionalProperties":{"type":"string"},"description":"The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger.","example":{"connectionString":"Endpoint=sb://contoso-ns.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=...","name":"apim"},"type":"object"},"description":{"description":"Logger description.","maxLength":256,"type":"string"},"isBuffered":{"description":"Whether records are buffered in the logger before publishing. Default is assumed to be true.","type":"boolean"},"loggerType":{"description":"Logger type.","enum":["azureEventHub","applicationInsights"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"LoggerType","values":[{"description":"Azure Event Hub as log destination.","value":"azureEventHub"},{"description":"Azure Application Insights as log destination.","value":"applicationInsights"}]}},"resourceId":{"description":"Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).","type":"string"}},"required":["loggerType","credentials"]}}}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"The existing logger was successfully updated.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Logger details.","properties":{"properties":{"description":"The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.","properties":{"credentials":{"additionalProperties":{"type":"string"},"description":"The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger.","example":{"connectionString":"Endpoint=sb://contoso-ns.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=...","name":"apim"},"type":"object"},"description":{"description":"Logger description.","maxLength":256,"type":"string"},"isBuffered":{"description":"Whether records are buffered in the logger before publishing. Default is assumed to be true.","type":"boolean"},"loggerType":{"description":"Logger type.","enum":["azureEventHub","applicationInsights"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"LoggerType","values":[{"description":"Azure Event Hub as log destination.","value":"azureEventHub"},{"description":"Azure Application Insights as log destination.","value":"applicationInsights"}]}},"resourceId":{"description":"Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).","type":"string"}},"required":["loggerType","credentials"]}}},"examples":{"ApiManagementCreateAILogger":{"$ref":"#/components/examples/ApiManagementCreateAILogger"},"ApiManagementCreateEHLogger":{"$ref":"#/components/examples/ApiManagementCreateEHLogger"}}}}},"201":{"description":"Logger was successfully created.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Logger details.","properties":{"properties":{"description":"The Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs.","properties":{"credentials":{"additionalProperties":{"type":"string"},"description":"The name and SendRule connection string of the event hub for azureEventHub logger.\nInstrumentation key for applicationInsights logger.","example":{"connectionString":"Endpoint=sb://contoso-ns.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=...","name":"apim"},"type":"object"},"description":{"description":"Logger description.","maxLength":256,"type":"string"},"isBuffered":{"description":"Whether records are buffered in the logger before publishing. Default is assumed to be true.","type":"boolean"},"loggerType":{"description":"Logger type.","enum":["azureEventHub","applicationInsights"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"LoggerType","values":[{"description":"Azure Event Hub as log destination.","value":"azureEventHub"},{"description":"Azure Application Insights as log destination.","value":"applicationInsights"}]}},"resourceId":{"description":"Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).","type":"string"}},"required":["loggerType","credentials"]}}},"examples":{"ApiManagementCreateAILogger":{"$ref":"#/components/examples/ApiManagementCreateAILogger"},"ApiManagementCreateEHLogger":{"$ref":"#/components/examples/ApiManagementCreateEHLogger"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Logger"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"ApiManagementListLoggers":{"value":{"nextLink":"","value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/buffered111","name":"buffered111","properties":{"credentials":{"connectionString":"Endpoint=sb://apimaccounts.servicebus.windows.net/;SharedAccessKeyName=Send;SharedAccessKey=*******************h=****"},"description":"Sample description","isBuffered":true,"loggerType":"azureEventHub","resourceId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/apimaccounts"},"type":"Microsoft.ApiManagement/service/loggers"},{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId","name":"loggerId","properties":{"credentials":{"connectionString":"{{Logger-Credentials-59544ef2e4bbd50d9468c618}}","name":"hydraeventhub"},"description":"adding a new logger","isBuffered":true,"loggerType":"azureEventHub","resourceId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/hydraeventhub-ns"},"type":"Microsoft.ApiManagement/service/loggers"}]}},"ApiManagementGetLogger":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/kloudapilogger1","name":"kloudapilogger1","properties":{"credentials":{"connectionString":"Endpoint=sb://eventhubapim.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=************","name":"testeventhub4"},"description":"testeventhub3again","isBuffered":true,"loggerType":"azureEventHub","resourceId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/eventhubapim"},"type":"Microsoft.ApiManagement/service/loggers"}},"ApiManagementCreateAILogger":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId","name":"loggerId","properties":{"credentials":{"instrumentationKey":"{{5a.......2a}}"},"isBuffered":false,"loggerType":"applicationInsights","resourceId":"/subscriptions/subid/resourceGroups/rg1/providers/microsoft.insights/components/airesource"},"type":"Microsoft.ApiManagement/service/loggers"}},"ApiManagementCreateEHLogger":{"value":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId","name":"loggerId","properties":{"credentials":{"connectionString":"{{59544ef2e4bbd50d9468c617}}","name":"hydraeventhub"},"description":"adding a new logger","isBuffered":true,"loggerType":"azureEventHub","resourceId":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/hydraeventhub-ns"},"type":"Microsoft.ApiManagement/service/loggers"}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}}}}