@azure/arm-dns 4.1.1 → 5.0.0
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 +11 -0
- package/LICENSE +21 -0
- package/README.md +69 -87
- package/dist/index.js +2060 -0
- package/dist/index.js.map +1 -0
- package/dist/index.min.js +1 -0
- package/dist/index.min.js.map +1 -0
- package/dist-esm/src/dnsManagementClient.d.ts +21 -0
- package/dist-esm/src/dnsManagementClient.d.ts.map +1 -0
- package/dist-esm/src/dnsManagementClient.js +54 -0
- package/dist-esm/src/dnsManagementClient.js.map +1 -0
- package/dist-esm/src/index.d.ts +5 -0
- package/dist-esm/src/index.d.ts.map +1 -0
- package/dist-esm/src/index.js +12 -0
- package/dist-esm/src/index.js.map +1 -0
- package/dist-esm/src/lroImpl.d.ts +16 -0
- package/dist-esm/src/lroImpl.d.ts.map +1 -0
- package/dist-esm/src/lroImpl.js +29 -0
- package/dist-esm/src/lroImpl.js.map +1 -0
- package/dist-esm/src/models/index.d.ts +415 -0
- package/dist-esm/src/models/index.d.ts.map +1 -0
- package/dist-esm/src/models/index.js +9 -0
- package/dist-esm/src/models/index.js.map +1 -0
- package/dist-esm/src/models/mappers.d.ts +25 -0
- package/dist-esm/src/models/mappers.d.ts.map +1 -0
- package/{esm → dist-esm/src}/models/mappers.js +353 -334
- package/dist-esm/src/models/mappers.js.map +1 -0
- package/dist-esm/src/models/parameters.d.ts +21 -0
- package/dist-esm/src/models/parameters.d.ts.map +1 -0
- package/{esm → dist-esm/src}/models/parameters.js +92 -68
- package/dist-esm/src/models/parameters.js.map +1 -0
- package/dist-esm/src/operations/dnsResourceReferenceOperations.d.ts +19 -0
- package/dist-esm/src/operations/dnsResourceReferenceOperations.d.ts.map +1 -0
- package/dist-esm/src/operations/dnsResourceReferenceOperations.js +49 -0
- package/dist-esm/src/operations/dnsResourceReferenceOperations.js.map +1 -0
- package/{esm → dist-esm/src}/operations/index.d.ts +0 -0
- package/dist-esm/src/operations/index.d.ts.map +1 -0
- package/{esm → dist-esm/src}/operations/index.js +3 -5
- package/dist-esm/src/operations/index.js.map +1 -0
- package/dist-esm/src/operations/recordSets.d.ts +129 -0
- package/dist-esm/src/operations/recordSets.d.ts.map +1 -0
- package/dist-esm/src/operations/recordSets.js +571 -0
- package/dist-esm/src/operations/recordSets.js.map +1 -0
- package/dist-esm/src/operations/zones.d.ts +93 -0
- package/dist-esm/src/operations/zones.d.ts.map +1 -0
- package/dist-esm/src/operations/zones.js +414 -0
- package/dist-esm/src/operations/zones.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/dnsResourceReferenceOperations.d.ts +11 -0
- package/dist-esm/src/operationsInterfaces/dnsResourceReferenceOperations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/dnsResourceReferenceOperations.js +9 -0
- package/dist-esm/src/operationsInterfaces/dnsResourceReferenceOperations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts +4 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/index.js +11 -0
- package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/recordSets.d.ts +68 -0
- package/dist-esm/src/operationsInterfaces/recordSets.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/recordSets.js +9 -0
- package/dist-esm/src/operationsInterfaces/recordSets.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/zones.d.ts +57 -0
- package/dist-esm/src/operationsInterfaces/zones.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/zones.js +9 -0
- package/dist-esm/src/operationsInterfaces/zones.js.map +1 -0
- package/dist-esm/test/sampleTest.d.ts +2 -0
- package/dist-esm/test/sampleTest.d.ts.map +1 -0
- package/dist-esm/test/sampleTest.js +40 -0
- package/dist-esm/test/sampleTest.js.map +1 -0
- package/package.json +65 -32
- package/review/arm-dns.api.md +393 -0
- package/rollup.config.js +181 -30
- package/src/dnsManagementClient.ts +78 -41
- package/src/index.ts +12 -0
- package/src/lroImpl.ts +34 -0
- package/src/models/index.ts +344 -774
- package/src/models/mappers.ts +360 -338
- package/src/models/parameters.ts +120 -69
- package/src/operations/dnsResourceReferenceOperations.ts +37 -56
- package/src/operations/index.ts +3 -5
- package/src/operations/recordSets.ts +508 -411
- package/src/operations/zones.ts +348 -317
- package/src/operationsInterfaces/dnsResourceReferenceOperations.ts +26 -0
- package/src/operationsInterfaces/index.ts +11 -0
- package/src/operationsInterfaces/recordSets.ts +129 -0
- package/src/operationsInterfaces/zones.ts +103 -0
- package/tsconfig.json +3 -3
- package/types/arm-dns.d.ts +629 -0
- package/types/tsdoc-metadata.json +11 -0
- package/dist/arm-dns.js +0 -1857
- package/dist/arm-dns.js.map +0 -1
- package/dist/arm-dns.min.js +0 -1
- package/dist/arm-dns.min.js.map +0 -1
- package/esm/dnsManagementClient.d.ts +0 -27
- package/esm/dnsManagementClient.d.ts.map +0 -1
- package/esm/dnsManagementClient.js +0 -41
- package/esm/dnsManagementClient.js.map +0 -1
- package/esm/dnsManagementClientContext.d.ts +0 -23
- package/esm/dnsManagementClientContext.d.ts.map +0 -1
- package/esm/dnsManagementClientContext.js +0 -62
- package/esm/dnsManagementClientContext.js.map +0 -1
- package/esm/models/dnsResourceReferenceOperationsMappers.d.ts +0 -2
- package/esm/models/dnsResourceReferenceOperationsMappers.d.ts.map +0 -1
- package/esm/models/dnsResourceReferenceOperationsMappers.js +0 -9
- package/esm/models/dnsResourceReferenceOperationsMappers.js.map +0 -1
- package/esm/models/index.d.ts +0 -857
- package/esm/models/index.d.ts.map +0 -1
- package/esm/models/index.js +0 -8
- package/esm/models/index.js.map +0 -1
- package/esm/models/mappers.d.ts +0 -25
- package/esm/models/mappers.d.ts.map +0 -1
- package/esm/models/mappers.js.map +0 -1
- package/esm/models/parameters.d.ts +0 -15
- package/esm/models/parameters.d.ts.map +0 -1
- package/esm/models/parameters.js.map +0 -1
- package/esm/models/recordSetsMappers.d.ts +0 -2
- package/esm/models/recordSetsMappers.d.ts.map +0 -1
- package/esm/models/recordSetsMappers.js +0 -9
- package/esm/models/recordSetsMappers.js.map +0 -1
- package/esm/models/zonesMappers.d.ts +0 -2
- package/esm/models/zonesMappers.d.ts.map +0 -1
- package/esm/models/zonesMappers.js +0 -9
- package/esm/models/zonesMappers.js.map +0 -1
- package/esm/operations/dnsResourceReferenceOperations.d.ts +0 -31
- package/esm/operations/dnsResourceReferenceOperations.d.ts.map +0 -1
- package/esm/operations/dnsResourceReferenceOperations.js +0 -60
- package/esm/operations/dnsResourceReferenceOperations.js.map +0 -1
- package/esm/operations/index.d.ts.map +0 -1
- package/esm/operations/index.js.map +0 -1
- package/esm/operations/recordSets.d.ts +0 -268
- package/esm/operations/recordSets.d.ts.map +0 -1
- package/esm/operations/recordSets.js +0 -363
- package/esm/operations/recordSets.js.map +0 -1
- package/esm/operations/zones.d.ts +0 -170
- package/esm/operations/zones.d.ts.map +0 -1
- package/esm/operations/zones.js +0 -299
- package/esm/operations/zones.js.map +0 -1
- package/src/dnsManagementClientContext.ts +0 -69
- package/src/models/dnsResourceReferenceOperationsMappers.ts +0 -15
- package/src/models/recordSetsMappers.ts +0 -27
- package/src/models/zonesMappers.ts +0 -28
|
@@ -0,0 +1,629 @@
|
|
|
1
|
+
import * as coreAuth from '@azure/core-auth';
|
|
2
|
+
import * as coreClient from '@azure/core-client';
|
|
3
|
+
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
4
|
+
import { PollerLike } from '@azure/core-lro';
|
|
5
|
+
import { PollOperationState } from '@azure/core-lro';
|
|
6
|
+
|
|
7
|
+
/** An AAAA record. */
|
|
8
|
+
export declare interface AaaaRecord {
|
|
9
|
+
/** The IPv6 address of this AAAA record. */
|
|
10
|
+
ipv6Address?: string;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
/** An A record. */
|
|
14
|
+
export declare interface ARecord {
|
|
15
|
+
/** The IPv4 address of this A record. */
|
|
16
|
+
ipv4Address?: string;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
/** A CAA record. */
|
|
20
|
+
export declare interface CaaRecord {
|
|
21
|
+
/** The flags for this CAA record as an integer between 0 and 255. */
|
|
22
|
+
flags?: number;
|
|
23
|
+
/** The tag for this CAA record. */
|
|
24
|
+
tag?: string;
|
|
25
|
+
/** The value for this CAA record. */
|
|
26
|
+
value?: string;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/** An error response from the service. */
|
|
30
|
+
export declare interface CloudError {
|
|
31
|
+
/** Cloud error body. */
|
|
32
|
+
error?: CloudErrorBody;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/** An error response from the service. */
|
|
36
|
+
export declare interface CloudErrorBody {
|
|
37
|
+
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
|
|
38
|
+
code?: string;
|
|
39
|
+
/** A message describing the error, intended to be suitable for display in a user interface. */
|
|
40
|
+
message?: string;
|
|
41
|
+
/** The target of the particular error. For example, the name of the property in error. */
|
|
42
|
+
target?: string;
|
|
43
|
+
/** A list of additional details about the error. */
|
|
44
|
+
details?: CloudErrorBody[];
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/** A CNAME record. */
|
|
48
|
+
export declare interface CnameRecord {
|
|
49
|
+
/** The canonical name for this CNAME record. */
|
|
50
|
+
cname?: string;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
export declare class DnsManagementClient extends coreClient.ServiceClient {
|
|
54
|
+
$host: string;
|
|
55
|
+
apiVersion: string;
|
|
56
|
+
subscriptionId: string;
|
|
57
|
+
/**
|
|
58
|
+
* Initializes a new instance of the DnsManagementClient class.
|
|
59
|
+
* @param credentials Subscription credentials which uniquely identify client subscription.
|
|
60
|
+
* @param subscriptionId Specifies the Azure subscription ID, which uniquely identifies the Microsoft
|
|
61
|
+
* Azure subscription.
|
|
62
|
+
* @param options The parameter options
|
|
63
|
+
*/
|
|
64
|
+
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: DnsManagementClientOptionalParams);
|
|
65
|
+
recordSets: RecordSets;
|
|
66
|
+
zones: Zones;
|
|
67
|
+
dnsResourceReferenceOperations: DnsResourceReferenceOperations;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/** Optional parameters. */
|
|
71
|
+
export declare interface DnsManagementClientOptionalParams extends coreClient.ServiceClientOptions {
|
|
72
|
+
/** server parameter */
|
|
73
|
+
$host?: string;
|
|
74
|
+
/** Api Version */
|
|
75
|
+
apiVersion?: string;
|
|
76
|
+
/** Overrides client endpoint. */
|
|
77
|
+
endpoint?: string;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/** Represents a single Azure resource and its referencing DNS records. */
|
|
81
|
+
export declare interface DnsResourceReference {
|
|
82
|
+
/** A list of dns Records */
|
|
83
|
+
dnsResources?: SubResource[];
|
|
84
|
+
/** A reference to an azure resource from where the dns resource value is taken. */
|
|
85
|
+
targetResource?: SubResource;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/** Optional parameters. */
|
|
89
|
+
export declare interface DnsResourceReferenceGetByTargetResourcesOptionalParams extends coreClient.OperationOptions {
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/** Contains response data for the getByTargetResources operation. */
|
|
93
|
+
export declare type DnsResourceReferenceGetByTargetResourcesResponse = DnsResourceReferenceResult;
|
|
94
|
+
|
|
95
|
+
/** Interface representing a DnsResourceReferenceOperations. */
|
|
96
|
+
export declare interface DnsResourceReferenceOperations {
|
|
97
|
+
/**
|
|
98
|
+
* Returns the DNS records specified by the referencing targetResourceIds.
|
|
99
|
+
* @param parameters Properties for dns resource reference request.
|
|
100
|
+
* @param options The options parameters.
|
|
101
|
+
*/
|
|
102
|
+
getByTargetResources(parameters: DnsResourceReferenceRequest, options?: DnsResourceReferenceGetByTargetResourcesOptionalParams): Promise<DnsResourceReferenceGetByTargetResourcesResponse>;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/** Represents the properties of the Dns Resource Reference Request. */
|
|
106
|
+
export declare interface DnsResourceReferenceRequest {
|
|
107
|
+
/** A list of references to azure resources for which referencing dns records need to be queried. */
|
|
108
|
+
targetResources?: SubResource[];
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
/** Represents the properties of the Dns Resource Reference Result. */
|
|
112
|
+
export declare interface DnsResourceReferenceResult {
|
|
113
|
+
/** The result of dns resource reference request. A list of dns resource references for each of the azure resource in the request */
|
|
114
|
+
dnsResourceReferences?: DnsResourceReference[];
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
/** An MX record. */
|
|
118
|
+
export declare interface MxRecord {
|
|
119
|
+
/** The preference value for this MX record. */
|
|
120
|
+
preference?: number;
|
|
121
|
+
/** The domain name of the mail host for this MX record. */
|
|
122
|
+
exchange?: string;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/** An NS record. */
|
|
126
|
+
export declare interface NsRecord {
|
|
127
|
+
/** The name server name for this NS record. */
|
|
128
|
+
nsdname?: string;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
/** A PTR record. */
|
|
132
|
+
export declare interface PtrRecord {
|
|
133
|
+
/** The PTR target domain name for this PTR record. */
|
|
134
|
+
ptrdname?: string;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/** Describes a DNS record set (a collection of DNS records with the same name and type). */
|
|
138
|
+
export declare interface RecordSet {
|
|
139
|
+
/**
|
|
140
|
+
* The ID of the record set.
|
|
141
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
142
|
+
*/
|
|
143
|
+
readonly id?: string;
|
|
144
|
+
/**
|
|
145
|
+
* The name of the record set.
|
|
146
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
147
|
+
*/
|
|
148
|
+
readonly name?: string;
|
|
149
|
+
/**
|
|
150
|
+
* The type of the record set.
|
|
151
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
152
|
+
*/
|
|
153
|
+
readonly type?: string;
|
|
154
|
+
/** The etag of the record set. */
|
|
155
|
+
etag?: string;
|
|
156
|
+
/** The metadata attached to the record set. */
|
|
157
|
+
metadata?: {
|
|
158
|
+
[propertyName: string]: string;
|
|
159
|
+
};
|
|
160
|
+
/** The TTL (time-to-live) of the records in the record set. */
|
|
161
|
+
ttl?: number;
|
|
162
|
+
/**
|
|
163
|
+
* Fully qualified domain name of the record set.
|
|
164
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
165
|
+
*/
|
|
166
|
+
readonly fqdn?: string;
|
|
167
|
+
/**
|
|
168
|
+
* provisioning State of the record set.
|
|
169
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
170
|
+
*/
|
|
171
|
+
readonly provisioningState?: string;
|
|
172
|
+
/** A reference to an azure resource from where the dns resource value is taken. */
|
|
173
|
+
targetResource?: SubResource;
|
|
174
|
+
/** The list of A records in the record set. */
|
|
175
|
+
aRecords?: ARecord[];
|
|
176
|
+
/** The list of AAAA records in the record set. */
|
|
177
|
+
aaaaRecords?: AaaaRecord[];
|
|
178
|
+
/** The list of MX records in the record set. */
|
|
179
|
+
mxRecords?: MxRecord[];
|
|
180
|
+
/** The list of NS records in the record set. */
|
|
181
|
+
nsRecords?: NsRecord[];
|
|
182
|
+
/** The list of PTR records in the record set. */
|
|
183
|
+
ptrRecords?: PtrRecord[];
|
|
184
|
+
/** The list of SRV records in the record set. */
|
|
185
|
+
srvRecords?: SrvRecord[];
|
|
186
|
+
/** The list of TXT records in the record set. */
|
|
187
|
+
txtRecords?: TxtRecord[];
|
|
188
|
+
/** The CNAME record in the record set. */
|
|
189
|
+
cnameRecord?: CnameRecord;
|
|
190
|
+
/** The SOA record in the record set. */
|
|
191
|
+
soaRecord?: SoaRecord;
|
|
192
|
+
/** The list of CAA records in the record set. */
|
|
193
|
+
caaRecords?: CaaRecord[];
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
/** The response to a record set List operation. */
|
|
197
|
+
export declare interface RecordSetListResult {
|
|
198
|
+
/** Information about the record sets in the response. */
|
|
199
|
+
value?: RecordSet[];
|
|
200
|
+
/**
|
|
201
|
+
* The continuation token for the next page of results.
|
|
202
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
203
|
+
*/
|
|
204
|
+
readonly nextLink?: string;
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
/** Interface representing a RecordSets. */
|
|
208
|
+
export declare interface RecordSets {
|
|
209
|
+
/**
|
|
210
|
+
* Lists the record sets of a specified type in a DNS zone.
|
|
211
|
+
* @param resourceGroupName The name of the resource group.
|
|
212
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
213
|
+
* @param recordType The type of record sets to enumerate.
|
|
214
|
+
* @param options The options parameters.
|
|
215
|
+
*/
|
|
216
|
+
listByType(resourceGroupName: string, zoneName: string, recordType: RecordType, options?: RecordSetsListByTypeOptionalParams): PagedAsyncIterableIterator<RecordSet>;
|
|
217
|
+
/**
|
|
218
|
+
* Lists all record sets in a DNS zone.
|
|
219
|
+
* @param resourceGroupName The name of the resource group.
|
|
220
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
221
|
+
* @param options The options parameters.
|
|
222
|
+
*/
|
|
223
|
+
listByDnsZone(resourceGroupName: string, zoneName: string, options?: RecordSetsListByDnsZoneOptionalParams): PagedAsyncIterableIterator<RecordSet>;
|
|
224
|
+
/**
|
|
225
|
+
* Lists all record sets in a DNS zone.
|
|
226
|
+
* @param resourceGroupName The name of the resource group.
|
|
227
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
228
|
+
* @param options The options parameters.
|
|
229
|
+
*/
|
|
230
|
+
listAllByDnsZone(resourceGroupName: string, zoneName: string, options?: RecordSetsListAllByDnsZoneOptionalParams): PagedAsyncIterableIterator<RecordSet>;
|
|
231
|
+
/**
|
|
232
|
+
* Updates a record set within a DNS zone.
|
|
233
|
+
* @param resourceGroupName The name of the resource group.
|
|
234
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
235
|
+
* @param relativeRecordSetName The name of the record set, relative to the name of the zone.
|
|
236
|
+
* @param recordType The type of DNS record in this record set.
|
|
237
|
+
* @param parameters Parameters supplied to the Update operation.
|
|
238
|
+
* @param options The options parameters.
|
|
239
|
+
*/
|
|
240
|
+
update(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, parameters: RecordSet, options?: RecordSetsUpdateOptionalParams): Promise<RecordSetsUpdateResponse>;
|
|
241
|
+
/**
|
|
242
|
+
* Creates or updates a record set within a DNS zone.
|
|
243
|
+
* @param resourceGroupName The name of the resource group.
|
|
244
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
245
|
+
* @param relativeRecordSetName The name of the record set, relative to the name of the zone.
|
|
246
|
+
* @param recordType The type of DNS record in this record set. Record sets of type SOA can be updated
|
|
247
|
+
* but not created (they are created when the DNS zone is created).
|
|
248
|
+
* @param parameters Parameters supplied to the CreateOrUpdate operation.
|
|
249
|
+
* @param options The options parameters.
|
|
250
|
+
*/
|
|
251
|
+
createOrUpdate(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, parameters: RecordSet, options?: RecordSetsCreateOrUpdateOptionalParams): Promise<RecordSetsCreateOrUpdateResponse>;
|
|
252
|
+
/**
|
|
253
|
+
* Deletes a record set from a DNS zone. This operation cannot be undone.
|
|
254
|
+
* @param resourceGroupName The name of the resource group.
|
|
255
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
256
|
+
* @param relativeRecordSetName The name of the record set, relative to the name of the zone.
|
|
257
|
+
* @param recordType The type of DNS record in this record set. Record sets of type SOA cannot be
|
|
258
|
+
* deleted (they are deleted when the DNS zone is deleted).
|
|
259
|
+
* @param options The options parameters.
|
|
260
|
+
*/
|
|
261
|
+
delete(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, options?: RecordSetsDeleteOptionalParams): Promise<void>;
|
|
262
|
+
/**
|
|
263
|
+
* Gets a record set.
|
|
264
|
+
* @param resourceGroupName The name of the resource group.
|
|
265
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
266
|
+
* @param relativeRecordSetName The name of the record set, relative to the name of the zone.
|
|
267
|
+
* @param recordType The type of DNS record in this record set.
|
|
268
|
+
* @param options The options parameters.
|
|
269
|
+
*/
|
|
270
|
+
get(resourceGroupName: string, zoneName: string, relativeRecordSetName: string, recordType: RecordType, options?: RecordSetsGetOptionalParams): Promise<RecordSetsGetResponse>;
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
/** Optional parameters. */
|
|
274
|
+
export declare interface RecordSetsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
275
|
+
/** The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes. */
|
|
276
|
+
ifMatch?: string;
|
|
277
|
+
/** Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored. */
|
|
278
|
+
ifNoneMatch?: string;
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
/** Contains response data for the createOrUpdate operation. */
|
|
282
|
+
export declare type RecordSetsCreateOrUpdateResponse = RecordSet;
|
|
283
|
+
|
|
284
|
+
/** Optional parameters. */
|
|
285
|
+
export declare interface RecordSetsDeleteOptionalParams extends coreClient.OperationOptions {
|
|
286
|
+
/** The etag of the record set. Omit this value to always delete the current record set. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes. */
|
|
287
|
+
ifMatch?: string;
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
/** Optional parameters. */
|
|
291
|
+
export declare interface RecordSetsGetOptionalParams extends coreClient.OperationOptions {
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
/** Contains response data for the get operation. */
|
|
295
|
+
export declare type RecordSetsGetResponse = RecordSet;
|
|
296
|
+
|
|
297
|
+
/** Optional parameters. */
|
|
298
|
+
export declare interface RecordSetsListAllByDnsZoneNextOptionalParams extends coreClient.OperationOptions {
|
|
299
|
+
/** The maximum number of record sets to return. If not specified, returns up to 100 record sets. */
|
|
300
|
+
top?: number;
|
|
301
|
+
/** The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix> */
|
|
302
|
+
recordSetNameSuffix?: string;
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
/** Contains response data for the listAllByDnsZoneNext operation. */
|
|
306
|
+
export declare type RecordSetsListAllByDnsZoneNextResponse = RecordSetListResult;
|
|
307
|
+
|
|
308
|
+
/** Optional parameters. */
|
|
309
|
+
export declare interface RecordSetsListAllByDnsZoneOptionalParams extends coreClient.OperationOptions {
|
|
310
|
+
/** The maximum number of record sets to return. If not specified, returns up to 100 record sets. */
|
|
311
|
+
top?: number;
|
|
312
|
+
/** The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix> */
|
|
313
|
+
recordSetNameSuffix?: string;
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
/** Contains response data for the listAllByDnsZone operation. */
|
|
317
|
+
export declare type RecordSetsListAllByDnsZoneResponse = RecordSetListResult;
|
|
318
|
+
|
|
319
|
+
/** Optional parameters. */
|
|
320
|
+
export declare interface RecordSetsListByDnsZoneNextOptionalParams extends coreClient.OperationOptions {
|
|
321
|
+
/** The maximum number of record sets to return. If not specified, returns up to 100 record sets. */
|
|
322
|
+
top?: number;
|
|
323
|
+
/** The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix> */
|
|
324
|
+
recordsetnamesuffix?: string;
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
/** Contains response data for the listByDnsZoneNext operation. */
|
|
328
|
+
export declare type RecordSetsListByDnsZoneNextResponse = RecordSetListResult;
|
|
329
|
+
|
|
330
|
+
/** Optional parameters. */
|
|
331
|
+
export declare interface RecordSetsListByDnsZoneOptionalParams extends coreClient.OperationOptions {
|
|
332
|
+
/** The maximum number of record sets to return. If not specified, returns up to 100 record sets. */
|
|
333
|
+
top?: number;
|
|
334
|
+
/** The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix> */
|
|
335
|
+
recordsetnamesuffix?: string;
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
/** Contains response data for the listByDnsZone operation. */
|
|
339
|
+
export declare type RecordSetsListByDnsZoneResponse = RecordSetListResult;
|
|
340
|
+
|
|
341
|
+
/** Optional parameters. */
|
|
342
|
+
export declare interface RecordSetsListByTypeNextOptionalParams extends coreClient.OperationOptions {
|
|
343
|
+
/** The maximum number of record sets to return. If not specified, returns up to 100 record sets. */
|
|
344
|
+
top?: number;
|
|
345
|
+
/** The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix> */
|
|
346
|
+
recordsetnamesuffix?: string;
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
/** Contains response data for the listByTypeNext operation. */
|
|
350
|
+
export declare type RecordSetsListByTypeNextResponse = RecordSetListResult;
|
|
351
|
+
|
|
352
|
+
/** Optional parameters. */
|
|
353
|
+
export declare interface RecordSetsListByTypeOptionalParams extends coreClient.OperationOptions {
|
|
354
|
+
/** The maximum number of record sets to return. If not specified, returns up to 100 record sets. */
|
|
355
|
+
top?: number;
|
|
356
|
+
/** The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix> */
|
|
357
|
+
recordsetnamesuffix?: string;
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
/** Contains response data for the listByType operation. */
|
|
361
|
+
export declare type RecordSetsListByTypeResponse = RecordSetListResult;
|
|
362
|
+
|
|
363
|
+
/** Optional parameters. */
|
|
364
|
+
export declare interface RecordSetsUpdateOptionalParams extends coreClient.OperationOptions {
|
|
365
|
+
/** The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting concurrent changes. */
|
|
366
|
+
ifMatch?: string;
|
|
367
|
+
}
|
|
368
|
+
|
|
369
|
+
/** Contains response data for the update operation. */
|
|
370
|
+
export declare type RecordSetsUpdateResponse = RecordSet;
|
|
371
|
+
|
|
372
|
+
/** Parameters supplied to update a record set. */
|
|
373
|
+
export declare interface RecordSetUpdateParameters {
|
|
374
|
+
/** Specifies information about the record set being updated. */
|
|
375
|
+
recordSet?: RecordSet;
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
/** Defines values for RecordType. */
|
|
379
|
+
export declare type RecordType = "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "PTR" | "SOA" | "SRV" | "TXT";
|
|
380
|
+
|
|
381
|
+
/** Common properties of an Azure Resource Manager resource */
|
|
382
|
+
export declare interface Resource {
|
|
383
|
+
/**
|
|
384
|
+
* Resource ID.
|
|
385
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
386
|
+
*/
|
|
387
|
+
readonly id?: string;
|
|
388
|
+
/**
|
|
389
|
+
* Resource name.
|
|
390
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
391
|
+
*/
|
|
392
|
+
readonly name?: string;
|
|
393
|
+
/**
|
|
394
|
+
* Resource type.
|
|
395
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
396
|
+
*/
|
|
397
|
+
readonly type?: string;
|
|
398
|
+
/** Resource location. */
|
|
399
|
+
location: string;
|
|
400
|
+
/** Resource tags. */
|
|
401
|
+
tags?: {
|
|
402
|
+
[propertyName: string]: string;
|
|
403
|
+
};
|
|
404
|
+
}
|
|
405
|
+
|
|
406
|
+
/** An SOA record. */
|
|
407
|
+
export declare interface SoaRecord {
|
|
408
|
+
/** The domain name of the authoritative name server for this SOA record. */
|
|
409
|
+
host?: string;
|
|
410
|
+
/** The email contact for this SOA record. */
|
|
411
|
+
email?: string;
|
|
412
|
+
/** The serial number for this SOA record. */
|
|
413
|
+
serialNumber?: number;
|
|
414
|
+
/** The refresh value for this SOA record. */
|
|
415
|
+
refreshTime?: number;
|
|
416
|
+
/** The retry time for this SOA record. */
|
|
417
|
+
retryTime?: number;
|
|
418
|
+
/** The expire time for this SOA record. */
|
|
419
|
+
expireTime?: number;
|
|
420
|
+
/** The minimum value for this SOA record. By convention this is used to determine the negative caching duration. */
|
|
421
|
+
minimumTtl?: number;
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
/** An SRV record. */
|
|
425
|
+
export declare interface SrvRecord {
|
|
426
|
+
/** The priority value for this SRV record. */
|
|
427
|
+
priority?: number;
|
|
428
|
+
/** The weight value for this SRV record. */
|
|
429
|
+
weight?: number;
|
|
430
|
+
/** The port value for this SRV record. */
|
|
431
|
+
port?: number;
|
|
432
|
+
/** The target domain name for this SRV record. */
|
|
433
|
+
target?: string;
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
/** A reference to a another resource */
|
|
437
|
+
export declare interface SubResource {
|
|
438
|
+
/** Resource Id. */
|
|
439
|
+
id?: string;
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
/** A TXT record. */
|
|
443
|
+
export declare interface TxtRecord {
|
|
444
|
+
/** The text value of this TXT record. */
|
|
445
|
+
value?: string[];
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
/** Describes a DNS zone. */
|
|
449
|
+
export declare type Zone = Resource & {
|
|
450
|
+
/** The etag of the zone. */
|
|
451
|
+
etag?: string;
|
|
452
|
+
/**
|
|
453
|
+
* The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
|
|
454
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
455
|
+
*/
|
|
456
|
+
readonly maxNumberOfRecordSets?: number;
|
|
457
|
+
/**
|
|
458
|
+
* The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
|
|
459
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
460
|
+
*/
|
|
461
|
+
readonly maxNumberOfRecordsPerRecordSet?: number;
|
|
462
|
+
/**
|
|
463
|
+
* The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
|
|
464
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
465
|
+
*/
|
|
466
|
+
readonly numberOfRecordSets?: number;
|
|
467
|
+
/**
|
|
468
|
+
* The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
|
|
469
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
470
|
+
*/
|
|
471
|
+
readonly nameServers?: string[];
|
|
472
|
+
/** The type of this DNS zone (Public or Private). */
|
|
473
|
+
zoneType?: ZoneType;
|
|
474
|
+
/** A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. */
|
|
475
|
+
registrationVirtualNetworks?: SubResource[];
|
|
476
|
+
/** A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. */
|
|
477
|
+
resolutionVirtualNetworks?: SubResource[];
|
|
478
|
+
};
|
|
479
|
+
|
|
480
|
+
/** The response to a Zone List or ListAll operation. */
|
|
481
|
+
export declare interface ZoneListResult {
|
|
482
|
+
/** Information about the DNS zones. */
|
|
483
|
+
value?: Zone[];
|
|
484
|
+
/**
|
|
485
|
+
* The continuation token for the next page of results.
|
|
486
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
487
|
+
*/
|
|
488
|
+
readonly nextLink?: string;
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
/** Interface representing a Zones. */
|
|
492
|
+
export declare interface Zones {
|
|
493
|
+
/**
|
|
494
|
+
* Lists the DNS zones within a resource group.
|
|
495
|
+
* @param resourceGroupName The name of the resource group.
|
|
496
|
+
* @param options The options parameters.
|
|
497
|
+
*/
|
|
498
|
+
listByResourceGroup(resourceGroupName: string, options?: ZonesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Zone>;
|
|
499
|
+
/**
|
|
500
|
+
* Lists the DNS zones in all resource groups in a subscription.
|
|
501
|
+
* @param options The options parameters.
|
|
502
|
+
*/
|
|
503
|
+
list(options?: ZonesListOptionalParams): PagedAsyncIterableIterator<Zone>;
|
|
504
|
+
/**
|
|
505
|
+
* Creates or updates a DNS zone. Does not modify DNS records within the zone.
|
|
506
|
+
* @param resourceGroupName The name of the resource group.
|
|
507
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
508
|
+
* @param parameters Parameters supplied to the CreateOrUpdate operation.
|
|
509
|
+
* @param options The options parameters.
|
|
510
|
+
*/
|
|
511
|
+
createOrUpdate(resourceGroupName: string, zoneName: string, parameters: Zone, options?: ZonesCreateOrUpdateOptionalParams): Promise<ZonesCreateOrUpdateResponse>;
|
|
512
|
+
/**
|
|
513
|
+
* Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot
|
|
514
|
+
* be undone.
|
|
515
|
+
* @param resourceGroupName The name of the resource group.
|
|
516
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
517
|
+
* @param options The options parameters.
|
|
518
|
+
*/
|
|
519
|
+
beginDelete(resourceGroupName: string, zoneName: string, options?: ZonesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
|
|
520
|
+
/**
|
|
521
|
+
* Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot
|
|
522
|
+
* be undone.
|
|
523
|
+
* @param resourceGroupName The name of the resource group.
|
|
524
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
525
|
+
* @param options The options parameters.
|
|
526
|
+
*/
|
|
527
|
+
beginDeleteAndWait(resourceGroupName: string, zoneName: string, options?: ZonesDeleteOptionalParams): Promise<void>;
|
|
528
|
+
/**
|
|
529
|
+
* Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
|
|
530
|
+
* @param resourceGroupName The name of the resource group.
|
|
531
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
532
|
+
* @param options The options parameters.
|
|
533
|
+
*/
|
|
534
|
+
get(resourceGroupName: string, zoneName: string, options?: ZonesGetOptionalParams): Promise<ZonesGetResponse>;
|
|
535
|
+
/**
|
|
536
|
+
* Updates a DNS zone. Does not modify DNS records within the zone.
|
|
537
|
+
* @param resourceGroupName The name of the resource group.
|
|
538
|
+
* @param zoneName The name of the DNS zone (without a terminating dot).
|
|
539
|
+
* @param parameters Parameters supplied to the Update operation.
|
|
540
|
+
* @param options The options parameters.
|
|
541
|
+
*/
|
|
542
|
+
update(resourceGroupName: string, zoneName: string, parameters: ZoneUpdate, options?: ZonesUpdateOptionalParams): Promise<ZonesUpdateResponse>;
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
/** Optional parameters. */
|
|
546
|
+
export declare interface ZonesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
547
|
+
/** The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes. */
|
|
548
|
+
ifMatch?: string;
|
|
549
|
+
/** Set to '*' to allow a new DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored. */
|
|
550
|
+
ifNoneMatch?: string;
|
|
551
|
+
}
|
|
552
|
+
|
|
553
|
+
/** Contains response data for the createOrUpdate operation. */
|
|
554
|
+
export declare type ZonesCreateOrUpdateResponse = Zone;
|
|
555
|
+
|
|
556
|
+
/** Optional parameters. */
|
|
557
|
+
export declare interface ZonesDeleteOptionalParams extends coreClient.OperationOptions {
|
|
558
|
+
/** The etag of the DNS zone. Omit this value to always delete the current zone. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes. */
|
|
559
|
+
ifMatch?: string;
|
|
560
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
561
|
+
updateIntervalInMs?: number;
|
|
562
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
563
|
+
resumeFrom?: string;
|
|
564
|
+
}
|
|
565
|
+
|
|
566
|
+
/** Optional parameters. */
|
|
567
|
+
export declare interface ZonesGetOptionalParams extends coreClient.OperationOptions {
|
|
568
|
+
}
|
|
569
|
+
|
|
570
|
+
/** Contains response data for the get operation. */
|
|
571
|
+
export declare type ZonesGetResponse = Zone;
|
|
572
|
+
|
|
573
|
+
/** Optional parameters. */
|
|
574
|
+
export declare interface ZonesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
|
|
575
|
+
/** The maximum number of record sets to return. If not specified, returns up to 100 record sets. */
|
|
576
|
+
top?: number;
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
/** Contains response data for the listByResourceGroupNext operation. */
|
|
580
|
+
export declare type ZonesListByResourceGroupNextResponse = ZoneListResult;
|
|
581
|
+
|
|
582
|
+
/** Optional parameters. */
|
|
583
|
+
export declare interface ZonesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
|
|
584
|
+
/** The maximum number of record sets to return. If not specified, returns up to 100 record sets. */
|
|
585
|
+
top?: number;
|
|
586
|
+
}
|
|
587
|
+
|
|
588
|
+
/** Contains response data for the listByResourceGroup operation. */
|
|
589
|
+
export declare type ZonesListByResourceGroupResponse = ZoneListResult;
|
|
590
|
+
|
|
591
|
+
/** Optional parameters. */
|
|
592
|
+
export declare interface ZonesListNextOptionalParams extends coreClient.OperationOptions {
|
|
593
|
+
/** The maximum number of DNS zones to return. If not specified, returns up to 100 zones. */
|
|
594
|
+
top?: number;
|
|
595
|
+
}
|
|
596
|
+
|
|
597
|
+
/** Contains response data for the listNext operation. */
|
|
598
|
+
export declare type ZonesListNextResponse = ZoneListResult;
|
|
599
|
+
|
|
600
|
+
/** Optional parameters. */
|
|
601
|
+
export declare interface ZonesListOptionalParams extends coreClient.OperationOptions {
|
|
602
|
+
/** The maximum number of DNS zones to return. If not specified, returns up to 100 zones. */
|
|
603
|
+
top?: number;
|
|
604
|
+
}
|
|
605
|
+
|
|
606
|
+
/** Contains response data for the list operation. */
|
|
607
|
+
export declare type ZonesListResponse = ZoneListResult;
|
|
608
|
+
|
|
609
|
+
/** Optional parameters. */
|
|
610
|
+
export declare interface ZonesUpdateOptionalParams extends coreClient.OperationOptions {
|
|
611
|
+
/** The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes. */
|
|
612
|
+
ifMatch?: string;
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
/** Contains response data for the update operation. */
|
|
616
|
+
export declare type ZonesUpdateResponse = Zone;
|
|
617
|
+
|
|
618
|
+
/** Defines values for ZoneType. */
|
|
619
|
+
export declare type ZoneType = "Public" | "Private";
|
|
620
|
+
|
|
621
|
+
/** Describes a request to update a DNS zone. */
|
|
622
|
+
export declare interface ZoneUpdate {
|
|
623
|
+
/** Resource tags. */
|
|
624
|
+
tags?: {
|
|
625
|
+
[propertyName: string]: string;
|
|
626
|
+
};
|
|
627
|
+
}
|
|
628
|
+
|
|
629
|
+
export { }
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
|
|
2
|
+
// It should be published with your NPM package. It should not be tracked by Git.
|
|
3
|
+
{
|
|
4
|
+
"tsdocVersion": "0.12",
|
|
5
|
+
"toolPackages": [
|
|
6
|
+
{
|
|
7
|
+
"packageName": "@microsoft/api-extractor",
|
|
8
|
+
"packageVersion": "7.19.2"
|
|
9
|
+
}
|
|
10
|
+
]
|
|
11
|
+
}
|