Notification Channels - Get

Usługa:

Dev Test Labs

Wersja API:

2018-09-15

Uzyskaj kanał powiadomień.

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

Z opcjonalnymi parametrami:

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
labName	path	True	string	Nazwa laboratorium.
name	path	True	string	Nazwa kanału powiadomień.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.
$expand	query		string	Określ zapytanie $expand. Przykład: "properties($select=webHookUrl)"

Odpowiedzi

Nazwa	Typ	Opis
200 OK	NotificationChannel	Operacja platformy Azure została ukończona pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

NotificationChannels_Get

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:

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"
  }
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
Event	Zdarzenie, dla których ma zostać powiadomione.
NotificationChannel	Powiadomienie.
NotificationChannelEventType	Typ zdarzenia, dla którego to powiadomienie jest włączone (tj. AutoShutdown, Cost)
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Sprzeciwiać się

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

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Sprzeciwiać się

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

Sprzeciwiać się

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Event

Sprzeciwiać się

Zdarzenie, dla których ma zostać powiadomione.

Nazwa	Typ	Opis
eventName	NotificationChannelEventType	Typ zdarzenia, dla którego to powiadomienie jest włączone (tj. AutoShutdown, Cost)

NotificationChannel

Sprzeciwiać się

Powiadomienie.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.createdDate	string (date-time)	Data utworzenia kanału powiadomień.
properties.description	string	Opis powiadomienia.
properties.emailRecipient	string	Adresat wiadomości e-mail do wysyłania powiadomień (może być listą adresów e-mail rozdzielonych średnikami).
properties.events	Event[]	Lista zdarzeń, dla których to powiadomienie jest włączone.
properties.notificationLocale	string	Ustawienia regionalne do użycia podczas wysyłania powiadomienia (rezerwowe dla nieobsługiwanych języków to EN).
properties.provisioningState	string	Stan aprowizacji zasobu.
properties.uniqueIdentifier	string	Unikatowy niezmienny identyfikator zasobu (Guid).
properties.webHookUrl	string	Adres URL elementu webhook do wysyłania powiadomień.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

NotificationChannelEventType

Wyliczenie

Typ zdarzenia, dla którego to powiadomienie jest włączone (tj. AutoShutdown, Cost)

Wartość	Opis
AutoShutdown
Cost

systemData

Sprzeciwiać się

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.