Notification Channels - List

Tjänst:: Dev Test Labs

API-versionen:: 2018-09-15

Lista meddelandekanaler i ett visst labb.

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

Med valfria parametrar:

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
labName	path	True	string	Namnet på labbet.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
$expand	query		string	Ange frågan $expand. Exempel: "properties($select=webHookUrl)"
$filter	query		string	Filtret som ska tillämpas på åtgärden. Exempel: '$filter=contains(name,'myName')
$orderby	query		string	Orderuttrycket för resultaten med OData-notation. Exempel: "$orderby=name desc"
$top	query		integer (int32)	Det maximala antalet resurser som ska returneras från åtgärden. Exempel: "$top=10"

Svaren

Namn	Typ	Beskrivning
200 OK	NotificationChannelList	Azure-åtgärden har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	personifiera ditt användarkonto

Exempel

NotificationChannels_List

Exempelförfrågan

HTTP

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

Exempelsvar

Statuskod:: 200

{
  "value": [
    {
      "name": "autoshutdown",
      "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:12:10.6566371+00:00",
        "emailRecipient": "{email}",
        "events": [
          {
            "eventName": "AutoShutdown"
          }
        ],
        "notificationLocale": "en",
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}",
        "webHookUrl": "{webhookUrl}"
      },
      "tags": {
        "tagName1": "tagValue1"
      }
    },
    {
      "name": "costThreshold",
      "type": "Microsoft.DevTestLab/labs/notificationChannels",
      "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/notificationChannels/{notificationChannelName}",
      "location": "{location}",
      "properties": {
        "description": "Integration configured for cost",
        "createdDate": "2021-01-05T02:14:05.2392034+00:00",
        "events": [
          {
            "eventName": "Cost"
          }
        ],
        "notificationLocale": "en",
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}",
        "webHookUrl": "{webhookUrl}"
      },
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Definitioner

Namn	Beskrivning
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
Event	En händelse som ska meddelas om.
NotificationChannel	Ett meddelande.
NotificationChannelEventType	Händelsetypen som det här meddelandet är aktiverat för (t.ex. AutoShutdown, Cost)
NotificationChannelList	Svaret från en liståtgärd.
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Beskrivning
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Namn	Typ	Beskrivning
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Namn	Typ	Beskrivning
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Namn	Typ	Beskrivning
error	ErrorDetail	Felobjektet.

Event

Objekt

En händelse som ska meddelas om.

Namn	Typ	Beskrivning
eventName	NotificationChannelEventType	Händelsetypen som det här meddelandet är aktiverat för (t.ex. AutoShutdown, Cost)

NotificationChannel

Objekt

Ett meddelande.

Namn	Typ	Beskrivning
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Den geografiska plats där resursen finns
name	string	Namnet på resursen
properties.createdDate	string (date-time)	Meddelandekanalens skapandedatum.
properties.description	string	Beskrivning av meddelandet.
properties.emailRecipient	string	E-postmottagaren som ska skicka meddelanden till (kan vara en lista över semikolonavgränsade e-postadresser).
properties.events	Event[]	Listan över händelser som det här meddelandet är aktiverat för.
properties.notificationLocale	string	Språkvarianten som ska användas när du skickar ett meddelande (återställning för språk som inte stöds är EN).
properties.provisioningState	string	Resursens etableringsstatus.
properties.uniqueIdentifier	string	Den unika oföränderliga identifieraren för en resurs (Guid).
properties.webHookUrl	string	Webhook-URL:en som du vill skicka meddelanden till.
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object	Resursetiketter.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

NotificationChannelEventType

Uppräkning

Händelsetypen som det här meddelandet är aktiverat för (t.ex. AutoShutdown, Cost)

Värde	Beskrivning
AutoShutdown
Cost

NotificationChannelList

Objekt

Svaret från en liståtgärd.

Namn	Typ	Beskrivning
nextLink	string (uri)	Länken till nästa sida med objekt
value	NotificationChannel[]	NotificationChannel-objekten på den här sidan

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Namn	Typ	Beskrivning
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Dela via

Notification Channels - List

URI-parametrar

Svaren

Säkerhet

azure_auth

Scope

Exempel

NotificationChannels_List

Exempelförfrågan

Exempelsvar

Definitioner

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Event

NotificationChannel

NotificationChannelEventType

NotificationChannelList

systemData