Logger - Create Or Update
Cria ou Atualizações um logger.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2022-08-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
logger
|
path | True |
string |
Identificador de logger. Tem de ser exclusivo na instância do serviço Gestão de API. Padrão Regex: |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas. |
service
|
path | True |
string |
O nome do serviço Gestão de API. Padrão Regex: |
subscription
|
path | True |
string |
O ID da subscrição de destino. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
If-Match |
string |
ETag da Entidade. Não é necessário ao criar uma entidade, mas é necessário ao atualizar uma entidade. |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
properties.loggerType | True |
Tipo de logger. |
|
properties.credentials |
object |
O nome e SendRule cadeia de ligação do hub de eventos do logger azureEventHub. Chave de instrumentação para o logger applicationInsights. |
|
properties.description |
string |
Descrição do logger. |
|
properties.isBuffered |
boolean |
Se os registos são colocados na memória intermédia no logger antes da publicação. Assume-se que a predefinição é verdadeira. |
|
properties.resourceId |
string |
ID de Recurso do Azure de um destino de registo (recurso do Hub de Eventos do Azure ou recurso do Aplicação Azure Insights). |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
O logger existente foi atualizado com êxito. Cabeçalhos ETag: string |
|
201 Created |
O logger foi criado com êxito. Cabeçalhos ETag: string |
|
Other Status Codes |
Resposta de erro que descreve o motivo pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
Api |
Api |
ApiManagementCreateAILogger
Pedido de amostra
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId?api-version=2022-08-01
{
"properties": {
"loggerType": "applicationInsights",
"description": "adding a new logger",
"credentials": {
"instrumentationKey": "11................a1"
}
}
}
Resposta da amostra
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "loggerId",
"properties": {
"loggerType": "applicationInsights",
"description": null,
"credentials": {
"instrumentationKey": "{{5a.......2a}}"
},
"isBuffered": false,
"resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/microsoft.insights/components/airesource"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "loggerId",
"properties": {
"loggerType": "applicationInsights",
"description": null,
"credentials": {
"instrumentationKey": "{{5a.......2a}}"
},
"isBuffered": false
}
}
ApiManagementCreateEHLogger
Pedido de amostra
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1?api-version=2022-08-01
{
"properties": {
"loggerType": "azureEventHub",
"description": "adding a new logger",
"credentials": {
"name": "hydraeventhub",
"connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********="
}
}
}
Resposta da amostra
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "eh1",
"properties": {
"loggerType": "azureEventHub",
"description": "adding a new logger",
"credentials": {
"connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
},
"isBuffered": true
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "eh1",
"properties": {
"loggerType": "azureEventHub",
"description": "adding a new logger",
"credentials": {
"connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
},
"isBuffered": true
}
}
Definições
Name | Description |
---|---|
Error |
Contrato de Campo de Erro. |
Error |
Resposta do Erro. |
Logger |
Detalhes do logger. |
Logger |
Tipo de logger. |
ErrorFieldContract
Contrato de Campo de Erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro de nível de propriedade. |
message |
string |
Representação legível por humanos do erro ao nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta do Erro.
Name | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados no pedido, em caso de erro de validação. |
|
error.message |
string |
Representação legível por humanos do erro. |
LoggerContract
Detalhes do logger.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
O nome do recurso |
properties.credentials |
object |
O nome e SendRule cadeia de ligação do hub de eventos do logger azureEventHub. Chave de instrumentação para o logger applicationInsights. |
properties.description |
string |
Descrição do logger. |
properties.isBuffered |
boolean |
Se os registos são colocados na memória intermédia no logger antes da publicação. Assume-se que a predefinição é verdadeira. |
properties.loggerType |
Tipo de logger. |
|
properties.resourceId |
string |
ID de Recurso do Azure de um destino de registo (recurso do Hub de Eventos do Azure ou recurso do Aplicação Azure Insights). |
type |
string |
O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
LoggerType
Tipo de logger.
Name | Tipo | Description |
---|---|---|
applicationInsights |
string |
Aplicação Azure Informações como destino de registo. |
azureEventHub |
string |
Hub de Eventos do Azure como destino de registo. |
azureMonitor |
string |
Azure Monitor |