Notification Channels - List

Hizmet:: Dev Test Labs

API Sürümü:: 2018-09-15

Belirli bir laboratuvardaki bildirim kanallarını listeleme.

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

İsteğe bağlı parametrelerle:

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
labName	path	True	string	Laboratuvarın adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
$expand	query		string	$expand sorgusunu belirtin. Örnek: 'properties($select=webHookUrl)'
$filter	query		string	İşleme uygulanacak filtre. Örnek: '$filter=contains(name,'myName')
$orderby	query		string	OData gösterimi kullanılarak sonuçların sıralama ifadesi. Örnek: '$orderby=name desc'
$top	query		integer (int32)	İşlemden döndürülecek en fazla kaynak sayısı. Örnek: '$top=10'

Yanıtlar

Name	Tür	Description
200 OK	NotificationChannelList	Azure işlemi başarıyla tamamlandı.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

NotificationChannels_List

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 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"
      }
    }
  ]
}

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
Event	Bildirim alınması gereken bir olay.
NotificationChannel	Bir bildirim.
NotificationChannelEventType	Bu bildirimin etkinleştirildiği olay türü (örneğin, AutoShutdown, Maliyet)
NotificationChannelList	Liste işleminin yanıtı.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Numaralandırma

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

Event

Nesne

Bildirim alınması gereken bir olay.

Name	Tür	Description
eventName	NotificationChannelEventType	Bu bildirimin etkinleştirildiği olay türü (örneğin, AutoShutdown, Maliyet)

NotificationChannel

Nesne

Bir bildirim.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Kaynağın bulunduğu coğrafi konum
name	string	Kaynağın adı
properties.createdDate	string (date-time)	Bildirim kanalının oluşturulma tarihi.
properties.description	string	Bildirim açıklaması.
properties.emailRecipient	string	Bildirimlerin gönderileceği e-posta alıcısı (noktalı virgülle ayrılmış e-posta adreslerinin listesi olabilir).
properties.events	Event[]	Bu bildirimin etkinleştirildiği olayın listesi.
properties.notificationLocale	string	Bildirim gönderirken kullanılacak yerel ayar (desteklenmeyen diller için geri dönüş EN'dir).
properties.provisioningState	string	Kaynağın sağlama durumu.
properties.uniqueIdentifier	string	Kaynağın benzersiz sabit tanımlayıcısı (Guid).
properties.webHookUrl	string	Bildirim göndermek için web kancası URL'si.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
tags	object	Kaynak etiketleri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

NotificationChannelEventType

Numaralandırma

Bu bildirimin etkinleştirildiği olay türü (örneğin, AutoShutdown, Maliyet)

Değer	Description
AutoShutdown
Cost

NotificationChannelList

Nesne

Liste işleminin yanıtı.

Name	Tür	Description
nextLink	string (uri)	Öğelerin sonraki sayfasına bağlantı
value	NotificationChannel[]	Bu sayfadaki NotificationChannel öğeleri

systemData

Nesne

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

Aracılığıyla paylaş

Notification Channels - List

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

NotificationChannels_List

Örnek isteği

Örnek yanıt

Tanımlar

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Event

NotificationChannel

NotificationChannelEventType

NotificationChannelList

systemData