Notification Channels - List

Listar canais de notificação em um determinado laboratório.

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

Parâmetros de URI

Name In Required Type Description
labName
path True
  • string

O nome do lab.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

subscriptionId
path True
  • string

A ID da assinatura.

api-version
query True
  • string

Versão de API do cliente.

$expand
query
  • string

Especifique $expand consulta. Exemplo: 'properties($select=webHookUrl)'

$filter
query
  • string

O filtro a ser aplicado à operação. Exemplo: '$filter=contains(name,'myName')

$orderby
query
  • string

A expressão de ordenação para os resultados, usando a notação OData. Exemplo: '$orderby=name desc'

$top
query
  • integer
int32

O número máximo de recursos a retornar da operação. Exemplo: '$top=10'

Respostas

Name Type Description
200 OK

OK

Other Status Codes

BadRequest

Segurança

azure_auth

Concessão implícita OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Acesso Microsoft Azure

Exemplos

NotificationChannels_List

Sample Request

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

Sample Response

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

Definições

CloudError

Erro de uma solicitação REST.

CloudErrorBody

Corpo de um erro de uma solicitação REST.

Event

Um evento a ser notificado.

NotificationChannel

Uma notificação.

NotificationChannelEventType

O tipo de evento para o qual essa notificação está habilitada (ou seja, AutoShutdown, Cost)

NotificationChannelList

A resposta de uma operação de lista.

CloudError

Erro de uma solicitação REST.

Name Type Description
error

O erro de nuvem que ocorreu

CloudErrorBody

Corpo de um erro de uma solicitação REST.

Name Type Description
code
  • string

O código de erro.

details

Erros internos.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro.

Event

Um evento a ser notificado.

Name Type Description
eventName

O tipo de evento para o qual essa notificação está habilitada (ou seja, AutoShutdown, Cost)

NotificationChannel

Uma notificação.

Name Type Description
id
  • string

O identificador do recurso.

location
  • string

A localização do recurso.

name
  • string

O nome do recurso.

properties.createdDate
  • string

A data de criação do canal de notificação.

properties.description
  • string

Descrição da notificação.

properties.emailRecipient
  • string

O destinatário do email para o que enviar notificações (pode ser uma lista de endereços de email separados por pontos e vírgulas).

properties.events

A lista de eventos para os quais essa notificação está habilitada.

properties.notificationLocale
  • string

A localidade a ser usada ao enviar uma notificação (fallback para idiomas sem suporte é EN).

properties.provisioningState
  • string

O status de provisionamento do recurso.

properties.uniqueIdentifier
  • string

O identificador imutável exclusivo de um recurso (Guid).

properties.webHookUrl
  • string

A URL do webhook para o que enviar notificações.

tags
  • object

As marcas do recurso.

type
  • string

Tipo do recurso.

NotificationChannelEventType

O tipo de evento para o qual essa notificação está habilitada (ou seja, AutoShutdown, Cost)

Name Type Description
AutoShutdown
  • string
Cost
  • string

NotificationChannelList

A resposta de uma operação de lista.

Name Type Description
nextLink
  • string

Link para o próximo conjunto de resultados.

value

Resultados da operação de lista.