Logger - Update
Aktualizace existující protokolovací nástroj.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2022-08-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
logger
|
path | True |
string |
Identifikátor protokolovacího nástroje. Musí být jedinečný v instanci služby API Management. Regex pattern: |
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
service
|
path | True |
string |
Název služby API Management. Regex pattern: |
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
If-Match | True |
string |
Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro bezpodmínečnou aktualizaci. |
Text požadavku
Name | Typ | Description |
---|---|---|
properties.credentials |
object |
Přihlašovací údaje protokolovacího nástroje. |
properties.description |
string |
Popis protokolovacího nástroje. |
properties.isBuffered |
boolean |
Určuje, jestli jsou záznamy v protokolovacím nástroji před publikováním uloženy do vyrovnávací paměti. Předpokládá se, že výchozí hodnota je true. |
properties.loggerType |
Typ protokolovacího nástroje. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Stávající protokolovací nástroj byl úspěšně aktualizován. Headers ETag: string |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
ApiManagementUpdateLogger
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1?api-version=2022-08-01
{
"properties": {
"loggerType": "azureEventHub",
"description": "updating description"
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
"type": "Microsoft.ApiManagement/service/loggers",
"name": "eh1",
"properties": {
"loggerType": "azureEventHub",
"description": "updating description",
"credentials": {
"connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
},
"isBuffered": true
}
}
Definice
Name | Description |
---|---|
Error |
Chyba Kontrakt pole. |
Error |
Odpověď na chybu. |
Logger |
Podrobnosti o protokolovacím nástroji |
Logger |
Typ protokolovacího nástroje. |
Logger |
Smlouva o aktualizaci protokolovacího nástroje. |
ErrorFieldContract
Chyba Kontrakt pole.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby na úrovni vlastnosti. |
message |
string |
Čitelné znázornění chyby na úrovni vlastností. |
target |
string |
Název vlastnosti. |
ErrorResponse
Odpověď na chybu.
Name | Typ | Description |
---|---|---|
error.code |
string |
Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi. |
error.details |
Seznam neplatných polí se odešle v žádosti v případě chyby ověření. |
|
error.message |
string |
Znázornění chyby čitelné pro člověka |
LoggerContract
Podrobnosti o protokolovacím nástroji
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Název prostředku |
properties.credentials |
object |
Název a SendRule připojovací řetězec centra událostí pro protokolovací nástroj azureEventHub. Instrumentační klíč pro protokolovací nástroj applicationInsights. |
properties.description |
string |
Popis protokolovacího nástroje. |
properties.isBuffered |
boolean |
Určuje, jestli jsou záznamy v protokolovacím nástroji před publikováním uloženy do vyrovnávací paměti. Předpokládá se, že výchozí hodnota je true. |
properties.loggerType |
Typ protokolovacího nástroje. |
|
properties.resourceId |
string |
ID prostředku Azure cíle protokolu (prostředek centra událostí Azure nebo prostředek Aplikace Azure Insights) |
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
LoggerType
Typ protokolovacího nástroje.
Name | Typ | Description |
---|---|---|
applicationInsights |
string |
Aplikace Azure Insights jako cíl protokolu. |
azureEventHub |
string |
Azure Event Hub jako cíl protokolu. |
azureMonitor |
string |
Azure Monitor |
LoggerUpdateContract
Smlouva o aktualizaci protokolovacího nástroje.
Name | Typ | Description |
---|---|---|
properties.credentials |
object |
Přihlašovací údaje protokolovacího nástroje. |
properties.description |
string |
Popis protokolovacího nástroje. |
properties.isBuffered |
boolean |
Určuje, jestli jsou záznamy v protokolovacím nástroji před publikováním uloženy do vyrovnávací paměti. Předpokládá se, že výchozí hodnota je true. |
properties.loggerType |
Typ protokolovacího nástroje. |