@azure/arm-notificationhubs 2.1.1-alpha.20240312.1 → 3.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +170 -9
- package/LICENSE +1 -1
- package/README.md +2 -2
- package/dist/index.js +3826 -1755
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/index.min.js.map +1 -1
- package/dist-esm/samples-dev/namespacesCheckAvailabilitySample.js +14 -6
- package/dist-esm/samples-dev/namespacesCheckAvailabilitySample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesCreateOrUpdateAuthorizationRuleSample.js +15 -7
- package/dist-esm/samples-dev/namespacesCreateOrUpdateAuthorizationRuleSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesCreateOrUpdateSample.js +25 -10
- package/dist-esm/samples-dev/namespacesCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesDeleteAuthorizationRuleSample.js +13 -5
- package/dist-esm/samples-dev/namespacesDeleteAuthorizationRuleSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesDeleteSample.js +14 -6
- package/dist-esm/samples-dev/namespacesDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesGetAuthorizationRuleSample.js +13 -5
- package/dist-esm/samples-dev/namespacesGetAuthorizationRuleSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesGetPnsCredentialsSample.d.ts +2 -0
- package/dist-esm/samples-dev/namespacesGetPnsCredentialsSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/namespacesGetPnsCredentialsSample.js +39 -0
- package/dist-esm/samples-dev/namespacesGetPnsCredentialsSample.js.map +1 -0
- package/dist-esm/samples-dev/namespacesGetSample.js +15 -7
- package/dist-esm/samples-dev/namespacesGetSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesListAllSample.js +14 -6
- package/dist-esm/samples-dev/namespacesListAllSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesListAuthorizationRulesSample.js +13 -5
- package/dist-esm/samples-dev/namespacesListAuthorizationRulesSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesListKeysSample.js +15 -7
- package/dist-esm/samples-dev/namespacesListKeysSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesListSample.js +15 -7
- package/dist-esm/samples-dev/namespacesListSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesRegenerateKeysSample.js +14 -6
- package/dist-esm/samples-dev/namespacesRegenerateKeysSample.js.map +1 -1
- package/dist-esm/samples-dev/namespacesUpdateSample.d.ts +2 -0
- package/dist-esm/samples-dev/namespacesUpdateSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/namespacesUpdateSample.js +51 -0
- package/dist-esm/samples-dev/namespacesUpdateSample.js.map +1 -0
- package/dist-esm/samples-dev/notificationHubsCheckNotificationHubAvailabilitySample.js +15 -7
- package/dist-esm/samples-dev/notificationHubsCheckNotificationHubAvailabilitySample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsCreateOrUpdateAuthorizationRuleSample.js +16 -8
- package/dist-esm/samples-dev/notificationHubsCreateOrUpdateAuthorizationRuleSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsCreateOrUpdateSample.js +15 -9
- package/dist-esm/samples-dev/notificationHubsCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsDebugSendSample.js +16 -10
- package/dist-esm/samples-dev/notificationHubsDebugSendSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsDeleteAuthorizationRuleSample.js +13 -5
- package/dist-esm/samples-dev/notificationHubsDeleteAuthorizationRuleSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsDeleteSample.js +13 -5
- package/dist-esm/samples-dev/notificationHubsDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsGetAuthorizationRuleSample.js +13 -5
- package/dist-esm/samples-dev/notificationHubsGetAuthorizationRuleSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsGetPnsCredentialsSample.js +15 -7
- package/dist-esm/samples-dev/notificationHubsGetPnsCredentialsSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsGetSample.js +15 -7
- package/dist-esm/samples-dev/notificationHubsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsListAuthorizationRulesSample.js +13 -5
- package/dist-esm/samples-dev/notificationHubsListAuthorizationRulesSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsListKeysSample.js +13 -5
- package/dist-esm/samples-dev/notificationHubsListKeysSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsListSample.js +13 -5
- package/dist-esm/samples-dev/notificationHubsListSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsRegenerateKeysSample.js +14 -6
- package/dist-esm/samples-dev/notificationHubsRegenerateKeysSample.js.map +1 -1
- package/dist-esm/samples-dev/notificationHubsUpdateSample.d.ts +2 -0
- package/dist-esm/samples-dev/notificationHubsUpdateSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/notificationHubsUpdateSample.js +47 -0
- package/dist-esm/samples-dev/notificationHubsUpdateSample.js.map +1 -0
- package/dist-esm/samples-dev/operationsListSample.js +13 -5
- package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.d.ts +2 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js +42 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsGetGroupIdSample.d.ts +2 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsGetGroupIdSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsGetGroupIdSample.js +42 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsGetGroupIdSample.js.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.d.ts +2 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js +42 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsListGroupIdsSample.d.ts +2 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsListGroupIdsSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsListGroupIdsSample.js +57 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsListGroupIdsSample.js.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsListSample.d.ts +2 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsListSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsListSample.js +57 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsListSample.js.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.d.ts +2 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.js +48 -0
- package/dist-esm/samples-dev/privateEndpointConnectionsUpdateSample.js.map +1 -0
- package/dist-esm/src/lroImpl.d.ts +6 -11
- package/dist-esm/src/lroImpl.d.ts.map +1 -1
- package/dist-esm/src/lroImpl.js +12 -20
- package/dist-esm/src/lroImpl.js.map +1 -1
- package/dist-esm/src/models/index.d.ts +1377 -455
- package/dist-esm/src/models/index.d.ts.map +1 -1
- package/dist-esm/src/models/index.js +136 -0
- package/dist-esm/src/models/index.js.map +1 -1
- package/dist-esm/src/models/mappers.d.ts +44 -17
- package/dist-esm/src/models/mappers.d.ts.map +1 -1
- package/dist-esm/src/models/mappers.js +1972 -738
- package/dist-esm/src/models/mappers.js.map +1 -1
- package/dist-esm/src/models/parameters.d.ts +10 -6
- package/dist-esm/src/models/parameters.d.ts.map +1 -1
- package/dist-esm/src/models/parameters.js +140 -80
- package/dist-esm/src/models/parameters.js.map +1 -1
- package/dist-esm/src/notificationHubsManagementClient.d.ts +6 -6
- package/dist-esm/src/notificationHubsManagementClient.d.ts.map +1 -1
- package/dist-esm/src/notificationHubsManagementClient.js +13 -13
- package/dist-esm/src/notificationHubsManagementClient.js.map +1 -1
- package/dist-esm/src/operations/index.d.ts +3 -2
- package/dist-esm/src/operations/index.d.ts.map +1 -1
- package/dist-esm/src/operations/index.js +3 -2
- package/dist-esm/src/operations/index.js.map +1 -1
- package/dist-esm/src/operations/namespaces.d.ts +82 -81
- package/dist-esm/src/operations/namespaces.d.ts.map +1 -1
- package/dist-esm/src/operations/namespaces.js +323 -224
- package/dist-esm/src/operations/namespaces.js.map +1 -1
- package/dist-esm/src/operations/notificationHubs.d.ts +73 -74
- package/dist-esm/src/operations/notificationHubs.d.ts.map +1 -1
- package/dist-esm/src/operations/notificationHubs.js +249 -185
- package/dist-esm/src/operations/notificationHubs.js.map +1 -1
- package/dist-esm/src/operations/operations.d.ts +2 -2
- package/dist-esm/src/operations/operations.js +11 -12
- package/dist-esm/src/operations/operations.js.map +1 -1
- package/dist-esm/src/operations/privateEndpointConnections.d.ts +114 -0
- package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -0
- package/dist-esm/src/operations/privateEndpointConnections.js +466 -0
- package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts +3 -2
- package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/index.js +3 -2
- package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
- package/dist-esm/src/operationsInterfaces/namespaces.d.ts +61 -58
- package/dist-esm/src/operationsInterfaces/namespaces.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/notificationHubs.d.ts +62 -63
- package/dist-esm/src/operationsInterfaces/notificationHubs.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/operations.d.ts +1 -1
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts +84 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js +9 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.js.map +1 -0
- package/dist-esm/src/pagingHelper.d.ts +4 -4
- package/dist-esm/src/pagingHelper.js +4 -4
- package/dist-esm/test/notificationhubs_examples.js +16 -4
- package/dist-esm/test/notificationhubs_examples.js.map +1 -1
- package/package.json +14 -13
- package/review/arm-notificationhubs.api.md +548 -121
- package/src/lroImpl.ts +31 -23
- package/src/models/index.ts +1458 -467
- package/src/models/mappers.ts +2054 -789
- package/src/models/parameters.ts +152 -87
- package/src/notificationHubsManagementClient.ts +30 -26
- package/src/operations/index.ts +3 -2
- package/src/operations/namespaces.ts +444 -341
- package/src/operations/notificationHubs.ts +326 -275
- package/src/operations/operations.ts +18 -19
- package/src/operations/privateEndpointConnections.ts +629 -0
- package/src/operationsInterfaces/index.ts +3 -2
- package/src/operationsInterfaces/namespaces.ts +101 -88
- package/src/operationsInterfaces/notificationHubs.ts +88 -89
- package/src/operationsInterfaces/operations.ts +2 -2
- package/src/operationsInterfaces/privateEndpointConnections.ts +156 -0
- package/src/pagingHelper.ts +5 -5
- package/types/arm-notificationhubs.d.ts +1615 -549
- package/types/tsdoc-metadata.json +1 -1
- package/dist-esm/samples-dev/namespacesPatchSample.d.ts +0 -2
- package/dist-esm/samples-dev/namespacesPatchSample.d.ts.map +0 -1
- package/dist-esm/samples-dev/namespacesPatchSample.js +0 -35
- package/dist-esm/samples-dev/namespacesPatchSample.js.map +0 -1
- package/dist-esm/samples-dev/notificationHubsPatchSample.d.ts +0 -2
- package/dist-esm/samples-dev/notificationHubsPatchSample.d.ts.map +0 -1
- package/dist-esm/samples-dev/notificationHubsPatchSample.js +0 -34
- package/dist-esm/samples-dev/notificationHubsPatchSample.js.map +0 -1
|
@@ -1,119 +1,460 @@
|
|
|
1
1
|
import * as coreAuth from '@azure/core-auth';
|
|
2
2
|
import * as coreClient from '@azure/core-client';
|
|
3
|
+
import { OperationState } from '@azure/core-lro';
|
|
3
4
|
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
4
|
-
import {
|
|
5
|
-
import { PollOperationState } from '@azure/core-lro';
|
|
5
|
+
import { SimplePollerLike } from '@azure/core-lro';
|
|
6
6
|
|
|
7
|
-
/**
|
|
8
|
-
|
|
7
|
+
/**
|
|
8
|
+
* Defines values for AccessRights. \
|
|
9
|
+
* {@link KnownAccessRights} can be used interchangeably with AccessRights,
|
|
10
|
+
* this enum contains the known values that the service supports.
|
|
11
|
+
* ### Known values supported by the service
|
|
12
|
+
* **Manage** \
|
|
13
|
+
* **Send** \
|
|
14
|
+
* **Listen**
|
|
15
|
+
*/
|
|
16
|
+
export declare type AccessRights = string;
|
|
9
17
|
|
|
10
18
|
/** Description of a NotificationHub AdmCredential. */
|
|
11
19
|
export declare interface AdmCredential {
|
|
12
|
-
/**
|
|
13
|
-
clientId
|
|
14
|
-
/**
|
|
15
|
-
clientSecret
|
|
16
|
-
/**
|
|
17
|
-
authTokenUrl
|
|
20
|
+
/** Gets or sets the client identifier. */
|
|
21
|
+
clientId: string;
|
|
22
|
+
/** Gets or sets the credential secret access key. */
|
|
23
|
+
clientSecret: string;
|
|
24
|
+
/** Gets or sets the URL of the authorization token. */
|
|
25
|
+
authTokenUrl: string;
|
|
18
26
|
}
|
|
19
27
|
|
|
20
28
|
/** Description of a NotificationHub ApnsCredential. */
|
|
21
29
|
export declare interface ApnsCredential {
|
|
22
|
-
/**
|
|
30
|
+
/** Gets or sets the APNS certificate. */
|
|
23
31
|
apnsCertificate?: string;
|
|
24
|
-
/**
|
|
32
|
+
/** Gets or sets the certificate key. */
|
|
25
33
|
certificateKey?: string;
|
|
26
|
-
/**
|
|
27
|
-
endpoint
|
|
28
|
-
/**
|
|
34
|
+
/** Gets or sets the endpoint of this credential. */
|
|
35
|
+
endpoint: string;
|
|
36
|
+
/** Gets or sets the APNS certificate Thumbprint */
|
|
29
37
|
thumbprint?: string;
|
|
30
|
-
/**
|
|
38
|
+
/**
|
|
39
|
+
* Gets or sets a 10-character key identifier (kid) key, obtained from
|
|
40
|
+
* your developer account
|
|
41
|
+
*/
|
|
31
42
|
keyId?: string;
|
|
32
|
-
/**
|
|
43
|
+
/** Gets or sets the name of the application */
|
|
33
44
|
appName?: string;
|
|
34
|
-
/**
|
|
45
|
+
/**
|
|
46
|
+
* Gets or sets the issuer (iss) registered claim key, whose value is
|
|
47
|
+
* your 10-character Team ID, obtained from your developer account
|
|
48
|
+
*/
|
|
35
49
|
appId?: string;
|
|
36
|
-
/**
|
|
50
|
+
/**
|
|
51
|
+
* Gets or sets provider Authentication Token, obtained through your
|
|
52
|
+
* developer account
|
|
53
|
+
*/
|
|
37
54
|
token?: string;
|
|
38
55
|
}
|
|
39
56
|
|
|
57
|
+
/** Represents metric availability (part of RP operation descriptions). */
|
|
58
|
+
export declare interface Availability {
|
|
59
|
+
/**
|
|
60
|
+
* Time grain of the availability.
|
|
61
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
62
|
+
*/
|
|
63
|
+
readonly timeGrain?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Duration of the availability blob.
|
|
66
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
67
|
+
*/
|
|
68
|
+
readonly blobDuration?: string;
|
|
69
|
+
}
|
|
70
|
+
|
|
40
71
|
/** Description of a NotificationHub BaiduCredential. */
|
|
41
72
|
export declare interface BaiduCredential {
|
|
42
|
-
/**
|
|
43
|
-
baiduApiKey
|
|
44
|
-
/**
|
|
45
|
-
baiduEndPoint
|
|
46
|
-
/**
|
|
47
|
-
baiduSecretKey
|
|
73
|
+
/** Gets or sets baidu Api Key. */
|
|
74
|
+
baiduApiKey: string;
|
|
75
|
+
/** Gets or sets baidu Endpoint. */
|
|
76
|
+
baiduEndPoint: string;
|
|
77
|
+
/** Gets or sets baidu Secret Key */
|
|
78
|
+
baiduSecretKey: string;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/** Description of a NotificationHub BrowserCredential. */
|
|
82
|
+
export declare interface BrowserCredential {
|
|
83
|
+
/** Gets or sets web push subject. */
|
|
84
|
+
subject: string;
|
|
85
|
+
/** Gets or sets VAPID private key. */
|
|
86
|
+
vapidPrivateKey: string;
|
|
87
|
+
/** Gets or sets VAPID public key. */
|
|
88
|
+
vapidPublicKey: string;
|
|
48
89
|
}
|
|
49
90
|
|
|
50
|
-
/**
|
|
91
|
+
/**
|
|
92
|
+
* Parameters supplied to the Check Name Availability for Namespace and
|
|
93
|
+
* NotificationHubs.
|
|
94
|
+
*/
|
|
51
95
|
export declare interface CheckAvailabilityParameters {
|
|
52
96
|
/**
|
|
53
|
-
*
|
|
97
|
+
* Gets resource Id
|
|
54
98
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
55
99
|
*/
|
|
56
100
|
readonly id?: string;
|
|
57
|
-
/**
|
|
101
|
+
/** Gets or sets resource name */
|
|
58
102
|
name: string;
|
|
59
103
|
/**
|
|
60
|
-
*
|
|
104
|
+
* Gets resource type
|
|
61
105
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
62
106
|
*/
|
|
63
107
|
readonly type?: string;
|
|
64
|
-
/**
|
|
108
|
+
/** Gets or sets resource location */
|
|
65
109
|
location?: string;
|
|
66
|
-
/**
|
|
110
|
+
/** Gets or sets resource tags */
|
|
67
111
|
tags?: {
|
|
68
112
|
[propertyName: string]: string;
|
|
69
113
|
};
|
|
70
|
-
/**
|
|
71
|
-
sku?: Sku;
|
|
72
|
-
/** True if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false. */
|
|
114
|
+
/** Not used and deprecated since API version 2023-01-01-preview */
|
|
73
115
|
isAvailiable?: boolean;
|
|
116
|
+
/** The Sku description for a namespace */
|
|
117
|
+
sku?: Sku;
|
|
74
118
|
}
|
|
75
119
|
|
|
76
120
|
/** Description of a CheckAvailability resource. */
|
|
77
|
-
export declare interface CheckAvailabilityResult extends
|
|
78
|
-
/**
|
|
121
|
+
export declare interface CheckAvailabilityResult extends ProxyResource {
|
|
122
|
+
/**
|
|
123
|
+
* Gets or sets true if the name is available and can be used to
|
|
124
|
+
* create new Namespace/NotificationHub. Otherwise false.
|
|
125
|
+
*/
|
|
79
126
|
isAvailiable?: boolean;
|
|
127
|
+
/** Deprecated - only for compatibility. */
|
|
128
|
+
location?: string;
|
|
129
|
+
/** Deprecated - only for compatibility. */
|
|
130
|
+
tags?: {
|
|
131
|
+
[propertyName: string]: string;
|
|
132
|
+
};
|
|
133
|
+
/** The Sku description for a namespace */
|
|
134
|
+
sku?: Sku;
|
|
80
135
|
}
|
|
81
136
|
|
|
137
|
+
/**
|
|
138
|
+
* Part of Private Endpoint description that stores information about a connection between Private Endpoint and Notification Hubs namespace.
|
|
139
|
+
* This is internal class, not visible to customers, and we use it only to discover the link identifier.
|
|
140
|
+
*/
|
|
141
|
+
export declare interface ConnectionDetails {
|
|
142
|
+
/**
|
|
143
|
+
* A unique ID of the connection. This is not the ARM id, but rather an internal identifier set by the Networking RP. Notification Hubs code
|
|
144
|
+
* does not analyze it.
|
|
145
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
146
|
+
*/
|
|
147
|
+
readonly id?: string;
|
|
148
|
+
/**
|
|
149
|
+
* IP address of the Private Endpoint. This is not used by Notification Hubs.
|
|
150
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
151
|
+
*/
|
|
152
|
+
readonly privateIpAddress?: string;
|
|
153
|
+
/**
|
|
154
|
+
* Link identifier. This is a string representation of an integer that is also encoded in every IPv6 frame received by Front Door,
|
|
155
|
+
* and we use it to create implicit authorization rule that allows connection from the associated Private Endpoint.
|
|
156
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
157
|
+
*/
|
|
158
|
+
readonly linkIdentifier?: string;
|
|
159
|
+
/**
|
|
160
|
+
* Group name. Always "namespace" for Notification Hubs.
|
|
161
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
162
|
+
*/
|
|
163
|
+
readonly groupId?: string;
|
|
164
|
+
/**
|
|
165
|
+
* Member name. Always "namespace" for Notification Hubs.
|
|
166
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
167
|
+
*/
|
|
168
|
+
readonly memberName?: string;
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
/**
|
|
172
|
+
* Defines values for CreatedByType. \
|
|
173
|
+
* {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
|
|
174
|
+
* this enum contains the known values that the service supports.
|
|
175
|
+
* ### Known values supported by the service
|
|
176
|
+
* **User** \
|
|
177
|
+
* **Application** \
|
|
178
|
+
* **ManagedIdentity** \
|
|
179
|
+
* **Key**
|
|
180
|
+
*/
|
|
181
|
+
export declare type CreatedByType = string;
|
|
182
|
+
|
|
82
183
|
/** Description of a NotificationHub Resource. */
|
|
83
|
-
export declare interface DebugSendResponse extends
|
|
84
|
-
/**
|
|
85
|
-
|
|
86
|
-
/**
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
184
|
+
export declare interface DebugSendResponse extends ProxyResource {
|
|
185
|
+
/** Deprecated - only for compatibility. */
|
|
186
|
+
location?: string;
|
|
187
|
+
/** Deprecated - only for compatibility. */
|
|
188
|
+
tags?: {
|
|
189
|
+
[propertyName: string]: string;
|
|
190
|
+
};
|
|
191
|
+
/**
|
|
192
|
+
* Gets or sets successful send
|
|
193
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
194
|
+
*/
|
|
195
|
+
readonly success?: number;
|
|
196
|
+
/**
|
|
197
|
+
* Gets or sets send failure
|
|
198
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
199
|
+
*/
|
|
200
|
+
readonly failure?: number;
|
|
201
|
+
/**
|
|
202
|
+
* Gets or sets actual failure description
|
|
203
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
204
|
+
*/
|
|
205
|
+
readonly results?: RegistrationResult[];
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/** The resource management error additional info. */
|
|
209
|
+
export declare interface ErrorAdditionalInfo {
|
|
210
|
+
/**
|
|
211
|
+
* The additional info type.
|
|
212
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
213
|
+
*/
|
|
214
|
+
readonly type?: string;
|
|
215
|
+
/**
|
|
216
|
+
* The additional info.
|
|
217
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
218
|
+
*/
|
|
219
|
+
readonly info?: Record<string, unknown>;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
/** The error detail. */
|
|
223
|
+
export declare interface ErrorDetail {
|
|
224
|
+
/**
|
|
225
|
+
* The error code.
|
|
226
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
227
|
+
*/
|
|
228
|
+
readonly code?: string;
|
|
229
|
+
/**
|
|
230
|
+
* The error message.
|
|
231
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
232
|
+
*/
|
|
233
|
+
readonly message?: string;
|
|
234
|
+
/**
|
|
235
|
+
* The error target.
|
|
236
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
237
|
+
*/
|
|
238
|
+
readonly target?: string;
|
|
239
|
+
/**
|
|
240
|
+
* The error details.
|
|
241
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
242
|
+
*/
|
|
243
|
+
readonly details?: ErrorDetail[];
|
|
244
|
+
/**
|
|
245
|
+
* The error additional info.
|
|
246
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
247
|
+
*/
|
|
248
|
+
readonly additionalInfo?: ErrorAdditionalInfo[];
|
|
90
249
|
}
|
|
91
250
|
|
|
92
|
-
/**
|
|
251
|
+
/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
|
|
93
252
|
export declare interface ErrorResponse {
|
|
94
|
-
/**
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
253
|
+
/** The error object. */
|
|
254
|
+
error?: ErrorDetail;
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
/** Description of a NotificationHub FcmV1Credential. */
|
|
258
|
+
export declare interface FcmV1Credential {
|
|
259
|
+
/** Gets or sets client email. */
|
|
260
|
+
clientEmail: string;
|
|
261
|
+
/** Gets or sets private key. */
|
|
262
|
+
privateKey: string;
|
|
263
|
+
/** Gets or sets project id. */
|
|
264
|
+
projectId: string;
|
|
98
265
|
}
|
|
99
266
|
|
|
100
267
|
/** Description of a NotificationHub GcmCredential. */
|
|
101
268
|
export declare interface GcmCredential {
|
|
102
|
-
/**
|
|
269
|
+
/** Gets or sets the GCM endpoint. */
|
|
103
270
|
gcmEndpoint?: string;
|
|
104
|
-
/**
|
|
105
|
-
googleApiKey
|
|
271
|
+
/** Gets or sets the Google API key. */
|
|
272
|
+
googleApiKey: string;
|
|
106
273
|
}
|
|
107
274
|
|
|
108
275
|
/**
|
|
109
|
-
* Given
|
|
110
|
-
* continuation token that can be used to begin paging from
|
|
276
|
+
* Given the last `.value` produced by the `byPage` iterator,
|
|
277
|
+
* returns a continuation token that can be used to begin paging from
|
|
111
278
|
* that point later.
|
|
112
|
-
* @param page
|
|
113
|
-
* @returns The continuation token that can be passed into byPage().
|
|
279
|
+
* @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
|
|
280
|
+
* @returns The continuation token that can be passed into byPage() during future calls.
|
|
114
281
|
*/
|
|
115
282
|
export declare function getContinuationToken(page: unknown): string | undefined;
|
|
116
283
|
|
|
284
|
+
/**
|
|
285
|
+
* Represents a connectivity information to Notification Hubs namespace. This is part of PrivateLinkService proxy that tell
|
|
286
|
+
* the Networking RP how to connect to the Notification Hubs namespace.
|
|
287
|
+
*/
|
|
288
|
+
export declare interface GroupConnectivityInformation {
|
|
289
|
+
/**
|
|
290
|
+
* Group id. Always set to "namespace".
|
|
291
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
292
|
+
*/
|
|
293
|
+
readonly groupId?: string;
|
|
294
|
+
/**
|
|
295
|
+
* Member name. Always set to "namespace".
|
|
296
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
297
|
+
*/
|
|
298
|
+
readonly memberName?: string;
|
|
299
|
+
/**
|
|
300
|
+
* List of customer-visible domain names that point to a Notification Hubs namespace.
|
|
301
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
302
|
+
*/
|
|
303
|
+
readonly customerVisibleFqdns?: string[];
|
|
304
|
+
/**
|
|
305
|
+
* One of the domain name from the customer-visible names; this is used internally by Private Link service to make connection to Notification Hubs
|
|
306
|
+
* namespace.
|
|
307
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
308
|
+
*/
|
|
309
|
+
readonly internalFqdn?: string;
|
|
310
|
+
/**
|
|
311
|
+
* Not used by Notification Hubs.
|
|
312
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
313
|
+
*/
|
|
314
|
+
readonly redirectMapId?: string;
|
|
315
|
+
/**
|
|
316
|
+
* ARM region for Private Link Service. We use the region that contains the connected Notification Hubs namespace.
|
|
317
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
318
|
+
*/
|
|
319
|
+
readonly privateLinkServiceArmRegion?: string;
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
/** A network authorization rule that filters traffic based on IP address. */
|
|
323
|
+
export declare interface IpRule {
|
|
324
|
+
/** IP mask. */
|
|
325
|
+
ipMask: string;
|
|
326
|
+
/** List of access rights. */
|
|
327
|
+
rights: AccessRights[];
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
/** Known values of {@link AccessRights} that the service accepts. */
|
|
331
|
+
export declare enum KnownAccessRights {
|
|
332
|
+
/** Manage */
|
|
333
|
+
Manage = "Manage",
|
|
334
|
+
/** Send */
|
|
335
|
+
Send = "Send",
|
|
336
|
+
/** Listen */
|
|
337
|
+
Listen = "Listen"
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
/** Known values of {@link CreatedByType} that the service accepts. */
|
|
341
|
+
export declare enum KnownCreatedByType {
|
|
342
|
+
/** User */
|
|
343
|
+
User = "User",
|
|
344
|
+
/** Application */
|
|
345
|
+
Application = "Application",
|
|
346
|
+
/** ManagedIdentity */
|
|
347
|
+
ManagedIdentity = "ManagedIdentity",
|
|
348
|
+
/** Key */
|
|
349
|
+
Key = "Key"
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
/** Known values of {@link NamespaceStatus} that the service accepts. */
|
|
353
|
+
export declare enum KnownNamespaceStatus {
|
|
354
|
+
/** Created */
|
|
355
|
+
Created = "Created",
|
|
356
|
+
/** Creating */
|
|
357
|
+
Creating = "Creating",
|
|
358
|
+
/** Suspended */
|
|
359
|
+
Suspended = "Suspended",
|
|
360
|
+
/** Deleting */
|
|
361
|
+
Deleting = "Deleting"
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
/** Known values of {@link NamespaceType} that the service accepts. */
|
|
365
|
+
export declare enum KnownNamespaceType {
|
|
366
|
+
/** Messaging */
|
|
367
|
+
Messaging = "Messaging",
|
|
368
|
+
/** NotificationHub */
|
|
369
|
+
NotificationHub = "NotificationHub"
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
/** Known values of {@link OperationProvisioningState} that the service accepts. */
|
|
373
|
+
export declare enum KnownOperationProvisioningState {
|
|
374
|
+
/** Unknown */
|
|
375
|
+
Unknown = "Unknown",
|
|
376
|
+
/** InProgress */
|
|
377
|
+
InProgress = "InProgress",
|
|
378
|
+
/** Succeeded */
|
|
379
|
+
Succeeded = "Succeeded",
|
|
380
|
+
/** Failed */
|
|
381
|
+
Failed = "Failed",
|
|
382
|
+
/** Canceled */
|
|
383
|
+
Canceled = "Canceled",
|
|
384
|
+
/** Pending */
|
|
385
|
+
Pending = "Pending",
|
|
386
|
+
/** Disabled */
|
|
387
|
+
Disabled = "Disabled"
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
/** Known values of {@link PolicyKeyType} that the service accepts. */
|
|
391
|
+
export declare enum KnownPolicyKeyType {
|
|
392
|
+
/** PrimaryKey */
|
|
393
|
+
PrimaryKey = "PrimaryKey",
|
|
394
|
+
/** SecondaryKey */
|
|
395
|
+
SecondaryKey = "SecondaryKey"
|
|
396
|
+
}
|
|
397
|
+
|
|
398
|
+
/** Known values of {@link PrivateEndpointConnectionProvisioningState} that the service accepts. */
|
|
399
|
+
export declare enum KnownPrivateEndpointConnectionProvisioningState {
|
|
400
|
+
/** Unknown */
|
|
401
|
+
Unknown = "Unknown",
|
|
402
|
+
/** Succeeded */
|
|
403
|
+
Succeeded = "Succeeded",
|
|
404
|
+
/** Creating */
|
|
405
|
+
Creating = "Creating",
|
|
406
|
+
/** Updating */
|
|
407
|
+
Updating = "Updating",
|
|
408
|
+
/** UpdatingByProxy */
|
|
409
|
+
UpdatingByProxy = "UpdatingByProxy",
|
|
410
|
+
/** Deleting */
|
|
411
|
+
Deleting = "Deleting",
|
|
412
|
+
/** DeletingByProxy */
|
|
413
|
+
DeletingByProxy = "DeletingByProxy",
|
|
414
|
+
/** Deleted */
|
|
415
|
+
Deleted = "Deleted"
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
/** Known values of {@link PrivateLinkConnectionStatus} that the service accepts. */
|
|
419
|
+
export declare enum KnownPrivateLinkConnectionStatus {
|
|
420
|
+
/** Disconnected */
|
|
421
|
+
Disconnected = "Disconnected",
|
|
422
|
+
/** Pending */
|
|
423
|
+
Pending = "Pending",
|
|
424
|
+
/** Approved */
|
|
425
|
+
Approved = "Approved",
|
|
426
|
+
/** Rejected */
|
|
427
|
+
Rejected = "Rejected"
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
/** Known values of {@link PublicNetworkAccess} that the service accepts. */
|
|
431
|
+
export declare enum KnownPublicNetworkAccess {
|
|
432
|
+
/** Enabled */
|
|
433
|
+
Enabled = "Enabled",
|
|
434
|
+
/** Disabled */
|
|
435
|
+
Disabled = "Disabled"
|
|
436
|
+
}
|
|
437
|
+
|
|
438
|
+
/** Known values of {@link ReplicationRegion} that the service accepts. */
|
|
439
|
+
export declare enum KnownReplicationRegion {
|
|
440
|
+
/** Default */
|
|
441
|
+
Default = "Default",
|
|
442
|
+
/** WestUs2 */
|
|
443
|
+
WestUs2 = "WestUs2",
|
|
444
|
+
/** NorthEurope */
|
|
445
|
+
NorthEurope = "NorthEurope",
|
|
446
|
+
/** AustraliaEast */
|
|
447
|
+
AustraliaEast = "AustraliaEast",
|
|
448
|
+
/** BrazilSouth */
|
|
449
|
+
BrazilSouth = "BrazilSouth",
|
|
450
|
+
/** SouthEastAsia */
|
|
451
|
+
SouthEastAsia = "SouthEastAsia",
|
|
452
|
+
/** SouthAfricaNorth */
|
|
453
|
+
SouthAfricaNorth = "SouthAfricaNorth",
|
|
454
|
+
/** None */
|
|
455
|
+
None = "None"
|
|
456
|
+
}
|
|
457
|
+
|
|
117
458
|
/** Known values of {@link SkuName} that the service accepts. */
|
|
118
459
|
export declare enum KnownSkuName {
|
|
119
460
|
/** Free */
|
|
@@ -124,216 +465,391 @@ export declare enum KnownSkuName {
|
|
|
124
465
|
Standard = "Standard"
|
|
125
466
|
}
|
|
126
467
|
|
|
127
|
-
/**
|
|
128
|
-
export declare
|
|
129
|
-
/**
|
|
130
|
-
|
|
131
|
-
/**
|
|
132
|
-
|
|
133
|
-
/** The MPNS certificate Thumbprint */
|
|
134
|
-
thumbprint?: string;
|
|
468
|
+
/** Known values of {@link ZoneRedundancyPreference} that the service accepts. */
|
|
469
|
+
export declare enum KnownZoneRedundancyPreference {
|
|
470
|
+
/** Disabled */
|
|
471
|
+
Disabled = "Disabled",
|
|
472
|
+
/** Enabled */
|
|
473
|
+
Enabled = "Enabled"
|
|
135
474
|
}
|
|
136
475
|
|
|
137
|
-
/**
|
|
138
|
-
export declare interface
|
|
139
|
-
/** The name of the namespace. */
|
|
140
|
-
namePropertiesName?: string;
|
|
141
|
-
/** Provisioning state of the Namespace. */
|
|
142
|
-
provisioningState?: string;
|
|
143
|
-
/** Specifies the targeted region in which the namespace should be created. It can be any of the following values: Australia East, Australia Southeast, Central US, East US, East US 2, West US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, Japan West, North Europe, West Europe */
|
|
144
|
-
region?: string;
|
|
476
|
+
/** A single log category specification. */
|
|
477
|
+
export declare interface LogSpecification {
|
|
145
478
|
/**
|
|
146
|
-
*
|
|
479
|
+
* Name of the log category.
|
|
147
480
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
148
481
|
*/
|
|
149
|
-
readonly
|
|
150
|
-
/**
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
/**
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
/**
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
482
|
+
readonly name?: string;
|
|
483
|
+
/**
|
|
484
|
+
* Display name of the log category.
|
|
485
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
486
|
+
*/
|
|
487
|
+
readonly displayName?: string;
|
|
488
|
+
/**
|
|
489
|
+
* Duration of data written to a single blob.
|
|
490
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
491
|
+
*/
|
|
492
|
+
readonly blobDuration?: string;
|
|
493
|
+
/** Category group for the log specification. */
|
|
494
|
+
categoryGroups?: string[];
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
/** A metric specification. */
|
|
498
|
+
export declare interface MetricSpecification {
|
|
499
|
+
/**
|
|
500
|
+
* Metric name / id.
|
|
501
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
502
|
+
*/
|
|
503
|
+
readonly name?: string;
|
|
504
|
+
/**
|
|
505
|
+
* User-visible metric name.
|
|
506
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
507
|
+
*/
|
|
508
|
+
readonly displayName?: string;
|
|
509
|
+
/**
|
|
510
|
+
* Description of the metric.
|
|
511
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
512
|
+
*/
|
|
513
|
+
readonly displayDescription?: string;
|
|
514
|
+
/**
|
|
515
|
+
* Metric unit.
|
|
516
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
517
|
+
*/
|
|
518
|
+
readonly unit?: string;
|
|
519
|
+
/**
|
|
520
|
+
* Type of the aggregation (Average, Minimum, Maximum, Total or Count).
|
|
521
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
522
|
+
*/
|
|
523
|
+
readonly aggregationType?: string;
|
|
524
|
+
/**
|
|
525
|
+
* List of availabilities.
|
|
526
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
527
|
+
*/
|
|
528
|
+
readonly availabilities?: Availability[];
|
|
529
|
+
/**
|
|
530
|
+
* List of supported time grain types.
|
|
531
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
532
|
+
*/
|
|
533
|
+
readonly supportedTimeGrainTypes?: string[];
|
|
534
|
+
/**
|
|
535
|
+
* The matching regex pattern to be applied to the field pointed by the "metricsFilterPathSelector" flag in the ARM manifest.
|
|
536
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
537
|
+
*/
|
|
538
|
+
readonly metricFilterPattern?: string;
|
|
539
|
+
/**
|
|
540
|
+
* Optional property. If set to true, then zero will be returned for time duration where no metric is emitted / published.
|
|
541
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
542
|
+
*/
|
|
543
|
+
readonly fillGapWithZero?: boolean;
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
/** Description of a NotificationHub MpnsCredential. */
|
|
547
|
+
export declare interface MpnsCredential {
|
|
548
|
+
/** Gets or sets the MPNS certificate. */
|
|
549
|
+
mpnsCertificate: string;
|
|
550
|
+
/** Gets or sets the certificate key for this credential. */
|
|
551
|
+
certificateKey: string;
|
|
552
|
+
/** Gets or sets the MPNS certificate Thumbprint */
|
|
553
|
+
thumbprint: string;
|
|
170
554
|
}
|
|
171
555
|
|
|
172
556
|
/** The response of the List Namespace operation. */
|
|
173
557
|
export declare interface NamespaceListResult {
|
|
174
|
-
/**
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
558
|
+
/**
|
|
559
|
+
* Gets or sets result of the List AuthorizationRules operation.
|
|
560
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
561
|
+
*/
|
|
562
|
+
readonly value?: NamespaceResource[];
|
|
563
|
+
/**
|
|
564
|
+
* Gets or sets link to the next set of results.
|
|
565
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
566
|
+
*/
|
|
567
|
+
readonly nextLink?: string;
|
|
178
568
|
}
|
|
179
569
|
|
|
180
|
-
/**
|
|
570
|
+
/** Patch parameter for NamespaceResource. */
|
|
181
571
|
export declare interface NamespacePatchParameters {
|
|
182
|
-
/**
|
|
572
|
+
/** The Sku description for a namespace */
|
|
573
|
+
sku?: Sku;
|
|
574
|
+
/** Represents namespace properties. */
|
|
575
|
+
properties?: NamespaceProperties;
|
|
576
|
+
/** Dictionary of <string> */
|
|
183
577
|
tags?: {
|
|
184
578
|
[propertyName: string]: string;
|
|
185
579
|
};
|
|
186
|
-
/** The sku of the created namespace */
|
|
187
|
-
sku?: Sku;
|
|
188
580
|
}
|
|
189
581
|
|
|
190
|
-
/**
|
|
191
|
-
export declare interface
|
|
192
|
-
/**
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
582
|
+
/** Represents namespace properties. */
|
|
583
|
+
export declare interface NamespaceProperties {
|
|
584
|
+
/**
|
|
585
|
+
* Name of the Notification Hubs namespace. This is immutable property, set automatically
|
|
586
|
+
* by the service when the namespace is created.
|
|
587
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
588
|
+
*/
|
|
589
|
+
readonly name?: string;
|
|
590
|
+
/** Defines values for OperationProvisioningState. */
|
|
591
|
+
provisioningState?: OperationProvisioningState;
|
|
592
|
+
/** Namespace status. */
|
|
593
|
+
status?: NamespaceStatus;
|
|
594
|
+
/**
|
|
595
|
+
* Gets or sets whether or not the namespace is currently enabled.
|
|
596
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
597
|
+
*/
|
|
598
|
+
readonly enabled?: boolean;
|
|
599
|
+
/**
|
|
600
|
+
* Gets or sets whether or not the namespace is set as Critical.
|
|
601
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
602
|
+
*/
|
|
603
|
+
readonly critical?: boolean;
|
|
198
604
|
/**
|
|
199
|
-
*
|
|
605
|
+
* Namespace subscription id.
|
|
606
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
607
|
+
*/
|
|
608
|
+
readonly subscriptionId?: string;
|
|
609
|
+
/**
|
|
610
|
+
* Region. The value is always set to the same value as Namespace.Location, so we are deprecating
|
|
611
|
+
* this property.
|
|
612
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
613
|
+
*/
|
|
614
|
+
readonly region?: string;
|
|
615
|
+
/**
|
|
616
|
+
* Azure Insights Metrics id.
|
|
200
617
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
201
618
|
*/
|
|
202
619
|
readonly metricId?: string;
|
|
203
|
-
/**
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
/**
|
|
620
|
+
/**
|
|
621
|
+
* Time when the namespace was created.
|
|
622
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
623
|
+
*/
|
|
624
|
+
readonly createdAt?: Date;
|
|
625
|
+
/**
|
|
626
|
+
* Time when the namespace was updated.
|
|
627
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
628
|
+
*/
|
|
629
|
+
readonly updatedAt?: Date;
|
|
630
|
+
/** Defines values for NamespaceType. */
|
|
631
|
+
namespaceType?: NamespaceType;
|
|
632
|
+
/** Allowed replication region */
|
|
633
|
+
replicationRegion?: ReplicationRegion;
|
|
634
|
+
/** Namespace SKU name. */
|
|
635
|
+
zoneRedundancy?: ZoneRedundancyPreference;
|
|
636
|
+
/** A collection of network authorization rules. */
|
|
637
|
+
networkAcls?: NetworkAcls;
|
|
638
|
+
/** Collection of Notification Hub or Notification Hub Namespace PNS credentials. */
|
|
639
|
+
pnsCredentials?: PnsCredentials;
|
|
640
|
+
/**
|
|
641
|
+
* Gets or sets endpoint you can use to perform NotificationHub
|
|
642
|
+
* operations.
|
|
643
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
644
|
+
*/
|
|
645
|
+
readonly serviceBusEndpoint?: string;
|
|
646
|
+
/**
|
|
647
|
+
* Private Endpoint Connections for namespace
|
|
648
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
649
|
+
*/
|
|
650
|
+
readonly privateEndpointConnections?: PrivateEndpointConnectionResource[];
|
|
651
|
+
/** Gets or sets scaleUnit where the namespace gets created */
|
|
214
652
|
scaleUnit?: string;
|
|
215
|
-
/**
|
|
216
|
-
enabled?: boolean;
|
|
217
|
-
/** Whether or not the namespace is set as Critical. */
|
|
218
|
-
critical?: boolean;
|
|
219
|
-
/** Data center for the namespace */
|
|
653
|
+
/** Deprecated. */
|
|
220
654
|
dataCenter?: string;
|
|
221
|
-
/**
|
|
655
|
+
/** Type of public network access. */
|
|
656
|
+
publicNetworkAccess?: PublicNetworkAccess;
|
|
657
|
+
}
|
|
658
|
+
|
|
659
|
+
/** Notification Hubs Namespace Resource. */
|
|
660
|
+
export declare interface NamespaceResource extends TrackedResource {
|
|
661
|
+
/** The Sku description for a namespace */
|
|
662
|
+
sku: Sku;
|
|
663
|
+
/**
|
|
664
|
+
* Name of the Notification Hubs namespace. This is immutable property, set automatically
|
|
665
|
+
* by the service when the namespace is created.
|
|
666
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
667
|
+
*/
|
|
668
|
+
readonly namePropertiesName?: string;
|
|
669
|
+
/** Defines values for OperationProvisioningState. */
|
|
670
|
+
provisioningState?: OperationProvisioningState;
|
|
671
|
+
/** Namespace status. */
|
|
672
|
+
status?: NamespaceStatus;
|
|
673
|
+
/**
|
|
674
|
+
* Gets or sets whether or not the namespace is currently enabled.
|
|
675
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
676
|
+
*/
|
|
677
|
+
readonly enabled?: boolean;
|
|
678
|
+
/**
|
|
679
|
+
* Gets or sets whether or not the namespace is set as Critical.
|
|
680
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
681
|
+
*/
|
|
682
|
+
readonly critical?: boolean;
|
|
683
|
+
/**
|
|
684
|
+
* Namespace subscription id.
|
|
685
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
686
|
+
*/
|
|
687
|
+
readonly subscriptionId?: string;
|
|
688
|
+
/**
|
|
689
|
+
* Region. The value is always set to the same value as Namespace.Location, so we are deprecating
|
|
690
|
+
* this property.
|
|
691
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
692
|
+
*/
|
|
693
|
+
readonly region?: string;
|
|
694
|
+
/**
|
|
695
|
+
* Azure Insights Metrics id.
|
|
696
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
697
|
+
*/
|
|
698
|
+
readonly metricId?: string;
|
|
699
|
+
/**
|
|
700
|
+
* Time when the namespace was created.
|
|
701
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
702
|
+
*/
|
|
703
|
+
readonly createdAt?: Date;
|
|
704
|
+
/**
|
|
705
|
+
* Time when the namespace was updated.
|
|
706
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
707
|
+
*/
|
|
708
|
+
readonly updatedAt?: Date;
|
|
709
|
+
/** Defines values for NamespaceType. */
|
|
222
710
|
namespaceType?: NamespaceType;
|
|
711
|
+
/** Allowed replication region */
|
|
712
|
+
replicationRegion?: ReplicationRegion;
|
|
713
|
+
/** Namespace SKU name. */
|
|
714
|
+
zoneRedundancy?: ZoneRedundancyPreference;
|
|
715
|
+
/** A collection of network authorization rules. */
|
|
716
|
+
networkAcls?: NetworkAcls;
|
|
717
|
+
/** Collection of Notification Hub or Notification Hub Namespace PNS credentials. */
|
|
718
|
+
pnsCredentials?: PnsCredentials;
|
|
719
|
+
/**
|
|
720
|
+
* Gets or sets endpoint you can use to perform NotificationHub
|
|
721
|
+
* operations.
|
|
722
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
723
|
+
*/
|
|
724
|
+
readonly serviceBusEndpoint?: string;
|
|
725
|
+
/**
|
|
726
|
+
* Private Endpoint Connections for namespace
|
|
727
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
728
|
+
*/
|
|
729
|
+
readonly privateEndpointConnections?: PrivateEndpointConnectionResource[];
|
|
730
|
+
/** Gets or sets scaleUnit where the namespace gets created */
|
|
731
|
+
scaleUnit?: string;
|
|
732
|
+
/** Deprecated. */
|
|
733
|
+
dataCenter?: string;
|
|
734
|
+
/** Type of public network access. */
|
|
735
|
+
publicNetworkAccess?: PublicNetworkAccess;
|
|
223
736
|
}
|
|
224
737
|
|
|
225
738
|
/** Interface representing a Namespaces. */
|
|
226
739
|
export declare interface Namespaces {
|
|
227
740
|
/**
|
|
228
|
-
* Lists the available namespaces within
|
|
229
|
-
* @param resourceGroupName The name of the resource group. If resourceGroupName value is null the
|
|
230
|
-
* method lists all the namespaces within subscription
|
|
741
|
+
* Lists all the available namespaces within the subscription.
|
|
231
742
|
* @param options The options parameters.
|
|
232
743
|
*/
|
|
233
|
-
|
|
744
|
+
listAll(options?: NamespacesListAllOptionalParams): PagedAsyncIterableIterator<NamespaceResource>;
|
|
234
745
|
/**
|
|
235
|
-
* Lists
|
|
746
|
+
* Lists the available namespaces within a resource group.
|
|
747
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
236
748
|
* @param options The options parameters.
|
|
237
749
|
*/
|
|
238
|
-
|
|
750
|
+
list(resourceGroupName: string, options?: NamespacesListOptionalParams): PagedAsyncIterableIterator<NamespaceResource>;
|
|
239
751
|
/**
|
|
240
752
|
* Gets the authorization rules for a namespace.
|
|
241
|
-
* @param resourceGroupName The name of the resource group.
|
|
242
|
-
* @param namespaceName
|
|
753
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
754
|
+
* @param namespaceName Namespace name
|
|
243
755
|
* @param options The options parameters.
|
|
244
756
|
*/
|
|
245
757
|
listAuthorizationRules(resourceGroupName: string, namespaceName: string, options?: NamespacesListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource>;
|
|
246
758
|
/**
|
|
247
759
|
* Checks the availability of the given service namespace across all Azure subscriptions. This is
|
|
248
760
|
* useful because the domain name is created based on the service namespace name.
|
|
249
|
-
* @param parameters
|
|
761
|
+
* @param parameters Request content.
|
|
250
762
|
* @param options The options parameters.
|
|
251
763
|
*/
|
|
252
764
|
checkAvailability(parameters: CheckAvailabilityParameters, options?: NamespacesCheckAvailabilityOptionalParams): Promise<NamespacesCheckAvailabilityResponse>;
|
|
253
765
|
/**
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
* @param
|
|
257
|
-
* @param namespaceName The namespace name.
|
|
258
|
-
* @param parameters Parameters supplied to create a Namespace Resource.
|
|
766
|
+
* Returns the given namespace.
|
|
767
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
768
|
+
* @param namespaceName Namespace name
|
|
259
769
|
* @param options The options parameters.
|
|
260
770
|
*/
|
|
261
|
-
|
|
771
|
+
get(resourceGroupName: string, namespaceName: string, options?: NamespacesGetOptionalParams): Promise<NamespacesGetResponse>;
|
|
262
772
|
/**
|
|
263
|
-
*
|
|
264
|
-
* @param resourceGroupName The name of the resource group.
|
|
265
|
-
* @param namespaceName
|
|
266
|
-
* @param parameters
|
|
773
|
+
* Creates / Updates a Notification Hub namespace. This operation is idempotent.
|
|
774
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
775
|
+
* @param namespaceName Namespace name
|
|
776
|
+
* @param parameters Request content.
|
|
267
777
|
* @param options The options parameters.
|
|
268
778
|
*/
|
|
269
|
-
|
|
779
|
+
beginCreateOrUpdate(resourceGroupName: string, namespaceName: string, parameters: NamespaceResource, options?: NamespacesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NamespacesCreateOrUpdateResponse>, NamespacesCreateOrUpdateResponse>>;
|
|
270
780
|
/**
|
|
271
|
-
*
|
|
272
|
-
*
|
|
273
|
-
* @param
|
|
274
|
-
* @param
|
|
781
|
+
* Creates / Updates a Notification Hub namespace. This operation is idempotent.
|
|
782
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
783
|
+
* @param namespaceName Namespace name
|
|
784
|
+
* @param parameters Request content.
|
|
275
785
|
* @param options The options parameters.
|
|
276
786
|
*/
|
|
277
|
-
|
|
787
|
+
beginCreateOrUpdateAndWait(resourceGroupName: string, namespaceName: string, parameters: NamespaceResource, options?: NamespacesCreateOrUpdateOptionalParams): Promise<NamespacesCreateOrUpdateResponse>;
|
|
278
788
|
/**
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
* @param
|
|
282
|
-
* @param
|
|
789
|
+
* Patches the existing namespace.
|
|
790
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
791
|
+
* @param namespaceName Namespace name
|
|
792
|
+
* @param parameters Request content.
|
|
283
793
|
* @param options The options parameters.
|
|
284
794
|
*/
|
|
285
|
-
|
|
795
|
+
update(resourceGroupName: string, namespaceName: string, parameters: NamespacePatchParameters, options?: NamespacesUpdateOptionalParams): Promise<NamespacesUpdateResponse>;
|
|
286
796
|
/**
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
* @param
|
|
797
|
+
* Deletes an existing namespace. This operation also removes all associated notificationHubs under the
|
|
798
|
+
* namespace.
|
|
799
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
800
|
+
* @param namespaceName Namespace name
|
|
290
801
|
* @param options The options parameters.
|
|
291
802
|
*/
|
|
292
|
-
|
|
803
|
+
delete(resourceGroupName: string, namespaceName: string, options?: NamespacesDeleteOptionalParams): Promise<void>;
|
|
293
804
|
/**
|
|
294
805
|
* Creates an authorization rule for a namespace
|
|
295
|
-
* @param resourceGroupName The name of the resource group.
|
|
296
|
-
* @param namespaceName
|
|
297
|
-
* @param authorizationRuleName Authorization Rule Name
|
|
298
|
-
* @param parameters
|
|
806
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
807
|
+
* @param namespaceName Namespace name
|
|
808
|
+
* @param authorizationRuleName Authorization Rule Name
|
|
809
|
+
* @param parameters Request content.
|
|
299
810
|
* @param options The options parameters.
|
|
300
811
|
*/
|
|
301
|
-
createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters:
|
|
812
|
+
createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: SharedAccessAuthorizationRuleResource, options?: NamespacesCreateOrUpdateAuthorizationRuleOptionalParams): Promise<NamespacesCreateOrUpdateAuthorizationRuleResponse>;
|
|
302
813
|
/**
|
|
303
814
|
* Deletes a namespace authorization rule
|
|
304
|
-
* @param resourceGroupName The name of the resource group.
|
|
305
|
-
* @param namespaceName
|
|
306
|
-
* @param authorizationRuleName Authorization Rule Name
|
|
815
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
816
|
+
* @param namespaceName Namespace name
|
|
817
|
+
* @param authorizationRuleName Authorization Rule Name
|
|
307
818
|
* @param options The options parameters.
|
|
308
819
|
*/
|
|
309
820
|
deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesDeleteAuthorizationRuleOptionalParams): Promise<void>;
|
|
310
821
|
/**
|
|
311
822
|
* Gets an authorization rule for a namespace by name.
|
|
312
|
-
* @param resourceGroupName The name of the resource group.
|
|
313
|
-
* @param namespaceName
|
|
314
|
-
* @param authorizationRuleName Authorization
|
|
823
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
824
|
+
* @param namespaceName Namespace name
|
|
825
|
+
* @param authorizationRuleName Authorization Rule Name
|
|
315
826
|
* @param options The options parameters.
|
|
316
827
|
*/
|
|
317
828
|
getAuthorizationRule(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesGetAuthorizationRuleOptionalParams): Promise<NamespacesGetAuthorizationRuleResponse>;
|
|
318
829
|
/**
|
|
319
|
-
* Gets the Primary and Secondary ConnectionStrings to the namespace
|
|
320
|
-
* @param resourceGroupName The name of the resource group.
|
|
321
|
-
* @param namespaceName
|
|
322
|
-
* @param authorizationRuleName
|
|
323
|
-
* authorizationRule.
|
|
830
|
+
* Gets the Primary and Secondary ConnectionStrings to the namespace.
|
|
831
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
832
|
+
* @param namespaceName Namespace name
|
|
833
|
+
* @param authorizationRuleName Authorization Rule Name
|
|
324
834
|
* @param options The options parameters.
|
|
325
835
|
*/
|
|
326
836
|
listKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, options?: NamespacesListKeysOptionalParams): Promise<NamespacesListKeysResponse>;
|
|
327
837
|
/**
|
|
328
838
|
* Regenerates the Primary/Secondary Keys to the Namespace Authorization Rule
|
|
329
|
-
* @param resourceGroupName The name of the resource group.
|
|
330
|
-
* @param namespaceName
|
|
331
|
-
* @param authorizationRuleName
|
|
332
|
-
*
|
|
333
|
-
* @param
|
|
839
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
840
|
+
* @param namespaceName Namespace name
|
|
841
|
+
* @param authorizationRuleName Authorization Rule Name
|
|
842
|
+
* @param parameters Request content.
|
|
843
|
+
* @param options The options parameters.
|
|
844
|
+
*/
|
|
845
|
+
regenerateKeys(resourceGroupName: string, namespaceName: string, authorizationRuleName: string, parameters: PolicyKeyResource, options?: NamespacesRegenerateKeysOptionalParams): Promise<NamespacesRegenerateKeysResponse>;
|
|
846
|
+
/**
|
|
847
|
+
* Lists the PNS credentials associated with a namespace.
|
|
848
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
849
|
+
* @param namespaceName Namespace name
|
|
334
850
|
* @param options The options parameters.
|
|
335
851
|
*/
|
|
336
|
-
|
|
852
|
+
getPnsCredentials(resourceGroupName: string, namespaceName: string, options?: NamespacesGetPnsCredentialsOptionalParams): Promise<NamespacesGetPnsCredentialsResponse>;
|
|
337
853
|
}
|
|
338
854
|
|
|
339
855
|
/** Optional parameters. */
|
|
@@ -352,6 +868,10 @@ export declare type NamespacesCreateOrUpdateAuthorizationRuleResponse = SharedAc
|
|
|
352
868
|
|
|
353
869
|
/** Optional parameters. */
|
|
354
870
|
export declare interface NamespacesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
871
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
872
|
+
updateIntervalInMs?: number;
|
|
873
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
874
|
+
resumeFrom?: string;
|
|
355
875
|
}
|
|
356
876
|
|
|
357
877
|
/** Contains response data for the createOrUpdate operation. */
|
|
@@ -363,10 +883,6 @@ export declare interface NamespacesDeleteAuthorizationRuleOptionalParams extends
|
|
|
363
883
|
|
|
364
884
|
/** Optional parameters. */
|
|
365
885
|
export declare interface NamespacesDeleteOptionalParams extends coreClient.OperationOptions {
|
|
366
|
-
/** Delay to wait until next poll, in milliseconds. */
|
|
367
|
-
updateIntervalInMs?: number;
|
|
368
|
-
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
369
|
-
resumeFrom?: string;
|
|
370
886
|
}
|
|
371
887
|
|
|
372
888
|
/** Optional parameters. */
|
|
@@ -380,6 +896,13 @@ export declare type NamespacesGetAuthorizationRuleResponse = SharedAccessAuthori
|
|
|
380
896
|
export declare interface NamespacesGetOptionalParams extends coreClient.OperationOptions {
|
|
381
897
|
}
|
|
382
898
|
|
|
899
|
+
/** Optional parameters. */
|
|
900
|
+
export declare interface NamespacesGetPnsCredentialsOptionalParams extends coreClient.OperationOptions {
|
|
901
|
+
}
|
|
902
|
+
|
|
903
|
+
/** Contains response data for the getPnsCredentials operation. */
|
|
904
|
+
export declare type NamespacesGetPnsCredentialsResponse = PnsCredentialsResource;
|
|
905
|
+
|
|
383
906
|
/** Contains response data for the get operation. */
|
|
384
907
|
export declare type NamespacesGetResponse = NamespaceResource;
|
|
385
908
|
|
|
@@ -392,6 +915,10 @@ export declare type NamespacesListAllNextResponse = NamespaceListResult;
|
|
|
392
915
|
|
|
393
916
|
/** Optional parameters. */
|
|
394
917
|
export declare interface NamespacesListAllOptionalParams extends coreClient.OperationOptions {
|
|
918
|
+
/** Skip token for subsequent requests. */
|
|
919
|
+
skipToken?: string;
|
|
920
|
+
/** Maximum number of results to return. */
|
|
921
|
+
top?: number;
|
|
395
922
|
}
|
|
396
923
|
|
|
397
924
|
/** Contains response data for the listAll operation. */
|
|
@@ -427,596 +954,1092 @@ export declare type NamespacesListNextResponse = NamespaceListResult;
|
|
|
427
954
|
|
|
428
955
|
/** Optional parameters. */
|
|
429
956
|
export declare interface NamespacesListOptionalParams extends coreClient.OperationOptions {
|
|
957
|
+
/** Skip token for subsequent requests. */
|
|
958
|
+
skipToken?: string;
|
|
959
|
+
/** Maximum number of results to return. */
|
|
960
|
+
top?: number;
|
|
430
961
|
}
|
|
431
962
|
|
|
432
963
|
/** Contains response data for the list operation. */
|
|
433
964
|
export declare type NamespacesListResponse = NamespaceListResult;
|
|
434
965
|
|
|
435
966
|
/** Optional parameters. */
|
|
436
|
-
export declare interface
|
|
967
|
+
export declare interface NamespacesRegenerateKeysOptionalParams extends coreClient.OperationOptions {
|
|
437
968
|
}
|
|
438
969
|
|
|
439
|
-
/** Contains response data for the
|
|
440
|
-
export declare type
|
|
970
|
+
/** Contains response data for the regenerateKeys operation. */
|
|
971
|
+
export declare type NamespacesRegenerateKeysResponse = ResourceListKeys;
|
|
972
|
+
|
|
973
|
+
/**
|
|
974
|
+
* Defines values for NamespaceStatus. \
|
|
975
|
+
* {@link KnownNamespaceStatus} can be used interchangeably with NamespaceStatus,
|
|
976
|
+
* this enum contains the known values that the service supports.
|
|
977
|
+
* ### Known values supported by the service
|
|
978
|
+
* **Created** \
|
|
979
|
+
* **Creating** \
|
|
980
|
+
* **Suspended** \
|
|
981
|
+
* **Deleting**
|
|
982
|
+
*/
|
|
983
|
+
export declare type NamespaceStatus = string;
|
|
441
984
|
|
|
442
985
|
/** Optional parameters. */
|
|
443
|
-
export declare interface
|
|
986
|
+
export declare interface NamespacesUpdateOptionalParams extends coreClient.OperationOptions {
|
|
444
987
|
}
|
|
445
988
|
|
|
446
|
-
/** Contains response data for the
|
|
447
|
-
export declare type
|
|
989
|
+
/** Contains response data for the update operation. */
|
|
990
|
+
export declare type NamespacesUpdateResponse = NamespaceResource;
|
|
448
991
|
|
|
449
|
-
/**
|
|
450
|
-
|
|
992
|
+
/**
|
|
993
|
+
* Defines values for NamespaceType. \
|
|
994
|
+
* {@link KnownNamespaceType} can be used interchangeably with NamespaceType,
|
|
995
|
+
* this enum contains the known values that the service supports.
|
|
996
|
+
* ### Known values supported by the service
|
|
997
|
+
* **Messaging** \
|
|
998
|
+
* **NotificationHub**
|
|
999
|
+
*/
|
|
1000
|
+
export declare type NamespaceType = string;
|
|
451
1001
|
|
|
452
|
-
/**
|
|
453
|
-
export declare interface
|
|
454
|
-
/**
|
|
455
|
-
|
|
456
|
-
/**
|
|
457
|
-
|
|
458
|
-
/** The AuthorizationRules of the created NotificationHub */
|
|
459
|
-
authorizationRules?: SharedAccessAuthorizationRuleProperties[];
|
|
460
|
-
/** The ApnsCredential of the created NotificationHub */
|
|
461
|
-
apnsCredential?: ApnsCredential;
|
|
462
|
-
/** The WnsCredential of the created NotificationHub */
|
|
463
|
-
wnsCredential?: WnsCredential;
|
|
464
|
-
/** The GcmCredential of the created NotificationHub */
|
|
465
|
-
gcmCredential?: GcmCredential;
|
|
466
|
-
/** The MpnsCredential of the created NotificationHub */
|
|
467
|
-
mpnsCredential?: MpnsCredential;
|
|
468
|
-
/** The AdmCredential of the created NotificationHub */
|
|
469
|
-
admCredential?: AdmCredential;
|
|
470
|
-
/** The BaiduCredential of the created NotificationHub */
|
|
471
|
-
baiduCredential?: BaiduCredential;
|
|
1002
|
+
/** A collection of network authorization rules. */
|
|
1003
|
+
export declare interface NetworkAcls {
|
|
1004
|
+
/** List of IP rules. */
|
|
1005
|
+
ipRules?: IpRule[];
|
|
1006
|
+
/** A default (public Internet) network authorization rule, which contains rights if no other network rule matches. */
|
|
1007
|
+
publicNetworkRule?: PublicInternetAuthorizationRule;
|
|
472
1008
|
}
|
|
473
1009
|
|
|
474
1010
|
/** The response of the List NotificationHub operation. */
|
|
475
1011
|
export declare interface NotificationHubListResult {
|
|
476
|
-
/**
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
1012
|
+
/**
|
|
1013
|
+
* Gets or sets result of the List AuthorizationRules operation.
|
|
1014
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1015
|
+
*/
|
|
1016
|
+
readonly value?: NotificationHubResource[];
|
|
1017
|
+
/**
|
|
1018
|
+
* Gets or sets link to the next set of results.
|
|
1019
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1020
|
+
*/
|
|
1021
|
+
readonly nextLink?: string;
|
|
480
1022
|
}
|
|
481
1023
|
|
|
482
|
-
/**
|
|
483
|
-
export declare interface NotificationHubPatchParameters
|
|
484
|
-
/** The
|
|
485
|
-
|
|
486
|
-
/**
|
|
1024
|
+
/** Patch parameter for NamespaceResource. */
|
|
1025
|
+
export declare interface NotificationHubPatchParameters {
|
|
1026
|
+
/** The Sku description for a namespace */
|
|
1027
|
+
sku?: Sku;
|
|
1028
|
+
/** Dictionary of <string> */
|
|
1029
|
+
tags?: {
|
|
1030
|
+
[propertyName: string]: string;
|
|
1031
|
+
};
|
|
1032
|
+
/** Gets or sets the NotificationHub name. */
|
|
1033
|
+
name?: string;
|
|
1034
|
+
/** Gets or sets the RegistrationTtl of the created NotificationHub */
|
|
487
1035
|
registrationTtl?: string;
|
|
488
|
-
/**
|
|
489
|
-
|
|
490
|
-
|
|
1036
|
+
/**
|
|
1037
|
+
* Gets or sets the AuthorizationRules of the created NotificationHub
|
|
1038
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1039
|
+
*/
|
|
1040
|
+
readonly authorizationRules?: SharedAccessAuthorizationRuleProperties[];
|
|
1041
|
+
/** Description of a NotificationHub ApnsCredential. */
|
|
491
1042
|
apnsCredential?: ApnsCredential;
|
|
492
|
-
/**
|
|
1043
|
+
/** Description of a NotificationHub WnsCredential. */
|
|
493
1044
|
wnsCredential?: WnsCredential;
|
|
494
|
-
/**
|
|
1045
|
+
/** Description of a NotificationHub GcmCredential. */
|
|
495
1046
|
gcmCredential?: GcmCredential;
|
|
496
|
-
/**
|
|
1047
|
+
/** Description of a NotificationHub MpnsCredential. */
|
|
497
1048
|
mpnsCredential?: MpnsCredential;
|
|
498
|
-
/**
|
|
1049
|
+
/** Description of a NotificationHub AdmCredential. */
|
|
499
1050
|
admCredential?: AdmCredential;
|
|
500
|
-
/**
|
|
1051
|
+
/** Description of a NotificationHub BaiduCredential. */
|
|
501
1052
|
baiduCredential?: BaiduCredential;
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
/** Description of a NotificationHub
|
|
505
|
-
|
|
506
|
-
/**
|
|
1053
|
+
/** Description of a NotificationHub BrowserCredential. */
|
|
1054
|
+
browserCredential?: BrowserCredential;
|
|
1055
|
+
/** Description of a NotificationHub XiaomiCredential. */
|
|
1056
|
+
xiaomiCredential?: XiaomiCredential;
|
|
1057
|
+
/** Description of a NotificationHub FcmV1Credential. */
|
|
1058
|
+
fcmV1Credential?: FcmV1Credential;
|
|
1059
|
+
/** NOTE: This property will not be serialized. It can only be populated by the server. */
|
|
1060
|
+
readonly dailyMaxActiveDevices?: number;
|
|
1061
|
+
}
|
|
1062
|
+
|
|
1063
|
+
/** Notification Hub Resource. */
|
|
1064
|
+
export declare interface NotificationHubResource extends TrackedResource {
|
|
1065
|
+
/** The Sku description for a namespace */
|
|
1066
|
+
sku?: Sku;
|
|
1067
|
+
/** Gets or sets the NotificationHub name. */
|
|
507
1068
|
namePropertiesName?: string;
|
|
508
|
-
/**
|
|
1069
|
+
/** Gets or sets the RegistrationTtl of the created NotificationHub */
|
|
509
1070
|
registrationTtl?: string;
|
|
510
|
-
/**
|
|
511
|
-
|
|
512
|
-
|
|
1071
|
+
/**
|
|
1072
|
+
* Gets or sets the AuthorizationRules of the created NotificationHub
|
|
1073
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1074
|
+
*/
|
|
1075
|
+
readonly authorizationRules?: SharedAccessAuthorizationRuleProperties[];
|
|
1076
|
+
/** Description of a NotificationHub ApnsCredential. */
|
|
513
1077
|
apnsCredential?: ApnsCredential;
|
|
514
|
-
/**
|
|
1078
|
+
/** Description of a NotificationHub WnsCredential. */
|
|
515
1079
|
wnsCredential?: WnsCredential;
|
|
516
|
-
/**
|
|
1080
|
+
/** Description of a NotificationHub GcmCredential. */
|
|
517
1081
|
gcmCredential?: GcmCredential;
|
|
518
|
-
/**
|
|
1082
|
+
/** Description of a NotificationHub MpnsCredential. */
|
|
519
1083
|
mpnsCredential?: MpnsCredential;
|
|
520
|
-
/**
|
|
1084
|
+
/** Description of a NotificationHub AdmCredential. */
|
|
521
1085
|
admCredential?: AdmCredential;
|
|
522
|
-
/**
|
|
1086
|
+
/** Description of a NotificationHub BaiduCredential. */
|
|
523
1087
|
baiduCredential?: BaiduCredential;
|
|
1088
|
+
/** Description of a NotificationHub BrowserCredential. */
|
|
1089
|
+
browserCredential?: BrowserCredential;
|
|
1090
|
+
/** Description of a NotificationHub XiaomiCredential. */
|
|
1091
|
+
xiaomiCredential?: XiaomiCredential;
|
|
1092
|
+
/** Description of a NotificationHub FcmV1Credential. */
|
|
1093
|
+
fcmV1Credential?: FcmV1Credential;
|
|
1094
|
+
/** NOTE: This property will not be serialized. It can only be populated by the server. */
|
|
1095
|
+
readonly dailyMaxActiveDevices?: number;
|
|
524
1096
|
}
|
|
525
1097
|
|
|
526
1098
|
/** Interface representing a NotificationHubs. */
|
|
527
1099
|
export declare interface NotificationHubs {
|
|
528
1100
|
/**
|
|
529
1101
|
* Lists the notification hubs associated with a namespace.
|
|
530
|
-
* @param resourceGroupName The name of the resource group.
|
|
531
|
-
* @param namespaceName
|
|
1102
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1103
|
+
* @param namespaceName Namespace name
|
|
532
1104
|
* @param options The options parameters.
|
|
533
1105
|
*/
|
|
534
1106
|
list(resourceGroupName: string, namespaceName: string, options?: NotificationHubsListOptionalParams): PagedAsyncIterableIterator<NotificationHubResource>;
|
|
535
1107
|
/**
|
|
536
1108
|
* Gets the authorization rules for a NotificationHub.
|
|
537
|
-
* @param resourceGroupName The name of the resource group.
|
|
538
|
-
* @param namespaceName
|
|
539
|
-
* @param notificationHubName
|
|
1109
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1110
|
+
* @param namespaceName Namespace name
|
|
1111
|
+
* @param notificationHubName Notification Hub name
|
|
540
1112
|
* @param options The options parameters.
|
|
541
1113
|
*/
|
|
542
1114
|
listAuthorizationRules(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource>;
|
|
543
1115
|
/**
|
|
544
1116
|
* Checks the availability of the given notificationHub in a namespace.
|
|
545
|
-
* @param resourceGroupName The name of the resource group.
|
|
546
|
-
* @param namespaceName
|
|
547
|
-
* @param parameters
|
|
1117
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1118
|
+
* @param namespaceName Namespace name
|
|
1119
|
+
* @param parameters Request content.
|
|
548
1120
|
* @param options The options parameters.
|
|
549
1121
|
*/
|
|
550
1122
|
checkNotificationHubAvailability(resourceGroupName: string, namespaceName: string, parameters: CheckAvailabilityParameters, options?: NotificationHubsCheckNotificationHubAvailabilityOptionalParams): Promise<NotificationHubsCheckNotificationHubAvailabilityResponse>;
|
|
1123
|
+
/**
|
|
1124
|
+
* Gets the notification hub.
|
|
1125
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1126
|
+
* @param namespaceName Namespace name
|
|
1127
|
+
* @param notificationHubName Notification Hub name
|
|
1128
|
+
* @param options The options parameters.
|
|
1129
|
+
*/
|
|
1130
|
+
get(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsGetOptionalParams): Promise<NotificationHubsGetResponse>;
|
|
551
1131
|
/**
|
|
552
1132
|
* Creates/Update a NotificationHub in a namespace.
|
|
553
|
-
* @param resourceGroupName The name of the resource group.
|
|
554
|
-
* @param namespaceName
|
|
555
|
-
* @param notificationHubName
|
|
556
|
-
* @param parameters
|
|
1133
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1134
|
+
* @param namespaceName Namespace name
|
|
1135
|
+
* @param notificationHubName Notification Hub name
|
|
1136
|
+
* @param parameters Request content.
|
|
557
1137
|
* @param options The options parameters.
|
|
558
1138
|
*/
|
|
559
|
-
createOrUpdate(resourceGroupName: string, namespaceName: string, notificationHubName: string, parameters:
|
|
1139
|
+
createOrUpdate(resourceGroupName: string, namespaceName: string, notificationHubName: string, parameters: NotificationHubResource, options?: NotificationHubsCreateOrUpdateOptionalParams): Promise<NotificationHubsCreateOrUpdateResponse>;
|
|
560
1140
|
/**
|
|
561
1141
|
* Patch a NotificationHub in a namespace.
|
|
562
|
-
* @param resourceGroupName The name of the resource group.
|
|
563
|
-
* @param namespaceName
|
|
564
|
-
* @param notificationHubName
|
|
1142
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1143
|
+
* @param namespaceName Namespace name
|
|
1144
|
+
* @param notificationHubName Notification Hub name
|
|
1145
|
+
* @param parameters Request content.
|
|
565
1146
|
* @param options The options parameters.
|
|
566
1147
|
*/
|
|
567
|
-
|
|
1148
|
+
update(resourceGroupName: string, namespaceName: string, notificationHubName: string, parameters: NotificationHubPatchParameters, options?: NotificationHubsUpdateOptionalParams): Promise<NotificationHubsUpdateResponse>;
|
|
568
1149
|
/**
|
|
569
1150
|
* Deletes a notification hub associated with a namespace.
|
|
570
|
-
* @param resourceGroupName The name of the resource group.
|
|
571
|
-
* @param namespaceName
|
|
572
|
-
* @param notificationHubName
|
|
1151
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1152
|
+
* @param namespaceName Namespace name
|
|
1153
|
+
* @param notificationHubName Notification Hub name
|
|
573
1154
|
* @param options The options parameters.
|
|
574
1155
|
*/
|
|
575
1156
|
delete(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsDeleteOptionalParams): Promise<void>;
|
|
576
1157
|
/**
|
|
577
|
-
*
|
|
578
|
-
* @param resourceGroupName The name of the resource group.
|
|
579
|
-
* @param namespaceName
|
|
580
|
-
* @param notificationHubName
|
|
581
|
-
* @param options The options parameters.
|
|
582
|
-
*/
|
|
583
|
-
get(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsGetOptionalParams): Promise<NotificationHubsGetResponse>;
|
|
584
|
-
/**
|
|
585
|
-
* test send a push notification
|
|
586
|
-
* @param resourceGroupName The name of the resource group.
|
|
587
|
-
* @param namespaceName The namespace name.
|
|
588
|
-
* @param notificationHubName The notification hub name.
|
|
1158
|
+
* Test send a push notification.
|
|
1159
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1160
|
+
* @param namespaceName Namespace name
|
|
1161
|
+
* @param notificationHubName Notification Hub name
|
|
589
1162
|
* @param options The options parameters.
|
|
590
1163
|
*/
|
|
591
1164
|
debugSend(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsDebugSendOptionalParams): Promise<NotificationHubsDebugSendResponse>;
|
|
592
1165
|
/**
|
|
593
1166
|
* Creates/Updates an authorization rule for a NotificationHub
|
|
594
|
-
* @param resourceGroupName The name of the resource group.
|
|
595
|
-
* @param namespaceName
|
|
596
|
-
* @param notificationHubName
|
|
597
|
-
* @param authorizationRuleName Authorization Rule Name
|
|
598
|
-
* @param parameters
|
|
1167
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1168
|
+
* @param namespaceName Namespace name
|
|
1169
|
+
* @param notificationHubName Notification Hub name
|
|
1170
|
+
* @param authorizationRuleName Authorization Rule Name
|
|
1171
|
+
* @param parameters Request content.
|
|
599
1172
|
* @param options The options parameters.
|
|
600
1173
|
*/
|
|
601
|
-
createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, parameters:
|
|
1174
|
+
createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, parameters: SharedAccessAuthorizationRuleResource, options?: NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams): Promise<NotificationHubsCreateOrUpdateAuthorizationRuleResponse>;
|
|
602
1175
|
/**
|
|
603
1176
|
* Deletes a notificationHub authorization rule
|
|
604
|
-
* @param resourceGroupName The name of the resource group.
|
|
605
|
-
* @param namespaceName
|
|
606
|
-
* @param notificationHubName
|
|
607
|
-
* @param authorizationRuleName Authorization Rule Name
|
|
1177
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1178
|
+
* @param namespaceName Namespace name
|
|
1179
|
+
* @param notificationHubName Notification Hub name
|
|
1180
|
+
* @param authorizationRuleName Authorization Rule Name
|
|
608
1181
|
* @param options The options parameters.
|
|
609
1182
|
*/
|
|
610
1183
|
deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: NotificationHubsDeleteAuthorizationRuleOptionalParams): Promise<void>;
|
|
611
1184
|
/**
|
|
612
1185
|
* Gets an authorization rule for a NotificationHub by name.
|
|
613
|
-
* @param resourceGroupName The name of the resource group.
|
|
614
|
-
* @param namespaceName
|
|
615
|
-
* @param notificationHubName
|
|
616
|
-
* @param authorizationRuleName
|
|
1186
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1187
|
+
* @param namespaceName Namespace name
|
|
1188
|
+
* @param notificationHubName Notification Hub name
|
|
1189
|
+
* @param authorizationRuleName Authorization Rule Name
|
|
617
1190
|
* @param options The options parameters.
|
|
618
1191
|
*/
|
|
619
1192
|
getAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: NotificationHubsGetAuthorizationRuleOptionalParams): Promise<NotificationHubsGetAuthorizationRuleResponse>;
|
|
620
1193
|
/**
|
|
621
1194
|
* Gets the Primary and Secondary ConnectionStrings to the NotificationHub
|
|
622
|
-
* @param resourceGroupName The name of the resource group.
|
|
623
|
-
* @param namespaceName
|
|
624
|
-
* @param notificationHubName
|
|
625
|
-
* @param authorizationRuleName
|
|
626
|
-
* authorizationRule.
|
|
1195
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1196
|
+
* @param namespaceName Namespace name
|
|
1197
|
+
* @param notificationHubName Notification Hub name
|
|
1198
|
+
* @param authorizationRuleName Authorization Rule Name
|
|
627
1199
|
* @param options The options parameters.
|
|
628
1200
|
*/
|
|
629
1201
|
listKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: NotificationHubsListKeysOptionalParams): Promise<NotificationHubsListKeysResponse>;
|
|
630
1202
|
/**
|
|
631
|
-
* Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule
|
|
632
|
-
* @param resourceGroupName The name of the resource group.
|
|
633
|
-
* @param namespaceName
|
|
634
|
-
* @param notificationHubName
|
|
635
|
-
* @param authorizationRuleName
|
|
636
|
-
*
|
|
637
|
-
* @param
|
|
1203
|
+
* Regenerates the Primary/Secondary Keys to the NotificationHub Authorization Rule
|
|
1204
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1205
|
+
* @param namespaceName Namespace name
|
|
1206
|
+
* @param notificationHubName Notification Hub name
|
|
1207
|
+
* @param authorizationRuleName Authorization Rule Name
|
|
1208
|
+
* @param parameters Request content.
|
|
1209
|
+
* @param options The options parameters.
|
|
1210
|
+
*/
|
|
1211
|
+
regenerateKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, parameters: PolicyKeyResource, options?: NotificationHubsRegenerateKeysOptionalParams): Promise<NotificationHubsRegenerateKeysResponse>;
|
|
1212
|
+
/**
|
|
1213
|
+
* Lists the PNS Credentials associated with a notification hub.
|
|
1214
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1215
|
+
* @param namespaceName Namespace name
|
|
1216
|
+
* @param notificationHubName Notification Hub name
|
|
1217
|
+
* @param options The options parameters.
|
|
1218
|
+
*/
|
|
1219
|
+
getPnsCredentials(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsGetPnsCredentialsOptionalParams): Promise<NotificationHubsGetPnsCredentialsResponse>;
|
|
1220
|
+
}
|
|
1221
|
+
|
|
1222
|
+
/** Optional parameters. */
|
|
1223
|
+
export declare interface NotificationHubsCheckNotificationHubAvailabilityOptionalParams extends coreClient.OperationOptions {
|
|
1224
|
+
}
|
|
1225
|
+
|
|
1226
|
+
/** Contains response data for the checkNotificationHubAvailability operation. */
|
|
1227
|
+
export declare type NotificationHubsCheckNotificationHubAvailabilityResponse = CheckAvailabilityResult;
|
|
1228
|
+
|
|
1229
|
+
/** Optional parameters. */
|
|
1230
|
+
export declare interface NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
|
|
1231
|
+
}
|
|
1232
|
+
|
|
1233
|
+
/** Contains response data for the createOrUpdateAuthorizationRule operation. */
|
|
1234
|
+
export declare type NotificationHubsCreateOrUpdateAuthorizationRuleResponse = SharedAccessAuthorizationRuleResource;
|
|
1235
|
+
|
|
1236
|
+
/** Optional parameters. */
|
|
1237
|
+
export declare interface NotificationHubsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1238
|
+
}
|
|
1239
|
+
|
|
1240
|
+
/** Contains response data for the createOrUpdate operation. */
|
|
1241
|
+
export declare type NotificationHubsCreateOrUpdateResponse = NotificationHubResource;
|
|
1242
|
+
|
|
1243
|
+
/** Optional parameters. */
|
|
1244
|
+
export declare interface NotificationHubsDebugSendOptionalParams extends coreClient.OperationOptions {
|
|
1245
|
+
}
|
|
1246
|
+
|
|
1247
|
+
/** Contains response data for the debugSend operation. */
|
|
1248
|
+
export declare type NotificationHubsDebugSendResponse = DebugSendResponse;
|
|
1249
|
+
|
|
1250
|
+
/** Optional parameters. */
|
|
1251
|
+
export declare interface NotificationHubsDeleteAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
|
|
1252
|
+
}
|
|
1253
|
+
|
|
1254
|
+
/** Optional parameters. */
|
|
1255
|
+
export declare interface NotificationHubsDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1256
|
+
}
|
|
1257
|
+
|
|
1258
|
+
/** Optional parameters. */
|
|
1259
|
+
export declare interface NotificationHubsGetAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
|
|
1260
|
+
}
|
|
1261
|
+
|
|
1262
|
+
/** Contains response data for the getAuthorizationRule operation. */
|
|
1263
|
+
export declare type NotificationHubsGetAuthorizationRuleResponse = SharedAccessAuthorizationRuleResource;
|
|
1264
|
+
|
|
1265
|
+
/** Optional parameters. */
|
|
1266
|
+
export declare interface NotificationHubsGetOptionalParams extends coreClient.OperationOptions {
|
|
1267
|
+
}
|
|
1268
|
+
|
|
1269
|
+
/** Optional parameters. */
|
|
1270
|
+
export declare interface NotificationHubsGetPnsCredentialsOptionalParams extends coreClient.OperationOptions {
|
|
1271
|
+
}
|
|
1272
|
+
|
|
1273
|
+
/** Contains response data for the getPnsCredentials operation. */
|
|
1274
|
+
export declare type NotificationHubsGetPnsCredentialsResponse = PnsCredentialsResource;
|
|
1275
|
+
|
|
1276
|
+
/** Contains response data for the get operation. */
|
|
1277
|
+
export declare type NotificationHubsGetResponse = NotificationHubResource;
|
|
1278
|
+
|
|
1279
|
+
/** Optional parameters. */
|
|
1280
|
+
export declare interface NotificationHubsListAuthorizationRulesNextOptionalParams extends coreClient.OperationOptions {
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
/** Contains response data for the listAuthorizationRulesNext operation. */
|
|
1284
|
+
export declare type NotificationHubsListAuthorizationRulesNextResponse = SharedAccessAuthorizationRuleListResult;
|
|
1285
|
+
|
|
1286
|
+
/** Optional parameters. */
|
|
1287
|
+
export declare interface NotificationHubsListAuthorizationRulesOptionalParams extends coreClient.OperationOptions {
|
|
1288
|
+
}
|
|
1289
|
+
|
|
1290
|
+
/** Contains response data for the listAuthorizationRules operation. */
|
|
1291
|
+
export declare type NotificationHubsListAuthorizationRulesResponse = SharedAccessAuthorizationRuleListResult;
|
|
1292
|
+
|
|
1293
|
+
/** Optional parameters. */
|
|
1294
|
+
export declare interface NotificationHubsListKeysOptionalParams extends coreClient.OperationOptions {
|
|
1295
|
+
}
|
|
1296
|
+
|
|
1297
|
+
/** Contains response data for the listKeys operation. */
|
|
1298
|
+
export declare type NotificationHubsListKeysResponse = ResourceListKeys;
|
|
1299
|
+
|
|
1300
|
+
/** Optional parameters. */
|
|
1301
|
+
export declare interface NotificationHubsListNextOptionalParams extends coreClient.OperationOptions {
|
|
1302
|
+
}
|
|
1303
|
+
|
|
1304
|
+
/** Contains response data for the listNext operation. */
|
|
1305
|
+
export declare type NotificationHubsListNextResponse = NotificationHubListResult;
|
|
1306
|
+
|
|
1307
|
+
/** Optional parameters. */
|
|
1308
|
+
export declare interface NotificationHubsListOptionalParams extends coreClient.OperationOptions {
|
|
1309
|
+
/** Continuation token. */
|
|
1310
|
+
skipToken?: string;
|
|
1311
|
+
/** Page size. */
|
|
1312
|
+
top?: number;
|
|
1313
|
+
}
|
|
1314
|
+
|
|
1315
|
+
/** Contains response data for the list operation. */
|
|
1316
|
+
export declare type NotificationHubsListResponse = NotificationHubListResult;
|
|
1317
|
+
|
|
1318
|
+
export declare class NotificationHubsManagementClient extends coreClient.ServiceClient {
|
|
1319
|
+
$host: string;
|
|
1320
|
+
subscriptionId: string;
|
|
1321
|
+
apiVersion: string;
|
|
1322
|
+
/**
|
|
1323
|
+
* Initializes a new instance of the NotificationHubsManagementClient class.
|
|
1324
|
+
* @param credentials Subscription credentials which uniquely identify client subscription.
|
|
1325
|
+
* @param subscriptionId The ID of the target subscription. The value must be an UUID.
|
|
1326
|
+
* @param options The parameter options
|
|
1327
|
+
*/
|
|
1328
|
+
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: NotificationHubsManagementClientOptionalParams);
|
|
1329
|
+
/** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
|
|
1330
|
+
private addCustomApiVersionPolicy;
|
|
1331
|
+
notificationHubs: NotificationHubs;
|
|
1332
|
+
namespaces: Namespaces;
|
|
1333
|
+
operations: Operations;
|
|
1334
|
+
privateEndpointConnections: PrivateEndpointConnections;
|
|
1335
|
+
}
|
|
1336
|
+
|
|
1337
|
+
/** Optional parameters. */
|
|
1338
|
+
export declare interface NotificationHubsManagementClientOptionalParams extends coreClient.ServiceClientOptions {
|
|
1339
|
+
/** server parameter */
|
|
1340
|
+
$host?: string;
|
|
1341
|
+
/** Api Version */
|
|
1342
|
+
apiVersion?: string;
|
|
1343
|
+
/** Overrides client endpoint. */
|
|
1344
|
+
endpoint?: string;
|
|
1345
|
+
}
|
|
1346
|
+
|
|
1347
|
+
/** Optional parameters. */
|
|
1348
|
+
export declare interface NotificationHubsRegenerateKeysOptionalParams extends coreClient.OperationOptions {
|
|
1349
|
+
}
|
|
1350
|
+
|
|
1351
|
+
/** Contains response data for the regenerateKeys operation. */
|
|
1352
|
+
export declare type NotificationHubsRegenerateKeysResponse = ResourceListKeys;
|
|
1353
|
+
|
|
1354
|
+
/** Optional parameters. */
|
|
1355
|
+
export declare interface NotificationHubsUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1356
|
+
}
|
|
1357
|
+
|
|
1358
|
+
/** Contains response data for the update operation. */
|
|
1359
|
+
export declare type NotificationHubsUpdateResponse = NotificationHubResource;
|
|
1360
|
+
|
|
1361
|
+
/** A NotificationHubs REST API operation */
|
|
1362
|
+
export declare interface Operation {
|
|
1363
|
+
/**
|
|
1364
|
+
* Gets operation name: {provider}/{resource}/{operation}
|
|
1365
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1366
|
+
*/
|
|
1367
|
+
readonly name?: string;
|
|
1368
|
+
/** The object that represents the operation. */
|
|
1369
|
+
display?: OperationDisplay;
|
|
1370
|
+
/** Optional operation properties. */
|
|
1371
|
+
properties?: OperationProperties;
|
|
1372
|
+
/**
|
|
1373
|
+
* Gets or sets IsDataAction property. It is used to differentiate management and data plane operations.
|
|
1374
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1375
|
+
*/
|
|
1376
|
+
readonly isDataAction?: boolean;
|
|
1377
|
+
}
|
|
1378
|
+
|
|
1379
|
+
/** The object that represents the operation. */
|
|
1380
|
+
export declare interface OperationDisplay {
|
|
1381
|
+
/**
|
|
1382
|
+
* Gets service provider: Microsoft.NotificationHubs
|
|
1383
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1384
|
+
*/
|
|
1385
|
+
readonly provider?: string;
|
|
1386
|
+
/**
|
|
1387
|
+
* Gets resource on which the operation is performed: Invoice, etc.
|
|
1388
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1389
|
+
*/
|
|
1390
|
+
readonly resource?: string;
|
|
1391
|
+
/**
|
|
1392
|
+
* Gets operation type: Read, write, delete, etc.
|
|
1393
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1394
|
+
*/
|
|
1395
|
+
readonly operation?: string;
|
|
1396
|
+
/**
|
|
1397
|
+
* Human-friendly operation description.
|
|
1398
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1399
|
+
*/
|
|
1400
|
+
readonly description?: string;
|
|
1401
|
+
}
|
|
1402
|
+
|
|
1403
|
+
/**
|
|
1404
|
+
* Result of the request to list NotificationHubs operations. It contains
|
|
1405
|
+
* a list of operations and a URL link to get the next set of results.
|
|
1406
|
+
*/
|
|
1407
|
+
export declare interface OperationListResult {
|
|
1408
|
+
/**
|
|
1409
|
+
* Gets list of NotificationHubs operations supported by the
|
|
1410
|
+
* Microsoft.NotificationHubs resource provider.
|
|
1411
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1412
|
+
*/
|
|
1413
|
+
readonly value?: Operation[];
|
|
1414
|
+
/**
|
|
1415
|
+
* Gets URL to get the next set of operation list results if there are
|
|
1416
|
+
* any.
|
|
1417
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1418
|
+
*/
|
|
1419
|
+
readonly nextLink?: string;
|
|
1420
|
+
}
|
|
1421
|
+
|
|
1422
|
+
/** Optional operation properties. */
|
|
1423
|
+
export declare interface OperationProperties {
|
|
1424
|
+
/** Optional service specification used in Operations API. */
|
|
1425
|
+
serviceSpecification?: ServiceSpecification;
|
|
1426
|
+
}
|
|
1427
|
+
|
|
1428
|
+
/**
|
|
1429
|
+
* Defines values for OperationProvisioningState. \
|
|
1430
|
+
* {@link KnownOperationProvisioningState} can be used interchangeably with OperationProvisioningState,
|
|
1431
|
+
* this enum contains the known values that the service supports.
|
|
1432
|
+
* ### Known values supported by the service
|
|
1433
|
+
* **Unknown** \
|
|
1434
|
+
* **InProgress** \
|
|
1435
|
+
* **Succeeded** \
|
|
1436
|
+
* **Failed** \
|
|
1437
|
+
* **Canceled** \
|
|
1438
|
+
* **Pending** \
|
|
1439
|
+
* **Disabled**
|
|
1440
|
+
*/
|
|
1441
|
+
export declare type OperationProvisioningState = string;
|
|
1442
|
+
|
|
1443
|
+
/** Interface representing a Operations. */
|
|
1444
|
+
export declare interface Operations {
|
|
1445
|
+
/**
|
|
1446
|
+
* Lists all available Notification Hubs operations.
|
|
1447
|
+
* @param options The options parameters.
|
|
1448
|
+
*/
|
|
1449
|
+
list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
|
|
1450
|
+
}
|
|
1451
|
+
|
|
1452
|
+
/** Optional parameters. */
|
|
1453
|
+
export declare interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
|
|
1454
|
+
}
|
|
1455
|
+
|
|
1456
|
+
/** Contains response data for the listNext operation. */
|
|
1457
|
+
export declare type OperationsListNextResponse = OperationListResult;
|
|
1458
|
+
|
|
1459
|
+
/** Optional parameters. */
|
|
1460
|
+
export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
|
|
1461
|
+
}
|
|
1462
|
+
|
|
1463
|
+
/** Contains response data for the list operation. */
|
|
1464
|
+
export declare type OperationsListResponse = OperationListResult;
|
|
1465
|
+
|
|
1466
|
+
/** Collection of Notification Hub or Notification Hub Namespace PNS credentials. */
|
|
1467
|
+
export declare interface PnsCredentials {
|
|
1468
|
+
/** Description of a NotificationHub AdmCredential. */
|
|
1469
|
+
admCredential?: AdmCredential;
|
|
1470
|
+
/** Description of a NotificationHub ApnsCredential. */
|
|
1471
|
+
apnsCredential?: ApnsCredential;
|
|
1472
|
+
/** Description of a NotificationHub BaiduCredential. */
|
|
1473
|
+
baiduCredential?: BaiduCredential;
|
|
1474
|
+
/** Description of a NotificationHub BrowserCredential. */
|
|
1475
|
+
browserCredential?: BrowserCredential;
|
|
1476
|
+
/** Description of a NotificationHub GcmCredential. */
|
|
1477
|
+
gcmCredential?: GcmCredential;
|
|
1478
|
+
/** Description of a NotificationHub MpnsCredential. */
|
|
1479
|
+
mpnsCredential?: MpnsCredential;
|
|
1480
|
+
/** Description of a NotificationHub WnsCredential. */
|
|
1481
|
+
wnsCredential?: WnsCredential;
|
|
1482
|
+
/** Description of a NotificationHub XiaomiCredential. */
|
|
1483
|
+
xiaomiCredential?: XiaomiCredential;
|
|
1484
|
+
/** Description of a NotificationHub FcmV1Credential. */
|
|
1485
|
+
fcmV1Credential?: FcmV1Credential;
|
|
1486
|
+
}
|
|
1487
|
+
|
|
1488
|
+
/**
|
|
1489
|
+
* Description of a NotificationHub PNS Credentials. This is a response of the POST requests that return namespace or hubs
|
|
1490
|
+
* PNS credentials.
|
|
1491
|
+
*/
|
|
1492
|
+
export declare interface PnsCredentialsResource extends ProxyResource {
|
|
1493
|
+
/** Deprecated - only for compatibility. */
|
|
1494
|
+
location?: string;
|
|
1495
|
+
/** Deprecated - only for compatibility. */
|
|
1496
|
+
tags?: {
|
|
1497
|
+
[propertyName: string]: string;
|
|
1498
|
+
};
|
|
1499
|
+
/** Description of a NotificationHub AdmCredential. */
|
|
1500
|
+
admCredential?: AdmCredential;
|
|
1501
|
+
/** Description of a NotificationHub ApnsCredential. */
|
|
1502
|
+
apnsCredential?: ApnsCredential;
|
|
1503
|
+
/** Description of a NotificationHub BaiduCredential. */
|
|
1504
|
+
baiduCredential?: BaiduCredential;
|
|
1505
|
+
/** Description of a NotificationHub BrowserCredential. */
|
|
1506
|
+
browserCredential?: BrowserCredential;
|
|
1507
|
+
/** Description of a NotificationHub GcmCredential. */
|
|
1508
|
+
gcmCredential?: GcmCredential;
|
|
1509
|
+
/** Description of a NotificationHub MpnsCredential. */
|
|
1510
|
+
mpnsCredential?: MpnsCredential;
|
|
1511
|
+
/** Description of a NotificationHub WnsCredential. */
|
|
1512
|
+
wnsCredential?: WnsCredential;
|
|
1513
|
+
/** Description of a NotificationHub XiaomiCredential. */
|
|
1514
|
+
xiaomiCredential?: XiaomiCredential;
|
|
1515
|
+
/** Description of a NotificationHub FcmV1Credential. */
|
|
1516
|
+
fcmV1Credential?: FcmV1Credential;
|
|
1517
|
+
}
|
|
1518
|
+
|
|
1519
|
+
/** Namespace / NotificationHub Regenerate Keys request. */
|
|
1520
|
+
export declare interface PolicyKeyResource {
|
|
1521
|
+
/** Type of Shared Access Policy Key (primary or secondary). */
|
|
1522
|
+
policyKey: PolicyKeyType;
|
|
1523
|
+
}
|
|
1524
|
+
|
|
1525
|
+
/**
|
|
1526
|
+
* Defines values for PolicyKeyType. \
|
|
1527
|
+
* {@link KnownPolicyKeyType} can be used interchangeably with PolicyKeyType,
|
|
1528
|
+
* this enum contains the known values that the service supports.
|
|
1529
|
+
* ### Known values supported by the service
|
|
1530
|
+
* **PrimaryKey** \
|
|
1531
|
+
* **SecondaryKey**
|
|
1532
|
+
*/
|
|
1533
|
+
export declare type PolicyKeyType = string;
|
|
1534
|
+
|
|
1535
|
+
/** Private Endpoint Connection properties. */
|
|
1536
|
+
export declare interface PrivateEndpointConnectionProperties {
|
|
1537
|
+
/** State of Private Endpoint Connection. */
|
|
1538
|
+
provisioningState?: PrivateEndpointConnectionProvisioningState;
|
|
1539
|
+
/** Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. */
|
|
1540
|
+
privateEndpoint?: RemotePrivateEndpointConnection;
|
|
1541
|
+
/**
|
|
1542
|
+
* List of group ids. For Notification Hubs, it always contains a single "namespace" element.
|
|
1543
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1544
|
+
*/
|
|
1545
|
+
readonly groupIds?: string[];
|
|
1546
|
+
/** State of the Private Link Service connection. */
|
|
1547
|
+
privateLinkServiceConnectionState?: RemotePrivateLinkServiceConnectionState;
|
|
1548
|
+
}
|
|
1549
|
+
|
|
1550
|
+
/**
|
|
1551
|
+
* Defines values for PrivateEndpointConnectionProvisioningState. \
|
|
1552
|
+
* {@link KnownPrivateEndpointConnectionProvisioningState} can be used interchangeably with PrivateEndpointConnectionProvisioningState,
|
|
1553
|
+
* this enum contains the known values that the service supports.
|
|
1554
|
+
* ### Known values supported by the service
|
|
1555
|
+
* **Unknown** \
|
|
1556
|
+
* **Succeeded** \
|
|
1557
|
+
* **Creating** \
|
|
1558
|
+
* **Updating** \
|
|
1559
|
+
* **UpdatingByProxy** \
|
|
1560
|
+
* **Deleting** \
|
|
1561
|
+
* **DeletingByProxy** \
|
|
1562
|
+
* **Deleted**
|
|
1563
|
+
*/
|
|
1564
|
+
export declare type PrivateEndpointConnectionProvisioningState = string;
|
|
1565
|
+
|
|
1566
|
+
/** Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace. */
|
|
1567
|
+
export declare interface PrivateEndpointConnectionResource extends ProxyResource {
|
|
1568
|
+
/** Private Endpoint Connection properties. */
|
|
1569
|
+
properties?: PrivateEndpointConnectionProperties;
|
|
1570
|
+
}
|
|
1571
|
+
|
|
1572
|
+
/** The response of the List Private Endpoint Connections operation. */
|
|
1573
|
+
export declare interface PrivateEndpointConnectionResourceListResult {
|
|
1574
|
+
/**
|
|
1575
|
+
* Gets or sets result of the List AuthorizationRules operation.
|
|
1576
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1577
|
+
*/
|
|
1578
|
+
readonly value?: PrivateEndpointConnectionResource[];
|
|
1579
|
+
/**
|
|
1580
|
+
* Gets or sets link to the next set of results.
|
|
1581
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1582
|
+
*/
|
|
1583
|
+
readonly nextLink?: string;
|
|
1584
|
+
}
|
|
1585
|
+
|
|
1586
|
+
/** Interface representing a PrivateEndpointConnections. */
|
|
1587
|
+
export declare interface PrivateEndpointConnections {
|
|
1588
|
+
/**
|
|
1589
|
+
* Returns all Private Endpoint Connections that belong to the given Notification Hubs namespace.
|
|
1590
|
+
* This is a public API that can be called directly by Notification Hubs users.
|
|
1591
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1592
|
+
* @param namespaceName Namespace name
|
|
1593
|
+
* @param options The options parameters.
|
|
1594
|
+
*/
|
|
1595
|
+
list(resourceGroupName: string, namespaceName: string, options?: PrivateEndpointConnectionsListOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnectionResource>;
|
|
1596
|
+
/**
|
|
1597
|
+
* Even though this namespace requires subscription id, resource group and namespace name, it returns a
|
|
1598
|
+
* constant payload (for a given namespacE) every time it's called.
|
|
1599
|
+
* That's why we don't send it to the sibling RP, but process it directly in the scale unit that
|
|
1600
|
+
* received the request.
|
|
1601
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1602
|
+
* @param namespaceName Namespace name
|
|
1603
|
+
* @param options The options parameters.
|
|
1604
|
+
*/
|
|
1605
|
+
listGroupIds(resourceGroupName: string, namespaceName: string, options?: PrivateEndpointConnectionsListGroupIdsOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>;
|
|
1606
|
+
/**
|
|
1607
|
+
* Approves or rejects Private Endpoint Connection.
|
|
1608
|
+
* This is a public API that can be called directly by Notification Hubs users.
|
|
1609
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1610
|
+
* @param namespaceName Namespace name
|
|
1611
|
+
* @param privateEndpointConnectionName Private Endpoint Connection Name
|
|
1612
|
+
* @param parameters Description of the Private Endpoint Connection resource.
|
|
1613
|
+
* @param options The options parameters.
|
|
1614
|
+
*/
|
|
1615
|
+
beginUpdate(resourceGroupName: string, namespaceName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnectionResource, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionsUpdateResponse>, PrivateEndpointConnectionsUpdateResponse>>;
|
|
1616
|
+
/**
|
|
1617
|
+
* Approves or rejects Private Endpoint Connection.
|
|
1618
|
+
* This is a public API that can be called directly by Notification Hubs users.
|
|
1619
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1620
|
+
* @param namespaceName Namespace name
|
|
1621
|
+
* @param privateEndpointConnectionName Private Endpoint Connection Name
|
|
1622
|
+
* @param parameters Description of the Private Endpoint Connection resource.
|
|
1623
|
+
* @param options The options parameters.
|
|
1624
|
+
*/
|
|
1625
|
+
beginUpdateAndWait(resourceGroupName: string, namespaceName: string, privateEndpointConnectionName: string, parameters: PrivateEndpointConnectionResource, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<PrivateEndpointConnectionsUpdateResponse>;
|
|
1626
|
+
/**
|
|
1627
|
+
* Deletes the Private Endpoint Connection.
|
|
1628
|
+
* This is a public API that can be called directly by Notification Hubs users.
|
|
1629
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1630
|
+
* @param namespaceName Namespace name
|
|
1631
|
+
* @param privateEndpointConnectionName Private Endpoint Connection Name
|
|
1632
|
+
* @param options The options parameters.
|
|
1633
|
+
*/
|
|
1634
|
+
beginDelete(resourceGroupName: string, namespaceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionsDeleteResponse>, PrivateEndpointConnectionsDeleteResponse>>;
|
|
1635
|
+
/**
|
|
1636
|
+
* Deletes the Private Endpoint Connection.
|
|
1637
|
+
* This is a public API that can be called directly by Notification Hubs users.
|
|
1638
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1639
|
+
* @param namespaceName Namespace name
|
|
1640
|
+
* @param privateEndpointConnectionName Private Endpoint Connection Name
|
|
1641
|
+
* @param options The options parameters.
|
|
1642
|
+
*/
|
|
1643
|
+
beginDeleteAndWait(resourceGroupName: string, namespaceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnectionsDeleteResponse>;
|
|
1644
|
+
/**
|
|
1645
|
+
* Returns a Private Endpoint Connection with a given name.
|
|
1646
|
+
* This is a public API that can be called directly by Notification Hubs users.
|
|
1647
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1648
|
+
* @param namespaceName Namespace name
|
|
1649
|
+
* @param privateEndpointConnectionName Private Endpoint Connection Name
|
|
638
1650
|
* @param options The options parameters.
|
|
639
1651
|
*/
|
|
640
|
-
|
|
1652
|
+
get(resourceGroupName: string, namespaceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
|
|
641
1653
|
/**
|
|
642
|
-
*
|
|
643
|
-
*
|
|
644
|
-
*
|
|
645
|
-
*
|
|
1654
|
+
* Even though this namespace requires subscription id, resource group and namespace name, it returns a
|
|
1655
|
+
* constant payload (for a given namespacE) every time it's called.
|
|
1656
|
+
* That's why we don't send it to the sibling RP, but process it directly in the scale unit that
|
|
1657
|
+
* received the request.
|
|
1658
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1659
|
+
* @param namespaceName Namespace name
|
|
1660
|
+
* @param subResourceName Name of the Private Link sub-resource. The only supported sub-resource is
|
|
1661
|
+
* "namespace"
|
|
646
1662
|
* @param options The options parameters.
|
|
647
1663
|
*/
|
|
648
|
-
|
|
649
|
-
}
|
|
650
|
-
|
|
651
|
-
/** Optional parameters. */
|
|
652
|
-
export declare interface NotificationHubsCheckNotificationHubAvailabilityOptionalParams extends coreClient.OperationOptions {
|
|
653
|
-
}
|
|
654
|
-
|
|
655
|
-
/** Contains response data for the checkNotificationHubAvailability operation. */
|
|
656
|
-
export declare type NotificationHubsCheckNotificationHubAvailabilityResponse = CheckAvailabilityResult;
|
|
657
|
-
|
|
658
|
-
/** Optional parameters. */
|
|
659
|
-
export declare interface NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams extends coreClient.OperationOptions {
|
|
660
|
-
}
|
|
661
|
-
|
|
662
|
-
/** Contains response data for the createOrUpdateAuthorizationRule operation. */
|
|
663
|
-
export declare type NotificationHubsCreateOrUpdateAuthorizationRuleResponse = SharedAccessAuthorizationRuleResource;
|
|
664
|
-
|
|
665
|
-
/** Optional parameters. */
|
|
666
|
-
export declare interface NotificationHubsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1664
|
+
getGroupId(resourceGroupName: string, namespaceName: string, subResourceName: string, options?: PrivateEndpointConnectionsGetGroupIdOptionalParams): Promise<PrivateEndpointConnectionsGetGroupIdResponse>;
|
|
667
1665
|
}
|
|
668
1666
|
|
|
669
|
-
/**
|
|
670
|
-
export declare
|
|
671
|
-
|
|
672
|
-
/** Optional parameters. */
|
|
673
|
-
export declare interface NotificationHubsDebugSendOptionalParams extends coreClient.OperationOptions {
|
|
674
|
-
/** Debug send parameters */
|
|
675
|
-
parameters?: Record<string, unknown>;
|
|
1667
|
+
/** Defines headers for PrivateEndpointConnections_delete operation. */
|
|
1668
|
+
export declare interface PrivateEndpointConnectionsDeleteHeaders {
|
|
1669
|
+
location?: string;
|
|
676
1670
|
}
|
|
677
1671
|
|
|
678
|
-
/** Contains response data for the debugSend operation. */
|
|
679
|
-
export declare type NotificationHubsDebugSendResponse = DebugSendResponse;
|
|
680
|
-
|
|
681
1672
|
/** Optional parameters. */
|
|
682
|
-
export declare interface
|
|
1673
|
+
export declare interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1674
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1675
|
+
updateIntervalInMs?: number;
|
|
1676
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1677
|
+
resumeFrom?: string;
|
|
683
1678
|
}
|
|
684
1679
|
|
|
685
|
-
/**
|
|
686
|
-
export declare
|
|
687
|
-
}
|
|
1680
|
+
/** Contains response data for the delete operation. */
|
|
1681
|
+
export declare type PrivateEndpointConnectionsDeleteResponse = PrivateEndpointConnectionsDeleteHeaders;
|
|
688
1682
|
|
|
689
1683
|
/** Optional parameters. */
|
|
690
|
-
export declare interface
|
|
1684
|
+
export declare interface PrivateEndpointConnectionsGetGroupIdOptionalParams extends coreClient.OperationOptions {
|
|
691
1685
|
}
|
|
692
1686
|
|
|
693
|
-
/** Contains response data for the
|
|
694
|
-
export declare type
|
|
695
|
-
|
|
696
|
-
/** Optional parameters. */
|
|
697
|
-
export declare interface NotificationHubsGetOptionalParams extends coreClient.OperationOptions {
|
|
698
|
-
}
|
|
1687
|
+
/** Contains response data for the getGroupId operation. */
|
|
1688
|
+
export declare type PrivateEndpointConnectionsGetGroupIdResponse = PrivateLinkResource;
|
|
699
1689
|
|
|
700
1690
|
/** Optional parameters. */
|
|
701
|
-
export declare interface
|
|
1691
|
+
export declare interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
|
|
702
1692
|
}
|
|
703
1693
|
|
|
704
|
-
/** Contains response data for the getPnsCredentials operation. */
|
|
705
|
-
export declare type NotificationHubsGetPnsCredentialsResponse = PnsCredentialsResource;
|
|
706
|
-
|
|
707
1694
|
/** Contains response data for the get operation. */
|
|
708
|
-
export declare type
|
|
1695
|
+
export declare type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnectionResource;
|
|
709
1696
|
|
|
710
1697
|
/** Optional parameters. */
|
|
711
|
-
export declare interface
|
|
1698
|
+
export declare interface PrivateEndpointConnectionsListGroupIdsOptionalParams extends coreClient.OperationOptions {
|
|
712
1699
|
}
|
|
713
1700
|
|
|
714
|
-
/** Contains response data for the
|
|
715
|
-
export declare type
|
|
1701
|
+
/** Contains response data for the listGroupIds operation. */
|
|
1702
|
+
export declare type PrivateEndpointConnectionsListGroupIdsResponse = PrivateLinkResourceListResult;
|
|
716
1703
|
|
|
717
1704
|
/** Optional parameters. */
|
|
718
|
-
export declare interface
|
|
1705
|
+
export declare interface PrivateEndpointConnectionsListOptionalParams extends coreClient.OperationOptions {
|
|
719
1706
|
}
|
|
720
1707
|
|
|
721
|
-
/** Contains response data for the
|
|
722
|
-
export declare type
|
|
1708
|
+
/** Contains response data for the list operation. */
|
|
1709
|
+
export declare type PrivateEndpointConnectionsListResponse = PrivateEndpointConnectionResourceListResult;
|
|
723
1710
|
|
|
724
1711
|
/** Optional parameters. */
|
|
725
|
-
export declare interface
|
|
1712
|
+
export declare interface PrivateEndpointConnectionsUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1713
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1714
|
+
updateIntervalInMs?: number;
|
|
1715
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1716
|
+
resumeFrom?: string;
|
|
726
1717
|
}
|
|
727
1718
|
|
|
728
|
-
/** Contains response data for the
|
|
729
|
-
export declare type
|
|
730
|
-
|
|
731
|
-
/** Optional parameters. */
|
|
732
|
-
export declare interface NotificationHubsListNextOptionalParams extends coreClient.OperationOptions {
|
|
733
|
-
}
|
|
1719
|
+
/** Contains response data for the update operation. */
|
|
1720
|
+
export declare type PrivateEndpointConnectionsUpdateResponse = PrivateEndpointConnectionResource;
|
|
734
1721
|
|
|
735
|
-
/**
|
|
736
|
-
|
|
1722
|
+
/**
|
|
1723
|
+
* Defines values for PrivateLinkConnectionStatus. \
|
|
1724
|
+
* {@link KnownPrivateLinkConnectionStatus} can be used interchangeably with PrivateLinkConnectionStatus,
|
|
1725
|
+
* this enum contains the known values that the service supports.
|
|
1726
|
+
* ### Known values supported by the service
|
|
1727
|
+
* **Disconnected** \
|
|
1728
|
+
* **Pending** \
|
|
1729
|
+
* **Approved** \
|
|
1730
|
+
* **Rejected**
|
|
1731
|
+
*/
|
|
1732
|
+
export declare type PrivateLinkConnectionStatus = string;
|
|
737
1733
|
|
|
738
|
-
/**
|
|
739
|
-
export declare interface
|
|
1734
|
+
/** A Private Link Arm Resource. */
|
|
1735
|
+
export declare interface PrivateLinkResource extends ProxyResource {
|
|
1736
|
+
/** Represents properties of Private Link Resource. */
|
|
1737
|
+
properties?: PrivateLinkResourceProperties;
|
|
740
1738
|
}
|
|
741
1739
|
|
|
742
|
-
/**
|
|
743
|
-
export declare
|
|
744
|
-
|
|
745
|
-
export declare class NotificationHubsManagementClient extends coreClient.ServiceClient {
|
|
746
|
-
$host: string;
|
|
747
|
-
apiVersion: string;
|
|
748
|
-
subscriptionId: string;
|
|
1740
|
+
/** The response of the List Private Link Resources operation. */
|
|
1741
|
+
export declare interface PrivateLinkResourceListResult {
|
|
749
1742
|
/**
|
|
750
|
-
*
|
|
751
|
-
*
|
|
752
|
-
* @param subscriptionId Gets subscription credentials which uniquely identify Microsoft Azure
|
|
753
|
-
* subscription. The subscription ID forms part of the URI for every service call.
|
|
754
|
-
* @param options The parameter options
|
|
1743
|
+
* Gets or sets result of the List AuthorizationRules operation.
|
|
1744
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
755
1745
|
*/
|
|
756
|
-
|
|
757
|
-
/**
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
1746
|
+
readonly value?: PrivateLinkResource[];
|
|
1747
|
+
/**
|
|
1748
|
+
* Gets or sets link to the next set of results.
|
|
1749
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1750
|
+
*/
|
|
1751
|
+
readonly nextLink?: string;
|
|
762
1752
|
}
|
|
763
1753
|
|
|
764
|
-
/**
|
|
765
|
-
export declare interface
|
|
766
|
-
/**
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
1754
|
+
/** Represents properties of Private Link Resource. */
|
|
1755
|
+
export declare interface PrivateLinkResourceProperties {
|
|
1756
|
+
/**
|
|
1757
|
+
* A Group Id for Private Link. For Notification Hubs, it is always set to "namespace".
|
|
1758
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1759
|
+
*/
|
|
1760
|
+
readonly groupId?: string;
|
|
1761
|
+
/**
|
|
1762
|
+
* Required members. For Notification Hubs, it's always a collection with a single "namespace" item.
|
|
1763
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1764
|
+
*/
|
|
1765
|
+
readonly requiredMembers?: string[];
|
|
1766
|
+
/**
|
|
1767
|
+
* Required DNS zone names. For Notification Hubs, it contains two CNames for Service Bus and Notification Hubs zones.
|
|
1768
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1769
|
+
*/
|
|
1770
|
+
readonly requiredZoneNames?: string[];
|
|
772
1771
|
}
|
|
773
1772
|
|
|
774
|
-
/**
|
|
775
|
-
export declare interface
|
|
776
|
-
/**
|
|
777
|
-
|
|
1773
|
+
/** A customer-visible sub-resource of Private Endpoint, which describe the connection between Private Endpoint and Notification Hubs namespace. */
|
|
1774
|
+
export declare interface PrivateLinkServiceConnection {
|
|
1775
|
+
/** Name of the Private Link Service connection. */
|
|
1776
|
+
name?: string;
|
|
1777
|
+
/** List of group ids. Always contains a single element - "namespace" - for Notification Hub Namespace. */
|
|
1778
|
+
groupIds?: string[];
|
|
1779
|
+
/** Request message provided by the user that created the connection. This is usually used when the connection requires manual approval. */
|
|
1780
|
+
requestMessage?: string;
|
|
778
1781
|
}
|
|
779
1782
|
|
|
780
|
-
/**
|
|
781
|
-
export declare
|
|
1783
|
+
/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
|
|
1784
|
+
export declare interface ProxyResource extends Resource {
|
|
1785
|
+
}
|
|
782
1786
|
|
|
783
|
-
/**
|
|
784
|
-
export declare interface
|
|
1787
|
+
/** A default (public Internet) network authorization rule, which contains rights if no other network rule matches. */
|
|
1788
|
+
export declare interface PublicInternetAuthorizationRule {
|
|
1789
|
+
/** List of access rights. */
|
|
1790
|
+
rights: AccessRights[];
|
|
785
1791
|
}
|
|
786
1792
|
|
|
787
|
-
/**
|
|
788
|
-
|
|
1793
|
+
/**
|
|
1794
|
+
* Defines values for PublicNetworkAccess. \
|
|
1795
|
+
* {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
|
|
1796
|
+
* this enum contains the known values that the service supports.
|
|
1797
|
+
* ### Known values supported by the service
|
|
1798
|
+
* **Enabled** \
|
|
1799
|
+
* **Disabled**
|
|
1800
|
+
*/
|
|
1801
|
+
export declare type PublicNetworkAccess = string;
|
|
789
1802
|
|
|
790
|
-
/**
|
|
791
|
-
export declare interface
|
|
1803
|
+
/** Notification result for a single registration. */
|
|
1804
|
+
export declare interface RegistrationResult {
|
|
792
1805
|
/**
|
|
793
|
-
*
|
|
1806
|
+
* PNS type.
|
|
794
1807
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
795
1808
|
*/
|
|
796
|
-
readonly
|
|
797
|
-
/** The object that represents the operation. */
|
|
798
|
-
display?: OperationDisplay;
|
|
799
|
-
}
|
|
800
|
-
|
|
801
|
-
/** The object that represents the operation. */
|
|
802
|
-
export declare interface OperationDisplay {
|
|
1809
|
+
readonly applicationPlatform?: string;
|
|
803
1810
|
/**
|
|
804
|
-
*
|
|
1811
|
+
* PNS handle.
|
|
805
1812
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
806
1813
|
*/
|
|
807
|
-
readonly
|
|
1814
|
+
readonly pnsHandle?: string;
|
|
808
1815
|
/**
|
|
809
|
-
*
|
|
1816
|
+
* Registration id.
|
|
810
1817
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
811
1818
|
*/
|
|
812
|
-
readonly
|
|
1819
|
+
readonly registrationId?: string;
|
|
813
1820
|
/**
|
|
814
|
-
*
|
|
1821
|
+
* Notification outcome.
|
|
815
1822
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
816
1823
|
*/
|
|
817
|
-
readonly
|
|
1824
|
+
readonly outcome?: string;
|
|
818
1825
|
}
|
|
819
1826
|
|
|
820
|
-
/**
|
|
821
|
-
export declare interface
|
|
1827
|
+
/** Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. */
|
|
1828
|
+
export declare interface RemotePrivateEndpointConnection {
|
|
822
1829
|
/**
|
|
823
|
-
*
|
|
1830
|
+
* ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace.
|
|
824
1831
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
825
1832
|
*/
|
|
826
|
-
readonly
|
|
1833
|
+
readonly id?: string;
|
|
1834
|
+
}
|
|
1835
|
+
|
|
1836
|
+
/** State of the Private Link Service connection. */
|
|
1837
|
+
export declare interface RemotePrivateLinkServiceConnectionState {
|
|
1838
|
+
/** State of Private Link Connection. */
|
|
1839
|
+
status?: PrivateLinkConnectionStatus;
|
|
827
1840
|
/**
|
|
828
|
-
*
|
|
1841
|
+
* Human-friendly description.
|
|
829
1842
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
830
1843
|
*/
|
|
831
|
-
readonly
|
|
832
|
-
}
|
|
833
|
-
|
|
834
|
-
/** Interface representing a Operations. */
|
|
835
|
-
export declare interface Operations {
|
|
1844
|
+
readonly description?: string;
|
|
836
1845
|
/**
|
|
837
|
-
*
|
|
838
|
-
*
|
|
1846
|
+
* Human-friendly description of required actions.
|
|
1847
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
839
1848
|
*/
|
|
840
|
-
|
|
841
|
-
}
|
|
842
|
-
|
|
843
|
-
/** Optional parameters. */
|
|
844
|
-
export declare interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
|
|
845
|
-
}
|
|
846
|
-
|
|
847
|
-
/** Contains response data for the listNext operation. */
|
|
848
|
-
export declare type OperationsListNextResponse = OperationListResult;
|
|
849
|
-
|
|
850
|
-
/** Optional parameters. */
|
|
851
|
-
export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
|
|
852
|
-
}
|
|
853
|
-
|
|
854
|
-
/** Contains response data for the list operation. */
|
|
855
|
-
export declare type OperationsListResponse = OperationListResult;
|
|
856
|
-
|
|
857
|
-
/** Description of a NotificationHub PNS Credentials. */
|
|
858
|
-
export declare interface PnsCredentialsResource extends Resource {
|
|
859
|
-
/** The ApnsCredential of the created NotificationHub */
|
|
860
|
-
apnsCredential?: ApnsCredential;
|
|
861
|
-
/** The WnsCredential of the created NotificationHub */
|
|
862
|
-
wnsCredential?: WnsCredential;
|
|
863
|
-
/** The GcmCredential of the created NotificationHub */
|
|
864
|
-
gcmCredential?: GcmCredential;
|
|
865
|
-
/** The MpnsCredential of the created NotificationHub */
|
|
866
|
-
mpnsCredential?: MpnsCredential;
|
|
867
|
-
/** The AdmCredential of the created NotificationHub */
|
|
868
|
-
admCredential?: AdmCredential;
|
|
869
|
-
/** The BaiduCredential of the created NotificationHub */
|
|
870
|
-
baiduCredential?: BaiduCredential;
|
|
1849
|
+
readonly actionsRequired?: string;
|
|
871
1850
|
}
|
|
872
1851
|
|
|
873
|
-
/**
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
1852
|
+
/**
|
|
1853
|
+
* Defines values for ReplicationRegion. \
|
|
1854
|
+
* {@link KnownReplicationRegion} can be used interchangeably with ReplicationRegion,
|
|
1855
|
+
* this enum contains the known values that the service supports.
|
|
1856
|
+
* ### Known values supported by the service
|
|
1857
|
+
* **Default** \
|
|
1858
|
+
* **WestUs2** \
|
|
1859
|
+
* **NorthEurope** \
|
|
1860
|
+
* **AustraliaEast** \
|
|
1861
|
+
* **BrazilSouth** \
|
|
1862
|
+
* **SouthEastAsia** \
|
|
1863
|
+
* **SouthAfricaNorth** \
|
|
1864
|
+
* **None**
|
|
1865
|
+
*/
|
|
1866
|
+
export declare type ReplicationRegion = string;
|
|
878
1867
|
|
|
1868
|
+
/** Common fields that are returned in the response for all Azure Resource Manager resources */
|
|
879
1869
|
export declare interface Resource {
|
|
880
1870
|
/**
|
|
881
|
-
*
|
|
1871
|
+
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
|
|
882
1872
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
883
1873
|
*/
|
|
884
1874
|
readonly id?: string;
|
|
885
1875
|
/**
|
|
886
|
-
*
|
|
1876
|
+
* The name of the resource
|
|
887
1877
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
888
1878
|
*/
|
|
889
1879
|
readonly name?: string;
|
|
890
1880
|
/**
|
|
891
|
-
*
|
|
1881
|
+
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
|
|
892
1882
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
893
1883
|
*/
|
|
894
1884
|
readonly type?: string;
|
|
895
|
-
/**
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
};
|
|
901
|
-
/** The sku of the created namespace */
|
|
902
|
-
sku?: Sku;
|
|
1885
|
+
/**
|
|
1886
|
+
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
|
|
1887
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1888
|
+
*/
|
|
1889
|
+
readonly systemData?: SystemData;
|
|
903
1890
|
}
|
|
904
1891
|
|
|
905
|
-
/** Namespace
|
|
1892
|
+
/** Response for the POST request that returns Namespace or NotificationHub access keys (connection strings). */
|
|
906
1893
|
export declare interface ResourceListKeys {
|
|
907
|
-
/**
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
1894
|
+
/**
|
|
1895
|
+
* Gets or sets primaryConnectionString of the AuthorizationRule.
|
|
1896
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1897
|
+
*/
|
|
1898
|
+
readonly primaryConnectionString?: string;
|
|
1899
|
+
/**
|
|
1900
|
+
* Gets or sets secondaryConnectionString of the created
|
|
1901
|
+
* AuthorizationRule
|
|
1902
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1903
|
+
*/
|
|
1904
|
+
readonly secondaryConnectionString?: string;
|
|
1905
|
+
/**
|
|
1906
|
+
* Gets or sets primaryKey of the created AuthorizationRule.
|
|
1907
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1908
|
+
*/
|
|
1909
|
+
readonly primaryKey?: string;
|
|
1910
|
+
/**
|
|
1911
|
+
* Gets or sets secondaryKey of the created AuthorizationRule
|
|
1912
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1913
|
+
*/
|
|
1914
|
+
readonly secondaryKey?: string;
|
|
1915
|
+
/**
|
|
1916
|
+
* Gets or sets keyName of the created AuthorizationRule
|
|
1917
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1918
|
+
*/
|
|
1919
|
+
readonly keyName?: string;
|
|
917
1920
|
}
|
|
918
1921
|
|
|
919
|
-
/**
|
|
920
|
-
export declare interface
|
|
921
|
-
/**
|
|
922
|
-
|
|
1922
|
+
/** Optional service specification used in Operations API. */
|
|
1923
|
+
export declare interface ServiceSpecification {
|
|
1924
|
+
/**
|
|
1925
|
+
* Log specifications.
|
|
1926
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1927
|
+
*/
|
|
1928
|
+
readonly logSpecifications?: LogSpecification[];
|
|
1929
|
+
/**
|
|
1930
|
+
* Metric specification.
|
|
1931
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1932
|
+
*/
|
|
1933
|
+
readonly metricSpecifications?: MetricSpecification[];
|
|
923
1934
|
}
|
|
924
1935
|
|
|
925
1936
|
/** The response of the List Namespace operation. */
|
|
926
1937
|
export declare interface SharedAccessAuthorizationRuleListResult {
|
|
927
|
-
/**
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
1938
|
+
/**
|
|
1939
|
+
* Gets or sets result of the List AuthorizationRules operation.
|
|
1940
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1941
|
+
*/
|
|
1942
|
+
readonly value?: SharedAccessAuthorizationRuleResource[];
|
|
1943
|
+
/**
|
|
1944
|
+
* Gets or sets link to the next set of results.
|
|
1945
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1946
|
+
*/
|
|
1947
|
+
readonly nextLink?: string;
|
|
931
1948
|
}
|
|
932
1949
|
|
|
933
1950
|
/** SharedAccessAuthorizationRule properties. */
|
|
934
1951
|
export declare interface SharedAccessAuthorizationRuleProperties {
|
|
935
|
-
/**
|
|
936
|
-
rights
|
|
1952
|
+
/** Gets or sets the rights associated with the rule. */
|
|
1953
|
+
rights: AccessRights[];
|
|
937
1954
|
/**
|
|
938
|
-
*
|
|
939
|
-
*
|
|
1955
|
+
* Gets a base64-encoded 256-bit primary key for signing and
|
|
1956
|
+
* validating the SAS token.
|
|
940
1957
|
*/
|
|
941
|
-
|
|
1958
|
+
primaryKey?: string;
|
|
942
1959
|
/**
|
|
943
|
-
*
|
|
944
|
-
*
|
|
1960
|
+
* Gets a base64-encoded 256-bit primary key for signing and
|
|
1961
|
+
* validating the SAS token.
|
|
945
1962
|
*/
|
|
946
|
-
|
|
1963
|
+
secondaryKey?: string;
|
|
947
1964
|
/**
|
|
948
|
-
*
|
|
1965
|
+
* Gets a string that describes the authorization rule.
|
|
949
1966
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
950
1967
|
*/
|
|
951
1968
|
readonly keyName?: string;
|
|
952
1969
|
/**
|
|
953
|
-
*
|
|
1970
|
+
* Gets the last modified time for this rule
|
|
954
1971
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
955
1972
|
*/
|
|
956
|
-
readonly
|
|
1973
|
+
readonly modifiedTime?: Date;
|
|
957
1974
|
/**
|
|
958
|
-
*
|
|
1975
|
+
* Gets the created time for this rule
|
|
959
1976
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
960
1977
|
*/
|
|
961
|
-
readonly
|
|
1978
|
+
readonly createdTime?: Date;
|
|
962
1979
|
/**
|
|
963
|
-
*
|
|
1980
|
+
* Gets a string that describes the claim type
|
|
964
1981
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
965
1982
|
*/
|
|
966
|
-
readonly
|
|
1983
|
+
readonly claimType?: string;
|
|
967
1984
|
/**
|
|
968
|
-
*
|
|
1985
|
+
* Gets a string that describes the claim value
|
|
969
1986
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
970
1987
|
*/
|
|
971
|
-
readonly
|
|
1988
|
+
readonly claimValue?: string;
|
|
972
1989
|
/**
|
|
973
|
-
*
|
|
1990
|
+
* Gets the revision number for the rule
|
|
974
1991
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
975
1992
|
*/
|
|
976
1993
|
readonly revision?: number;
|
|
977
1994
|
}
|
|
978
1995
|
|
|
979
|
-
/**
|
|
980
|
-
export declare interface SharedAccessAuthorizationRuleResource extends
|
|
981
|
-
/**
|
|
1996
|
+
/** Response for POST requests that return single SharedAccessAuthorizationRule. */
|
|
1997
|
+
export declare interface SharedAccessAuthorizationRuleResource extends ProxyResource {
|
|
1998
|
+
/** Deprecated - only for compatibility. */
|
|
1999
|
+
location?: string;
|
|
2000
|
+
/** Deprecated - only for compatibility. */
|
|
2001
|
+
tags?: {
|
|
2002
|
+
[propertyName: string]: string;
|
|
2003
|
+
};
|
|
2004
|
+
/** Gets or sets the rights associated with the rule. */
|
|
982
2005
|
rights?: AccessRights[];
|
|
983
2006
|
/**
|
|
984
|
-
*
|
|
985
|
-
*
|
|
2007
|
+
* Gets a base64-encoded 256-bit primary key for signing and
|
|
2008
|
+
* validating the SAS token.
|
|
986
2009
|
*/
|
|
987
|
-
|
|
2010
|
+
primaryKey?: string;
|
|
988
2011
|
/**
|
|
989
|
-
*
|
|
990
|
-
*
|
|
2012
|
+
* Gets a base64-encoded 256-bit primary key for signing and
|
|
2013
|
+
* validating the SAS token.
|
|
991
2014
|
*/
|
|
992
|
-
|
|
2015
|
+
secondaryKey?: string;
|
|
993
2016
|
/**
|
|
994
|
-
*
|
|
2017
|
+
* Gets a string that describes the authorization rule.
|
|
995
2018
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
996
2019
|
*/
|
|
997
2020
|
readonly keyName?: string;
|
|
998
2021
|
/**
|
|
999
|
-
*
|
|
2022
|
+
* Gets the last modified time for this rule
|
|
1000
2023
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1001
2024
|
*/
|
|
1002
|
-
readonly
|
|
2025
|
+
readonly modifiedTime?: Date;
|
|
1003
2026
|
/**
|
|
1004
|
-
*
|
|
2027
|
+
* Gets the created time for this rule
|
|
1005
2028
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1006
2029
|
*/
|
|
1007
|
-
readonly
|
|
2030
|
+
readonly createdTime?: Date;
|
|
1008
2031
|
/**
|
|
1009
|
-
*
|
|
2032
|
+
* Gets a string that describes the claim type
|
|
1010
2033
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1011
2034
|
*/
|
|
1012
|
-
readonly
|
|
2035
|
+
readonly claimType?: string;
|
|
1013
2036
|
/**
|
|
1014
|
-
*
|
|
2037
|
+
* Gets a string that describes the claim value
|
|
1015
2038
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1016
2039
|
*/
|
|
1017
|
-
readonly
|
|
2040
|
+
readonly claimValue?: string;
|
|
1018
2041
|
/**
|
|
1019
|
-
*
|
|
2042
|
+
* Gets the revision number for the rule
|
|
1020
2043
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1021
2044
|
*/
|
|
1022
2045
|
readonly revision?: number;
|
|
@@ -1024,15 +2047,15 @@ export declare interface SharedAccessAuthorizationRuleResource extends Resource
|
|
|
1024
2047
|
|
|
1025
2048
|
/** The Sku description for a namespace */
|
|
1026
2049
|
export declare interface Sku {
|
|
1027
|
-
/**
|
|
2050
|
+
/** Namespace SKU name. */
|
|
1028
2051
|
name: SkuName;
|
|
1029
|
-
/**
|
|
2052
|
+
/** Gets or sets the tier of particular sku */
|
|
1030
2053
|
tier?: string;
|
|
1031
|
-
/**
|
|
2054
|
+
/** Gets or sets the Sku size */
|
|
1032
2055
|
size?: string;
|
|
1033
|
-
/**
|
|
2056
|
+
/** Gets or sets the Sku Family */
|
|
1034
2057
|
family?: string;
|
|
1035
|
-
/**
|
|
2058
|
+
/** Gets or sets the capacity of the resource */
|
|
1036
2059
|
capacity?: number;
|
|
1037
2060
|
}
|
|
1038
2061
|
|
|
@@ -1047,19 +2070,62 @@ export declare interface Sku {
|
|
|
1047
2070
|
*/
|
|
1048
2071
|
export declare type SkuName = string;
|
|
1049
2072
|
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
2073
|
+
/** Metadata pertaining to creation and last modification of the resource. */
|
|
2074
|
+
export declare interface SystemData {
|
|
2075
|
+
/** The identity that created the resource. */
|
|
2076
|
+
createdBy?: string;
|
|
2077
|
+
/** The type of identity that created the resource. */
|
|
2078
|
+
createdByType?: CreatedByType;
|
|
2079
|
+
/** The timestamp of resource creation (UTC). */
|
|
2080
|
+
createdAt?: Date;
|
|
2081
|
+
/** The identity that last modified the resource. */
|
|
2082
|
+
lastModifiedBy?: string;
|
|
2083
|
+
/** The type of identity that last modified the resource. */
|
|
2084
|
+
lastModifiedByType?: CreatedByType;
|
|
2085
|
+
/** The timestamp of resource last modification (UTC) */
|
|
2086
|
+
lastModifiedAt?: Date;
|
|
2087
|
+
}
|
|
2088
|
+
|
|
2089
|
+
/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
|
|
2090
|
+
export declare interface TrackedResource extends Resource {
|
|
2091
|
+
/** Resource tags. */
|
|
2092
|
+
tags?: {
|
|
2093
|
+
[propertyName: string]: string;
|
|
2094
|
+
};
|
|
2095
|
+
/** The geo-location where the resource lives */
|
|
2096
|
+
location: string;
|
|
1053
2097
|
}
|
|
1054
2098
|
|
|
1055
2099
|
/** Description of a NotificationHub WnsCredential. */
|
|
1056
2100
|
export declare interface WnsCredential {
|
|
1057
|
-
/**
|
|
2101
|
+
/** Gets or sets the package ID for this credential. */
|
|
1058
2102
|
packageSid?: string;
|
|
1059
|
-
/**
|
|
2103
|
+
/** Gets or sets the secret key. */
|
|
1060
2104
|
secretKey?: string;
|
|
1061
|
-
/**
|
|
2105
|
+
/** Gets or sets the Windows Live endpoint. */
|
|
1062
2106
|
windowsLiveEndpoint?: string;
|
|
2107
|
+
/** Ges or sets the WNS Certificate Key. */
|
|
2108
|
+
certificateKey?: string;
|
|
2109
|
+
/** Gets or sets the WNS Certificate. */
|
|
2110
|
+
wnsCertificate?: string;
|
|
1063
2111
|
}
|
|
1064
2112
|
|
|
2113
|
+
/** Description of a NotificationHub XiaomiCredential. */
|
|
2114
|
+
export declare interface XiaomiCredential {
|
|
2115
|
+
/** Gets or sets app secret. */
|
|
2116
|
+
appSecret?: string;
|
|
2117
|
+
/** Gets or sets xiaomi service endpoint. */
|
|
2118
|
+
endpoint?: string;
|
|
2119
|
+
}
|
|
2120
|
+
|
|
2121
|
+
/**
|
|
2122
|
+
* Defines values for ZoneRedundancyPreference. \
|
|
2123
|
+
* {@link KnownZoneRedundancyPreference} can be used interchangeably with ZoneRedundancyPreference,
|
|
2124
|
+
* this enum contains the known values that the service supports.
|
|
2125
|
+
* ### Known values supported by the service
|
|
2126
|
+
* **Disabled** \
|
|
2127
|
+
* **Enabled**
|
|
2128
|
+
*/
|
|
2129
|
+
export declare type ZoneRedundancyPreference = string;
|
|
2130
|
+
|
|
1065
2131
|
export { }
|