Logger - Create Or Update
Tworzy lub Aktualizacje rejestratora.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2022-08-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
logger
|
path | True |
string |
Identyfikator rejestratora. Musi być unikatowa w wystąpieniu usługi API Management. Regex pattern: |
resource
|
path | True |
string |
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. |
service
|
path | True |
string |
Nazwa usługi API Management. Regex pattern: |
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Nagłówek żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
If-Match |
string |
ETag jednostki. Nie jest wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
properties.loggerType | True |
Typ rejestratora. |
|
properties.credentials |
object |
Nazwa i parametry połączenia SendRule centrum zdarzeń dla rejestratora azureEventHub. Klucz instrumentacji dla rejestratora applicationInsights. |
|
properties.description |
string |
Opis rejestratora. |
|
properties.isBuffered |
boolean |
Czy rekordy są buforowane w rejestratorze przed opublikowaniem. Przyjmuje się, że wartość domyślna to true. |
|
properties.resourceId |
string |
Identyfikator zasobu platformy Azure miejsca docelowego dziennika (zasób usługi Azure Event Hub lub zasób aplikacja systemu Azure Insights). |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Istniejący rejestrator został pomyślnie zaktualizowany. Headers ETag: string |
|
201 Created |
Rejestrator został pomyślnie utworzony. Headers ETag: string |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
Api |
Api |
ApiManagementCreateAILogger
Sample Request
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"
}
}
}
Sample Response
{
"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
Sample Request
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=********="
}
}
}
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": "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
}
}
Definicje
Nazwa | Opis |
---|---|
Error |
Błąd Kontrakt pola. |
Error |
Odpowiedź na błąd. |
Logger |
Szczegóły rejestratora. |
Logger |
Typ rejestratora. |
ErrorFieldContract
Błąd Kontrakt pola.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu poziomu właściwości. |
message |
string |
Czytelna dla człowieka reprezentacja błędu na poziomie właściwości. |
target |
string |
Nazwa właściwości. |
ErrorResponse
Odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
error.code |
string |
Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi. |
error.details |
Lista nieprawidłowych pól jest wysyłana w żądaniu w przypadku błędu walidacji. |
|
error.message |
string |
Czytelna dla człowieka reprezentacja błędu. |
LoggerContract
Szczegóły rejestratora.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nazwa zasobu |
properties.credentials |
object |
Nazwa i parametry połączenia SendRule centrum zdarzeń dla rejestratora azureEventHub. Klucz instrumentacji dla rejestratora applicationInsights. |
properties.description |
string |
Opis rejestratora. |
properties.isBuffered |
boolean |
Czy rekordy są buforowane w rejestratorze przed opublikowaniem. Przyjmuje się, że wartość domyślna to true. |
properties.loggerType |
Typ rejestratora. |
|
properties.resourceId |
string |
Identyfikator zasobu platformy Azure miejsca docelowego dziennika (zasób usługi Azure Event Hub lub zasób aplikacja systemu Azure Insights). |
type |
string |
Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" |
LoggerType
Typ rejestratora.
Nazwa | Typ | Opis |
---|---|---|
applicationInsights |
string |
aplikacja systemu Azure Insights jako miejsce docelowe dziennika. |
azureEventHub |
string |
Usługa Azure Event Hub jako miejsce docelowe dziennika. |
azureMonitor |
string |
Azure Monitor |