Udostępnij za pośrednictwem

Logger - Create Or Update

  • Odwołanie
Usługa:
API Management
Wersja interfejsu API:
2024-05-01

Tworzy lub aktualizuje rejestrator.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2024-05-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
loggerId
 path True

string

maxLength: 256
pattern: ^[^*#&+:<>?]+$

Identyfikator rejestratora. Musi być unikatowa w wystąpieniu usługi API Management.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nazwa usługi API Management.
subscriptionId
 path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-Match

string

Element ETag jednostki. Nie jest to wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki.

Treść żądania

Nazwa Wymagane Typ Opis
properties.loggerType True

LoggerType

Typ rejestratora.
properties.credentials

object

Nazwy i parametry połączenia SendRule centrum zdarzeń dla rejestratora azureEventHub. Klucz instrumentacji dla rejestratora applicationInsights.
properties.description

string

maxLength: 256

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 docelowego dziennika (zasób usługi Azure Event Hub lub zasób usługi Azure Application Insights).

Odpowiedzi

Nazwa Typ Opis
200 OK

LoggerContract

Istniejący rejestrator został pomyślnie zaktualizowany.

Nagłówki

ETag: string
201 Created

LoggerContract

Rejestrator został pomyślnie utworzony.

Nagłówki

ETag: string
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementCreateAILogger
ApiManagementCreateEHLogger

ApiManagementCreateAILogger

Przykładowe żądanie

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId?api-version=2024-05-01

{
  "properties": {
    "loggerType": "applicationInsights",
    "description": "adding a new logger",
    "credentials": {
      "instrumentationKey": "11................a1"
    }
  }
}

Przykładowa odpowiedź

Kod stanu:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource"
  }
}
Kod stanu:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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

Przykładowe żądanie

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1?api-version=2024-05-01

{
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "name": "hydraeventhub",
      "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********="
    }
  }
}

Przykładowa odpowiedź

Kod stanu:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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
  }
}
Kod stanu:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
LoggerContract

Szczegóły rejestratora.
LoggerType

Typ rejestratora.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

LoggerContract

Objekt

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

Nazwy i parametry połączenia SendRule centrum zdarzeń dla rejestratora azureEventHub. Klucz instrumentacji dla rejestratora applicationInsights.
properties.description

string

maxLength: 256

Opis rejestratora.
properties.isBuffered

boolean

Czy rekordy są buforowane w rejestratorze przed opublikowaniem. Przyjmuje się, że wartość domyślna to true.
properties.loggerType

LoggerType

Typ rejestratora.
properties.resourceId

string

Identyfikator zasobu platformy Azure docelowego dziennika (zasób usługi Azure Event Hub lub zasób usługi Azure Application Insights).
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

LoggerType

Wyliczanie

Typ rejestratora.

Wartość Opis
applicationInsights

Usługa Azure Application Insights jako miejsce docelowe dziennika.
azureEventHub

Usługa Azure Event Hub jako miejsce docelowe dziennika.
azureMonitor

Azure Monitor