Package-level declarations

Types

Link copied to clipboard
data class AdmCredentialResponse(val authTokenUrl: String, val clientId: String, val clientSecret: String)

Description of a NotificationHub AdmCredential.

Link copied to clipboard
data class ApnsCredentialResponse(val apnsCertificate: String? = null, val appId: String? = null, val appName: String? = null, val certificateKey: String? = null, val endpoint: String, val keyId: String? = null, val thumbprint: String? = null, val token: String? = null)

Description of a NotificationHub ApnsCredential.

Link copied to clipboard
data class BaiduCredentialResponse(val baiduApiKey: String, val baiduEndPoint: String, val baiduSecretKey: String)

Description of a NotificationHub BaiduCredential.

Link copied to clipboard
data class BrowserCredentialResponse(val subject: String, val vapidPrivateKey: String, val vapidPublicKey: String)

Description of a NotificationHub BrowserCredential.

Link copied to clipboard
data class FcmV1CredentialResponse(val clientEmail: String, val privateKey: String, val projectId: String)

Description of a NotificationHub FcmV1Credential.

Link copied to clipboard
data class GcmCredentialResponse(val gcmEndpoint: String? = null, val googleApiKey: String)

Description of a NotificationHub GcmCredential.

Link copied to clipboard
data class GetNamespaceAuthorizationRuleResult(val azureApiVersion: String, val claimType: String, val claimValue: String, val createdTime: String, val id: String, val keyName: String, val location: String? = null, val modifiedTime: String, val name: String, val primaryKey: String? = null, val revision: Int, val rights: List<String>, val secondaryKey: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Response for POST requests that return single SharedAccessAuthorizationRule.

Link copied to clipboard
data class GetNamespacePnsCredentialsResult(val admCredential: AdmCredentialResponse? = null, val apnsCredential: ApnsCredentialResponse? = null, val baiduCredential: BaiduCredentialResponse? = null, val browserCredential: BrowserCredentialResponse? = null, val fcmV1Credential: FcmV1CredentialResponse? = null, val gcmCredential: GcmCredentialResponse? = null, val id: String, val location: String? = null, val mpnsCredential: MpnsCredentialResponse? = null, val name: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val wnsCredential: WnsCredentialResponse? = null, val xiaomiCredential: XiaomiCredentialResponse? = null)

Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs PNS credentials.

Link copied to clipboard
data class GetNamespaceResult(val azureApiVersion: String, val createdAt: String, val critical: Boolean, val dataCenter: String? = null, val enabled: Boolean, val id: String, val location: String, val metricId: String, val name: String, val namespaceType: String? = null, val networkAcls: NetworkAclsResponse? = null, val pnsCredentials: PnsCredentialsResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResourceResponse>, val provisioningState: String? = null, val publicNetworkAccess: String? = null, val region: String, val replicationRegion: String? = null, val scaleUnit: String? = null, val serviceBusEndpoint: String, val sku: SkuResponse, val status: String? = null, val subscriptionId: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val updatedAt: String, val zoneRedundancy: String? = null)

Notification Hubs Namespace Resource.

data class GetNotificationHubAuthorizationRuleResult(val azureApiVersion: String, val claimType: String, val claimValue: String, val createdTime: String, val id: String, val keyName: String, val location: String? = null, val modifiedTime: String, val name: String, val primaryKey: String? = null, val revision: Int, val rights: List<String>, val secondaryKey: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Response for POST requests that return single SharedAccessAuthorizationRule.

Link copied to clipboard
data class GetNotificationHubPnsCredentialsResult(val admCredential: AdmCredentialResponse? = null, val apnsCredential: ApnsCredentialResponse? = null, val baiduCredential: BaiduCredentialResponse? = null, val browserCredential: BrowserCredentialResponse? = null, val fcmV1Credential: FcmV1CredentialResponse? = null, val gcmCredential: GcmCredentialResponse? = null, val id: String, val location: String? = null, val mpnsCredential: MpnsCredentialResponse? = null, val name: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val wnsCredential: WnsCredentialResponse? = null, val xiaomiCredential: XiaomiCredentialResponse? = null)

Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs PNS credentials.

Link copied to clipboard
data class GetNotificationHubResult(val admCredential: AdmCredentialResponse? = null, val apnsCredential: ApnsCredentialResponse? = null, val authorizationRules: List<SharedAccessAuthorizationRulePropertiesResponse>, val azureApiVersion: String, val baiduCredential: BaiduCredentialResponse? = null, val browserCredential: BrowserCredentialResponse? = null, val dailyMaxActiveDevices: Double, val fcmV1Credential: FcmV1CredentialResponse? = null, val gcmCredential: GcmCredentialResponse? = null, val id: String, val location: String, val mpnsCredential: MpnsCredentialResponse? = null, val name: String, val registrationTtl: String? = null, val sku: SkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val wnsCredential: WnsCredentialResponse? = null, val xiaomiCredential: XiaomiCredentialResponse? = null)

Notification Hub Resource.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace.

Link copied to clipboard
data class IpRuleResponse(val ipMask: String, val rights: List<String>)

A network authorization rule that filters traffic based on IP address.

Link copied to clipboard
data class ListNamespaceKeysResult(val keyName: String, val primaryConnectionString: String, val primaryKey: String, val secondaryConnectionString: String, val secondaryKey: String)

Response for the POST request that returns Namespace or NotificationHub access keys (connection strings).

Link copied to clipboard
data class ListNotificationHubKeysResult(val keyName: String, val primaryConnectionString: String, val primaryKey: String, val secondaryConnectionString: String, val secondaryKey: String)

Response for the POST request that returns Namespace or NotificationHub access keys (connection strings).

Link copied to clipboard
data class MpnsCredentialResponse(val certificateKey: String, val mpnsCertificate: String, val thumbprint: String)

Description of a NotificationHub MpnsCredential.

Link copied to clipboard
data class NetworkAclsResponse(val ipRules: List<IpRuleResponse>? = null, val publicNetworkRule: PublicInternetAuthorizationRuleResponse? = null)

A collection of network authorization rules.

Link copied to clipboard
data class PnsCredentialsResponse(val admCredential: AdmCredentialResponse? = null, val apnsCredential: ApnsCredentialResponse? = null, val baiduCredential: BaiduCredentialResponse? = null, val browserCredential: BrowserCredentialResponse? = null, val fcmV1Credential: FcmV1CredentialResponse? = null, val gcmCredential: GcmCredentialResponse? = null, val mpnsCredential: MpnsCredentialResponse? = null, val wnsCredential: WnsCredentialResponse? = null, val xiaomiCredential: XiaomiCredentialResponse? = null)

Collection of Notification Hub or Notification Hub Namespace PNS credentials.

data class PrivateEndpointConnectionPropertiesResponse(val groupIds: List<String>, val privateEndpoint: RemotePrivateEndpointConnectionResponse? = null, val privateLinkServiceConnectionState: RemotePrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String? = null)

Private Endpoint Connection properties.

data class PrivateEndpointConnectionResourceResponse(val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse? = null, val systemData: SystemDataResponse, val type: String)

Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace.

Link copied to clipboard

A default (public Internet) network authorization rule, which contains rights if no other network rule matches.

Link copied to clipboard

Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection.

data class RemotePrivateLinkServiceConnectionStateResponse(val actionsRequired: String, val description: String, val status: String? = null)

State of the Private Link Service connection.

data class SharedAccessAuthorizationRulePropertiesResponse(val claimType: String, val claimValue: String, val createdTime: String, val keyName: String, val modifiedTime: String, val primaryKey: String? = null, val revision: Int, val rights: List<String>, val secondaryKey: String? = null)

SharedAccessAuthorizationRule properties.

Link copied to clipboard
data class SkuResponse(val capacity: Int? = null, val family: String? = null, val name: String, val size: String? = null, val tier: String? = null)

The Sku description for a namespace

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class WnsCredentialResponse(val certificateKey: String? = null, val packageSid: String? = null, val secretKey: String? = null, val windowsLiveEndpoint: String? = null, val wnsCertificate: String? = null)

Description of a NotificationHub WnsCredential.

Link copied to clipboard
data class XiaomiCredentialResponse(val appSecret: String? = null, val endpoint: String? = null)

Description of a NotificationHub XiaomiCredential.