Notification Channels - Get

Dienst:: Dev Test Labs

API-Version:: 2018-09-15

Benachrichtigungskanal abrufen.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}?api-version=2018-09-15

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}?api-version=2018-09-15&$expand={$expand}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
labName	path	True	string	Der Name des Labors.
name	path	True	string	Der Name des Benachrichtigungskanals.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$expand	query		string	Geben Sie die $expand Abfrage an. Beispiel: "properties($select=webHookUrl)"

Antworten

Name	Typ	Beschreibung
200 OK	NotificationChannel	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

NotificationChannels_Get

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{notificationChannelName}?api-version=2018-09-15

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "{notificationChannelName}",
  "type": "Microsoft.DevTestLab/labs/notificationChannels",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/notificationChannels/{notificationChannelName}",
  "location": "{location}",
  "properties": {
    "description": "Integration configured for auto-shutdown",
    "createdDate": "2021-01-05T02:14:05.2392034+00:00",
    "emailRecipient": "{email}",
    "events": [
      {
        "eventName": "AutoShutdown"
      }
    ],
    "notificationLocale": "en",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{uniqueIdentifier}",
    "webHookUrl": "{webhookUrl}"
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
Event	Ein Ereignis, für das benachrichtigt werden soll.
NotificationChannel	Eine Benachrichtigung.
NotificationChannelEventType	Der Ereignistyp, für den diese Benachrichtigung aktiviert ist (d. h. AutoShutdown, Kosten)
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

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.

Event

Objekt

Ein Ereignis, für das benachrichtigt werden soll.

Name	Typ	Beschreibung
eventName	NotificationChannelEventType	Der Ereignistyp, für den diese Benachrichtigung aktiviert ist (d. h. AutoShutdown, Kosten)

NotificationChannel

Objekt

Eine Benachrichtigung.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Zum Beispiel - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.createdDate	string (date-time)	Das Erstellungsdatum des Benachrichtigungskanals.
properties.description	string	Beschreibung der Benachrichtigung.
properties.emailRecipient	string	Der E-Mail-Empfänger, an den Benachrichtigungen gesendet werden sollen (kann eine Liste von durch Semikolons getrennten E-Mail-Adressen sein).
properties.events	Event[]	Die Liste des Ereignisses, für das diese Benachrichtigung aktiviert ist.
properties.notificationLocale	string	Das Gebietsschema, das beim Senden einer Benachrichtigung verwendet werden soll (Fallback für nicht unterstützte Sprachen ist EN).
properties.provisioningState	string	Der Bereitstellungsstatus der Ressource.
properties.uniqueIdentifier	string	Der eindeutige unveränderliche Bezeichner einer Ressource (GUID).
properties.webHookUrl	string	Die Webhook-URL zum Senden von Benachrichtigungen an.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

NotificationChannelEventType

Enumeration

Der Ereignistyp, für den diese Benachrichtigung aktiviert ist (d. h. AutoShutdown, Kosten)

Wert	Beschreibung
AutoShutdown
Cost

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.