Notification Channels - Get

Serviço:

Dev Test Labs

Versão da API:

2018-09-15

Obter o canal de notificação.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
labName	path	True	string	O nome do laboratório.
name	path	True	string	O nome do canal de notificações.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$expand	query		string	Especifique a consulta $expand. Exemplo: 'properties($select=webHookUrl)'

Respostas

Nome	Tipo	Description
200 OK	NotificationChannel	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

NotificationChannels_Get

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
Event	Um evento para o qual ser notificado.
NotificationChannel	Uma notificação.
NotificationChannelEventType	O tipo de evento para o qual essa notificação está habilitada (ou seja, AutoShutdown, Custo)
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Event

Objeto

Um evento para o qual ser notificado.

Nome	Tipo	Description
eventName	NotificationChannelEventType	O tipo de evento para o qual essa notificação está habilitada (ou seja, AutoShutdown, Custo)

NotificationChannel

Objeto

Uma notificação.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.createdDate	string (date-time)	A data de criação do canal de notificação.
properties.description	string	Descrição da notificação.
properties.emailRecipient	string	O destinatário de email para o qual enviar notificações (pode ser uma lista de endereços de email separados por ponto e vírgula).
properties.events	Event[]	A lista de eventos para o qual essa notificação está habilitada.
properties.notificationLocale	string	A localidade a ser usada ao enviar uma notificação (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 a qual enviar notificações.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

NotificationChannelEventType

Enumeração

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

Valor	Description
AutoShutdown
Cost

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.