Notification Channels - List

Servicio:: Dev Test Labs

Versión de la API:: 2018-09-15

Enumerar canales de notificación en un laboratorio determinado.

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

Con parámetros opcionales:

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}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
labName	path	True	string	Nombre del laboratorio.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
$expand	query		string	Especifique la consulta $expand. Ejemplo: 'properties($select=webHookUrl)'
$filter	query		string	Filtro que se va a aplicar a la operación. Ejemplo: '$filter=contains(name,'myName')
$orderby	query		string	Expresión de ordenación de los resultados, mediante notación OData. Ejemplo: '$orderby=name desc'
$top	query		integer (int32)	Número máximo de recursos que se van a devolver de la operación. Ejemplo: '$top=10'

Respuestas

Nombre	Tipo	Description
200 OK	NotificationChannelList	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

NotificationChannels_List

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
      }
    }
  ]
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Event	Evento para el que se va a recibir una notificación.
NotificationChannel	Una notificación.
NotificationChannelEventType	Tipo de evento para el que está habilitada esta notificación (es decir, AutoShutdown, Costo)
NotificationChannelList	Respuesta de una operación de lista.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Event

Objeto

Evento para el que se va a recibir una notificación.

Nombre	Tipo	Description
eventName	NotificationChannelEventType	Tipo de evento para el que está habilitada esta notificación (es decir, AutoShutdown, Costo)

NotificationChannel

Objeto

Una notificación.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Ej: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.createdDate	string (date-time)	Fecha de creación del canal de notificación.
properties.description	string	Descripción de la notificación.
properties.emailRecipient	string	El destinatario del correo electrónico al que enviar notificaciones (puede ser una lista de direcciones de correo electrónico separadas por punto y coma).
properties.events	Event[]	Lista de eventos para los que está habilitada esta notificación.
properties.notificationLocale	string	Configuración regional que se va a usar al enviar una notificación (la reserva de idiomas no admitidos es EN).
properties.provisioningState	string	Estado de aprovisionamiento del recurso.
properties.uniqueIdentifier	string	Identificador inmutable único de un recurso (Guid).
properties.webHookUrl	string	Dirección URL del webhook al que enviar notificaciones.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

NotificationChannelEventType

Enumeración

Tipo de evento para el que está habilitada esta notificación (es decir, AutoShutdown, Costo)

Valor	Description
AutoShutdown
Cost

NotificationChannelList

Objeto

Respuesta de una operación de lista.

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente de elementos
value	NotificationChannel[]	Los elementos NotificationChannel de esta página

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Notification Channels - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

NotificationChannels_List

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Event

NotificationChannel

NotificationChannelEventType

NotificationChannelList

systemData