Freigeben über

Workspace Logger - Create Or Update

  • Referenz
Dienst:
API Management
API-Version:
2024-05-01

Erstellt oder aktualisiert einen Logger.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
loggerId
 path True

string

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

Logger-ID. Muss in der API-Verwaltungsdienstinstanz eindeutig sein.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName
 path True

string

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

Der Name des API-Verwaltungsdiensts.
subscriptionId
 path True

string (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceId
 path True

string

minLength: 1
maxLength: 80
pattern: ^[^*#&+:<>?]+$

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match

string

ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich.

Anforderungstext

Name Erforderlich Typ Beschreibung
properties.loggerType True

LoggerType

Loggertyp.
properties.credentials

object

Der Name und die SendRule-Verbindungszeichenfolge des Event Hubs für azureEventHub-Logger. Instrumentation key for applicationInsights logger.
properties.description

string

maxLength: 256

Loggerbeschreibung.
properties.isBuffered

boolean

Gibt an, ob Datensätze vor der Veröffentlichung im Logger gepuffert werden. Der Standardwert wird als wahr angenommen.
properties.resourceId

string

Azure-Ressourcen-ID eines Protokollziels (entweder Azure Event Hub-Ressource oder Azure Application Insights-Ressource).

Antworten

Name Typ Beschreibung
200 OK

LoggerContract

Der vorhandene Logger wurde erfolgreich aktualisiert.

Header

ETag: string
201 Created

LoggerContract

Logger wurde erfolgreich erstellt.

Header

ETag: string
Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementCreateWorkspaceAILogger
ApiManagementCreateWorkspaceEHLogger

ApiManagementCreateWorkspaceAILogger

Beispielanforderung

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

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

Beispiel für eine Antwort

Statuscode:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/workspaces/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"
  }
}
Statuscode:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/workspaces/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "applicationInsights",
    "description": null,
    "credentials": {
      "instrumentationKey": "{{5a.......2a}}"
    },
    "isBuffered": false
  }
}

ApiManagementCreateWorkspaceEHLogger

Beispielanforderung

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/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=********="
    }
  }
}

Beispiel für eine Antwort

Statuscode:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1",
  "type": "Microsoft.ApiManagement/service/workspaces/loggers",
  "name": "eh1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
    },
    "isBuffered": true
  }
}
Statuscode:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/eh1",
  "type": "Microsoft.ApiManagement/service/workspaces/loggers",
  "name": "eh1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
    },
    "isBuffered": true
  }
}

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort
LoggerContract

Loggerdetails.
LoggerType

Loggertyp.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

LoggerContract

Objekt

Loggerdetails.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Der Name der Ressource
properties.credentials

object

Der Name und die SendRule-Verbindungszeichenfolge des Event Hubs für azureEventHub-Logger. Instrumentation key for applicationInsights logger.
properties.description

string

maxLength: 256

Loggerbeschreibung.
properties.isBuffered

boolean

Gibt an, ob Datensätze vor der Veröffentlichung im Logger gepuffert werden. Der Standardwert wird als wahr angenommen.
properties.loggerType

LoggerType

Loggertyp.
properties.resourceId

string

Azure-Ressourcen-ID eines Protokollziels (entweder Azure Event Hub-Ressource oder Azure Application Insights-Ressource).
type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

LoggerType

Enumeration

Loggertyp.

Wert Beschreibung
applicationInsights

Azure Application Insights als Protokollziel.
azureEventHub

Azure Event Hub als Protokollziel.
azureMonitor

Azure Monitor