Notification Channels - List

Služba:: Dev Test Labs

Verze rozhraní API:: 2018-09-15

Vypište kanály oznámení v daném testovacím prostředí.

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

S volitelnými parametry:

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
labName	path	True	string	Název testovacího prostředí.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$expand	query		string	Zadejte dotaz $expand. Příklad: 'properties($select=webHookUrl)'
$filter	query		string	Filtr, který se má použít pro operaci. Příklad: '$filter=contains(name;'myName')
$orderby	query		string	Výraz řazení výsledků pomocí notace OData. Příklad: '$orderby=name desc'
$top	query		integer (int32)	Maximální počet prostředků, které se mají vrátit z operace. Příklad: '$top=10'

Odpovědi

Name	Typ	Description
200 OK	NotificationChannelList	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

NotificationChannels_List

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
      }
    }
  ]
}

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
Event	Událost, ke které se má upozornit.
NotificationChannel	Oznámení.
NotificationChannelEventType	Typ události, pro kterou je toto oznámení povolené (tj. Automatické přehánění, náklady)
NotificationChannelList	Odpověď operace seznamu.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Event

Objekt

Událost, ke které se má upozornit.

Name	Typ	Description
eventName	NotificationChannelEventType	Typ události, pro kterou je toto oznámení povolené (tj. Automatické přehánění, náklady)

NotificationChannel

Objekt

Oznámení.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografická poloha, kde se prostředek nachází
name	string	Název prostředku
properties.createdDate	string (date-time)	Datum vytvoření kanálu oznámení.
properties.description	string	Popis oznámení
properties.emailRecipient	string	Příjemce e-mailu, na který se mají odesílat oznámení (může to být seznam středník oddělených e-mailových adres).
properties.events	Event[]	Seznam událostí, pro kterou je toto oznámení povoleno.
properties.notificationLocale	string	Národní prostředí, které se má použít při odesílání oznámení (záložní pro nepodporované jazyky je EN).
properties.provisioningState	string	Stav zřizování prostředku.
properties.uniqueIdentifier	string	Jedinečný neměnný identifikátor prostředku (GUID).
properties.webHookUrl	string	Adresa URL webhooku pro odesílání oznámení.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředků
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

NotificationChannelEventType

Výčet

Typ události, pro kterou je toto oznámení povolené (tj. Automatické přehánění, náklady)

Hodnota	Description
AutoShutdown
Cost

NotificationChannelList

Objekt

Odpověď operace seznamu.

Name	Typ	Description
nextLink	string (uri)	Odkaz na další stránku položek
value	NotificationChannel[]	Položky NotificationChannel na této stránce

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Sdílet prostřednictvím

Notification Channels - List

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

NotificationChannels_List

Ukázkový požadavek

Ukázková odpověď

Definice

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Event

NotificationChannel

NotificationChannelEventType

NotificationChannelList

systemData