@azure-rest/arm-appservice 1.0.0-beta.1 → 1.0.0-beta.3
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 +21 -0
- package/LICENSE +4 -4
- package/README.md +35 -23
- package/dist/browser/clientDefinitions.d.ts +3273 -0
- package/dist/browser/clientDefinitions.d.ts.map +1 -0
- package/dist/browser/clientDefinitions.js +4 -0
- package/dist/browser/clientDefinitions.js.map +1 -0
- package/dist/browser/index.d.ts +12 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +14 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/isUnexpected.d.ts +654 -0
- package/dist/browser/isUnexpected.d.ts.map +1 -0
- package/dist/browser/isUnexpected.js +761 -0
- package/dist/browser/isUnexpected.js.map +1 -0
- package/dist/browser/logger.d.ts +2 -0
- package/dist/browser/logger.d.ts.map +1 -0
- package/dist/browser/logger.js +5 -0
- package/dist/browser/logger.js.map +1 -0
- package/dist/browser/models.d.ts +4422 -0
- package/dist/browser/models.d.ts.map +1 -0
- package/dist/browser/models.js +4 -0
- package/dist/browser/models.js.map +1 -0
- package/dist/browser/outputModels.d.ts +6074 -0
- package/dist/browser/outputModels.d.ts.map +1 -0
- package/dist/browser/outputModels.js +4 -0
- package/dist/browser/outputModels.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/paginateHelper.d.ts +68 -0
- package/dist/browser/paginateHelper.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/paginateHelper.js +70 -3
- package/dist/browser/paginateHelper.js.map +1 -0
- package/dist/browser/parameters.d.ts +2468 -0
- package/dist/browser/parameters.d.ts.map +1 -0
- package/dist/browser/parameters.js +4 -0
- package/dist/browser/parameters.js.map +1 -0
- package/dist/browser/pollingHelper.d.ts +76 -0
- package/dist/browser/pollingHelper.d.ts.map +1 -0
- package/dist/browser/pollingHelper.js +107 -0
- package/dist/browser/pollingHelper.js.map +1 -0
- package/dist/browser/responses.d.ts +7390 -0
- package/dist/browser/responses.d.ts.map +1 -0
- package/dist/browser/responses.js +4 -0
- package/dist/browser/responses.js.map +1 -0
- package/dist/browser/webSiteManagementClient.d.ts +15 -0
- package/dist/browser/webSiteManagementClient.d.ts.map +1 -0
- package/dist/browser/webSiteManagementClient.js +44 -0
- package/dist/browser/webSiteManagementClient.js.map +1 -0
- package/dist/commonjs/clientDefinitions.d.ts +3273 -0
- package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
- package/dist/commonjs/clientDefinitions.js +5 -0
- package/dist/commonjs/clientDefinitions.js.map +1 -0
- package/dist/commonjs/index.d.ts +12 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +17 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/isUnexpected.d.ts +654 -0
- package/dist/commonjs/isUnexpected.d.ts.map +1 -0
- package/dist/commonjs/isUnexpected.js +764 -0
- package/dist/commonjs/isUnexpected.js.map +1 -0
- package/dist/commonjs/logger.d.ts +2 -0
- package/dist/commonjs/logger.d.ts.map +1 -0
- package/dist/commonjs/logger.js +8 -0
- package/dist/commonjs/logger.js.map +1 -0
- package/dist/commonjs/models.d.ts +4422 -0
- package/dist/commonjs/models.d.ts.map +1 -0
- package/dist/commonjs/models.js +5 -0
- package/dist/commonjs/models.js.map +1 -0
- package/dist/commonjs/outputModels.d.ts +6074 -0
- package/dist/commonjs/outputModels.d.ts.map +1 -0
- package/dist/commonjs/outputModels.js +5 -0
- package/dist/commonjs/outputModels.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/paginateHelper.d.ts +68 -0
- package/dist/commonjs/paginateHelper.d.ts.map +1 -0
- package/dist/commonjs/paginateHelper.js +140 -0
- package/dist/commonjs/paginateHelper.js.map +1 -0
- package/dist/commonjs/parameters.d.ts +2468 -0
- package/dist/commonjs/parameters.d.ts.map +1 -0
- package/dist/commonjs/parameters.js +5 -0
- package/dist/commonjs/parameters.js.map +1 -0
- package/dist/commonjs/pollingHelper.d.ts +76 -0
- package/dist/commonjs/pollingHelper.d.ts.map +1 -0
- package/dist/commonjs/pollingHelper.js +110 -0
- package/dist/commonjs/pollingHelper.js.map +1 -0
- package/dist/commonjs/responses.d.ts +7390 -0
- package/dist/commonjs/responses.d.ts.map +1 -0
- package/dist/commonjs/responses.js +5 -0
- package/dist/commonjs/responses.js.map +1 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/commonjs/webSiteManagementClient.d.ts +15 -0
- package/dist/commonjs/webSiteManagementClient.d.ts.map +1 -0
- package/dist/commonjs/webSiteManagementClient.js +47 -0
- package/dist/commonjs/webSiteManagementClient.js.map +1 -0
- package/dist/esm/clientDefinitions.d.ts +3273 -0
- package/dist/esm/clientDefinitions.d.ts.map +1 -0
- package/dist/esm/clientDefinitions.js +4 -0
- package/dist/esm/clientDefinitions.js.map +1 -0
- package/dist/esm/index.d.ts +12 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +14 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/isUnexpected.d.ts +654 -0
- package/dist/esm/isUnexpected.d.ts.map +1 -0
- package/dist/esm/isUnexpected.js +761 -0
- package/dist/esm/isUnexpected.js.map +1 -0
- package/dist/esm/logger.d.ts +2 -0
- package/dist/esm/logger.d.ts.map +1 -0
- package/dist/esm/logger.js +5 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/models.d.ts +4422 -0
- package/dist/esm/models.d.ts.map +1 -0
- package/dist/esm/models.js +4 -0
- package/dist/esm/models.js.map +1 -0
- package/dist/esm/outputModels.d.ts +6074 -0
- package/dist/esm/outputModels.d.ts.map +1 -0
- package/dist/esm/outputModels.js +4 -0
- package/dist/esm/outputModels.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/paginateHelper.d.ts +68 -0
- package/dist/esm/paginateHelper.d.ts.map +1 -0
- package/dist/esm/paginateHelper.js +137 -0
- package/dist/esm/paginateHelper.js.map +1 -0
- package/dist/esm/parameters.d.ts +2468 -0
- package/dist/esm/parameters.d.ts.map +1 -0
- package/dist/esm/parameters.js +4 -0
- package/dist/esm/parameters.js.map +1 -0
- package/dist/esm/pollingHelper.d.ts +76 -0
- package/dist/esm/pollingHelper.d.ts.map +1 -0
- package/dist/esm/pollingHelper.js +107 -0
- package/dist/esm/pollingHelper.js.map +1 -0
- package/dist/esm/responses.d.ts +7390 -0
- package/dist/esm/responses.d.ts.map +1 -0
- package/dist/esm/responses.js +4 -0
- package/dist/esm/responses.js.map +1 -0
- package/dist/esm/webSiteManagementClient.d.ts +15 -0
- package/dist/esm/webSiteManagementClient.d.ts.map +1 -0
- package/dist/esm/webSiteManagementClient.js +44 -0
- package/dist/esm/webSiteManagementClient.js.map +1 -0
- package/dist/react-native/clientDefinitions.d.ts +3273 -0
- package/dist/react-native/clientDefinitions.d.ts.map +1 -0
- package/dist/react-native/clientDefinitions.js +4 -0
- package/dist/react-native/clientDefinitions.js.map +1 -0
- package/dist/react-native/index.d.ts +12 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +14 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/isUnexpected.d.ts +654 -0
- package/dist/react-native/isUnexpected.d.ts.map +1 -0
- package/dist/react-native/isUnexpected.js +761 -0
- package/dist/react-native/isUnexpected.js.map +1 -0
- package/dist/react-native/logger.d.ts +2 -0
- package/dist/react-native/logger.d.ts.map +1 -0
- package/dist/react-native/logger.js +5 -0
- package/dist/react-native/logger.js.map +1 -0
- package/dist/react-native/models.d.ts +4422 -0
- package/dist/react-native/models.d.ts.map +1 -0
- package/dist/react-native/models.js +4 -0
- package/dist/react-native/models.js.map +1 -0
- package/dist/react-native/outputModels.d.ts +6074 -0
- package/dist/react-native/outputModels.d.ts.map +1 -0
- package/dist/react-native/outputModels.js +4 -0
- package/dist/react-native/outputModels.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/dist/react-native/paginateHelper.d.ts +68 -0
- package/dist/react-native/paginateHelper.d.ts.map +1 -0
- package/dist/react-native/paginateHelper.js +137 -0
- package/dist/react-native/paginateHelper.js.map +1 -0
- package/dist/react-native/parameters.d.ts +2468 -0
- package/dist/react-native/parameters.d.ts.map +1 -0
- package/dist/react-native/parameters.js +4 -0
- package/dist/react-native/parameters.js.map +1 -0
- package/dist/react-native/pollingHelper.d.ts +76 -0
- package/dist/react-native/pollingHelper.d.ts.map +1 -0
- package/dist/react-native/pollingHelper.js +107 -0
- package/dist/react-native/pollingHelper.js.map +1 -0
- package/dist/react-native/responses.d.ts +7390 -0
- package/dist/react-native/responses.d.ts.map +1 -0
- package/dist/react-native/responses.js +4 -0
- package/dist/react-native/responses.js.map +1 -0
- package/dist/react-native/webSiteManagementClient.d.ts +15 -0
- package/dist/react-native/webSiteManagementClient.d.ts.map +1 -0
- package/dist/react-native/webSiteManagementClient.js +44 -0
- package/dist/react-native/webSiteManagementClient.js.map +1 -0
- package/package.json +87 -80
- package/review/{arm-appservice.api.md → arm-appservice-node.api.md} +5443 -4440
- package/dist/index.js +0 -144
- package/dist/index.js.map +0 -1
- package/dist-esm/src/clientDefinitions.js +0 -4
- package/dist-esm/src/clientDefinitions.js.map +0 -1
- package/dist-esm/src/index.js +0 -13
- package/dist-esm/src/index.js.map +0 -1
- package/dist-esm/src/models.js +0 -4
- package/dist-esm/src/models.js.map +0 -1
- package/dist-esm/src/outputModels.js +0 -4
- package/dist-esm/src/outputModels.js.map +0 -1
- package/dist-esm/src/paginateHelper.js.map +0 -1
- package/dist-esm/src/parameters.js +0 -4
- package/dist-esm/src/parameters.js.map +0 -1
- package/dist-esm/src/pollingHelper.js +0 -46
- package/dist-esm/src/pollingHelper.js.map +0 -1
- package/dist-esm/src/responses.js +0 -4
- package/dist-esm/src/responses.js.map +0 -1
- package/dist-esm/src/webSiteManagementClient.js +0 -21
- package/dist-esm/src/webSiteManagementClient.js.map +0 -1
- package/types/arm-appservice.d.ts +0 -27921
|
@@ -0,0 +1,4422 @@
|
|
|
1
|
+
/** SSL certificate purchase order. */
|
|
2
|
+
export interface AppServiceCertificateOrder extends Resource {
|
|
3
|
+
/** AppServiceCertificateOrder resource specific properties */
|
|
4
|
+
properties?: AppServiceCertificateOrderProperties;
|
|
5
|
+
}
|
|
6
|
+
/** AppServiceCertificateOrder resource specific properties */
|
|
7
|
+
export interface AppServiceCertificateOrderProperties {
|
|
8
|
+
/** State of the Key Vault secret. */
|
|
9
|
+
certificates?: Record<string, AppServiceCertificate>;
|
|
10
|
+
/** Certificate distinguished name. */
|
|
11
|
+
distinguishedName?: string;
|
|
12
|
+
/** Duration in years (must be 1). */
|
|
13
|
+
validityInYears?: number;
|
|
14
|
+
/** Certificate key size. */
|
|
15
|
+
keySize?: number;
|
|
16
|
+
/** Certificate product type. */
|
|
17
|
+
productType: "StandardDomainValidatedSsl" | "StandardDomainValidatedWildCardSsl";
|
|
18
|
+
/** <code>true</code> if the certificate should be automatically renewed when it expires; otherwise, <code>false</code>. */
|
|
19
|
+
autoRenew?: boolean;
|
|
20
|
+
/** Last CSR that was created for this order. */
|
|
21
|
+
csr?: string;
|
|
22
|
+
}
|
|
23
|
+
/** Key Vault container for a certificate that is purchased through Azure. */
|
|
24
|
+
export interface AppServiceCertificate {
|
|
25
|
+
/** Key Vault resource Id. */
|
|
26
|
+
keyVaultId?: string;
|
|
27
|
+
/** Key Vault secret name. */
|
|
28
|
+
keyVaultSecretName?: string;
|
|
29
|
+
}
|
|
30
|
+
/** SSL certificate details. */
|
|
31
|
+
export interface CertificateDetails {
|
|
32
|
+
}
|
|
33
|
+
export interface CertificateOrderContact {
|
|
34
|
+
email?: string;
|
|
35
|
+
nameFirst?: string;
|
|
36
|
+
nameLast?: string;
|
|
37
|
+
phone?: string;
|
|
38
|
+
}
|
|
39
|
+
/** Azure resource. This resource is tracked in Azure Resource Manager */
|
|
40
|
+
export interface Resource {
|
|
41
|
+
/** Kind of resource. */
|
|
42
|
+
kind?: string;
|
|
43
|
+
/** Resource Location. */
|
|
44
|
+
location: string;
|
|
45
|
+
/** Resource tags. */
|
|
46
|
+
tags?: Record<string, string>;
|
|
47
|
+
}
|
|
48
|
+
/** ARM resource for a certificate order that is purchased through Azure. */
|
|
49
|
+
export interface AppServiceCertificateOrderPatchResource extends ProxyOnlyResource {
|
|
50
|
+
/** AppServiceCertificateOrderPatchResource resource specific properties */
|
|
51
|
+
properties?: AppServiceCertificateOrderPatchResourceProperties;
|
|
52
|
+
}
|
|
53
|
+
/** AppServiceCertificateOrderPatchResource resource specific properties */
|
|
54
|
+
export interface AppServiceCertificateOrderPatchResourceProperties {
|
|
55
|
+
/** State of the Key Vault secret. */
|
|
56
|
+
certificates?: Record<string, AppServiceCertificate>;
|
|
57
|
+
/** Certificate distinguished name. */
|
|
58
|
+
distinguishedName?: string;
|
|
59
|
+
/** Duration in years (must be 1). */
|
|
60
|
+
validityInYears?: number;
|
|
61
|
+
/** Certificate key size. */
|
|
62
|
+
keySize?: number;
|
|
63
|
+
/** Certificate product type. */
|
|
64
|
+
productType: "StandardDomainValidatedSsl" | "StandardDomainValidatedWildCardSsl";
|
|
65
|
+
/** <code>true</code> if the certificate should be automatically renewed when it expires; otherwise, <code>false</code>. */
|
|
66
|
+
autoRenew?: boolean;
|
|
67
|
+
/** Last CSR that was created for this order. */
|
|
68
|
+
csr?: string;
|
|
69
|
+
}
|
|
70
|
+
/** Azure proxy only resource. This resource is not tracked by Azure Resource Manager. */
|
|
71
|
+
export interface ProxyOnlyResource {
|
|
72
|
+
/** Kind of resource. */
|
|
73
|
+
kind?: string;
|
|
74
|
+
}
|
|
75
|
+
/** Key Vault container ARM resource for a certificate that is purchased through Azure. */
|
|
76
|
+
export interface AppServiceCertificateResource extends Resource {
|
|
77
|
+
/** Core resource properties */
|
|
78
|
+
properties?: AppServiceCertificate;
|
|
79
|
+
}
|
|
80
|
+
/** Key Vault container ARM resource for a certificate that is purchased through Azure. */
|
|
81
|
+
export interface AppServiceCertificatePatchResource extends ProxyOnlyResource {
|
|
82
|
+
/** Core resource properties */
|
|
83
|
+
properties?: AppServiceCertificate;
|
|
84
|
+
}
|
|
85
|
+
/** Class representing certificate reissue request. */
|
|
86
|
+
export interface ReissueCertificateOrderRequest extends ProxyOnlyResource {
|
|
87
|
+
/** ReissueCertificateOrderRequest resource specific properties */
|
|
88
|
+
properties?: ReissueCertificateOrderRequestProperties;
|
|
89
|
+
}
|
|
90
|
+
/** ReissueCertificateOrderRequest resource specific properties */
|
|
91
|
+
export interface ReissueCertificateOrderRequestProperties {
|
|
92
|
+
/** Certificate Key Size. */
|
|
93
|
+
keySize?: number;
|
|
94
|
+
/** Delay in hours to revoke existing certificate after the new certificate is issued. */
|
|
95
|
+
delayExistingRevokeInHours?: number;
|
|
96
|
+
/** Csr to be used for re-key operation. */
|
|
97
|
+
csr?: string;
|
|
98
|
+
/** Should we change the ASC type (from managed private key to external private key and vice versa). */
|
|
99
|
+
isPrivateKeyExternal?: boolean;
|
|
100
|
+
}
|
|
101
|
+
/** Class representing certificate renew request. */
|
|
102
|
+
export interface RenewCertificateOrderRequest extends ProxyOnlyResource {
|
|
103
|
+
/** RenewCertificateOrderRequest resource specific properties */
|
|
104
|
+
properties?: RenewCertificateOrderRequestProperties;
|
|
105
|
+
}
|
|
106
|
+
/** RenewCertificateOrderRequest resource specific properties */
|
|
107
|
+
export interface RenewCertificateOrderRequestProperties {
|
|
108
|
+
/** Certificate Key Size. */
|
|
109
|
+
keySize?: number;
|
|
110
|
+
/** Csr to be used for re-key operation. */
|
|
111
|
+
csr?: string;
|
|
112
|
+
/** Should we change the ASC type (from managed private key to external private key and vice versa). */
|
|
113
|
+
isPrivateKeyExternal?: boolean;
|
|
114
|
+
}
|
|
115
|
+
/** Identifies an object. */
|
|
116
|
+
export interface NameIdentifier {
|
|
117
|
+
/** Name of the object. */
|
|
118
|
+
name?: string;
|
|
119
|
+
}
|
|
120
|
+
/** Site seal request. */
|
|
121
|
+
export interface SiteSealRequest {
|
|
122
|
+
/** If <code>true</code> use the light color theme for site seal; otherwise, use the default color theme. */
|
|
123
|
+
lightTheme?: boolean;
|
|
124
|
+
/** Locale of site seal. */
|
|
125
|
+
locale?: string;
|
|
126
|
+
}
|
|
127
|
+
/** Certificate order action. */
|
|
128
|
+
export interface CertificateOrderAction extends ProxyOnlyResource {
|
|
129
|
+
/** CertificateOrderAction resource specific properties */
|
|
130
|
+
properties?: CertificateOrderActionProperties;
|
|
131
|
+
}
|
|
132
|
+
/** CertificateOrderAction resource specific properties */
|
|
133
|
+
export interface CertificateOrderActionProperties {
|
|
134
|
+
}
|
|
135
|
+
/** SSL certificate email. */
|
|
136
|
+
export interface CertificateEmail extends ProxyOnlyResource {
|
|
137
|
+
/** CertificateEmail resource specific properties */
|
|
138
|
+
properties?: CertificateEmailProperties;
|
|
139
|
+
}
|
|
140
|
+
/** CertificateEmail resource specific properties */
|
|
141
|
+
export interface CertificateEmailProperties {
|
|
142
|
+
/** Email id. */
|
|
143
|
+
emailId?: string;
|
|
144
|
+
/** Time stamp. */
|
|
145
|
+
timeStamp?: Date | string;
|
|
146
|
+
}
|
|
147
|
+
/** Class representing Response from Detector */
|
|
148
|
+
export interface DetectorResponse extends ProxyOnlyResource {
|
|
149
|
+
/** DetectorResponse resource specific properties */
|
|
150
|
+
properties?: DetectorResponseProperties;
|
|
151
|
+
}
|
|
152
|
+
/** DetectorResponse resource specific properties */
|
|
153
|
+
export interface DetectorResponseProperties {
|
|
154
|
+
/** metadata for the detector */
|
|
155
|
+
metadata?: DetectorInfo;
|
|
156
|
+
/** Data Set */
|
|
157
|
+
dataset?: Array<DiagnosticData>;
|
|
158
|
+
/** Indicates status of the most severe insight. */
|
|
159
|
+
status?: Status;
|
|
160
|
+
/** Additional configuration for different data providers to be used by the UI */
|
|
161
|
+
dataProvidersMetadata?: Array<DataProviderMetadata>;
|
|
162
|
+
/** Suggested utterances where the detector can be applicable. */
|
|
163
|
+
suggestedUtterances?: QueryUtterancesResults;
|
|
164
|
+
}
|
|
165
|
+
/** Definition of Detector */
|
|
166
|
+
export interface DetectorInfo {
|
|
167
|
+
}
|
|
168
|
+
/** Defines a unique Support Topic */
|
|
169
|
+
export interface SupportTopic {
|
|
170
|
+
}
|
|
171
|
+
/** Set of data with rendering instructions */
|
|
172
|
+
export interface DiagnosticData {
|
|
173
|
+
/** Data in table form */
|
|
174
|
+
table?: DataTableResponseObject;
|
|
175
|
+
/** Properties that describe how the table should be rendered */
|
|
176
|
+
renderingProperties?: Rendering;
|
|
177
|
+
}
|
|
178
|
+
/** Data Table which defines columns and raw row values */
|
|
179
|
+
export interface DataTableResponseObject {
|
|
180
|
+
/** Name of the table */
|
|
181
|
+
tableName?: string;
|
|
182
|
+
/** List of columns with data types */
|
|
183
|
+
columns?: Array<DataTableResponseColumn>;
|
|
184
|
+
/** Raw row values */
|
|
185
|
+
rows?: Array<Array<string>>;
|
|
186
|
+
}
|
|
187
|
+
/** Column definition */
|
|
188
|
+
export interface DataTableResponseColumn {
|
|
189
|
+
/** Name of the column */
|
|
190
|
+
columnName?: string;
|
|
191
|
+
/** Data type which looks like 'String' or 'Int32'. */
|
|
192
|
+
dataType?: string;
|
|
193
|
+
/** Column Type */
|
|
194
|
+
columnType?: string;
|
|
195
|
+
}
|
|
196
|
+
/** Instructions for rendering the data */
|
|
197
|
+
export interface Rendering {
|
|
198
|
+
/** Rendering Type */
|
|
199
|
+
type?: "NoGraph" | "Table" | "TimeSeries" | "TimeSeriesPerInstance" | "PieChart" | "DataSummary" | "Email" | "Insights" | "DynamicInsight" | "Markdown" | "Detector" | "DropDown" | "Card" | "Solution" | "Guage" | "Form" | "ChangeSets" | "ChangeAnalysisOnboarding" | "ChangesView" | "AppInsight" | "DependencyGraph" | "DownTime" | "SummaryCard" | "SearchComponent" | "AppInsightEnablement";
|
|
200
|
+
/** Title of data */
|
|
201
|
+
title?: string;
|
|
202
|
+
/** Description of the data that will help it be interpreted */
|
|
203
|
+
description?: string;
|
|
204
|
+
}
|
|
205
|
+
/** Identify the status of the most severe insight generated by the detector. */
|
|
206
|
+
export interface Status {
|
|
207
|
+
/** Descriptive message. */
|
|
208
|
+
message?: string;
|
|
209
|
+
/** Level of the most severe insight generated by the detector. */
|
|
210
|
+
statusId?: "Critical" | "Warning" | "Info" | "Success" | "None";
|
|
211
|
+
}
|
|
212
|
+
/** Additional configuration for a data providers */
|
|
213
|
+
export interface DataProviderMetadata {
|
|
214
|
+
providerName?: string;
|
|
215
|
+
}
|
|
216
|
+
export interface KeyValuePairStringObject {
|
|
217
|
+
}
|
|
218
|
+
/** Suggested utterances where the detector can be applicable */
|
|
219
|
+
export interface QueryUtterancesResults {
|
|
220
|
+
/** Search Query. */
|
|
221
|
+
query?: string;
|
|
222
|
+
/** Array of utterance results for search query. */
|
|
223
|
+
results?: Array<QueryUtterancesResult>;
|
|
224
|
+
}
|
|
225
|
+
/** Result for utterances query. */
|
|
226
|
+
export interface QueryUtterancesResult {
|
|
227
|
+
/** A sample utterance. */
|
|
228
|
+
sampleUtterance?: SampleUtterance;
|
|
229
|
+
/** Score of a sample utterance. */
|
|
230
|
+
score?: number;
|
|
231
|
+
}
|
|
232
|
+
/** Sample utterance. */
|
|
233
|
+
export interface SampleUtterance {
|
|
234
|
+
/** Text attribute of sample utterance. */
|
|
235
|
+
text?: string;
|
|
236
|
+
/** Links attribute of sample utterance. */
|
|
237
|
+
links?: Array<string>;
|
|
238
|
+
/** Question id of sample utterance (for stackoverflow questions titles). */
|
|
239
|
+
qid?: string;
|
|
240
|
+
}
|
|
241
|
+
/** Information about a domain. */
|
|
242
|
+
export interface Domain extends Resource {
|
|
243
|
+
/** Domain resource specific properties */
|
|
244
|
+
properties?: DomainProperties;
|
|
245
|
+
}
|
|
246
|
+
/** Domain resource specific properties */
|
|
247
|
+
export interface DomainProperties {
|
|
248
|
+
/** Administrative contact. */
|
|
249
|
+
contactAdmin: Contact;
|
|
250
|
+
/** Billing contact. */
|
|
251
|
+
contactBilling: Contact;
|
|
252
|
+
/** Registrant contact. */
|
|
253
|
+
contactRegistrant: Contact;
|
|
254
|
+
/** Technical contact. */
|
|
255
|
+
contactTech: Contact;
|
|
256
|
+
/** <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>. */
|
|
257
|
+
privacy?: boolean;
|
|
258
|
+
/** <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>. */
|
|
259
|
+
autoRenew?: boolean;
|
|
260
|
+
/** Legal agreement consent. */
|
|
261
|
+
consent: DomainPurchaseConsent;
|
|
262
|
+
/** Current DNS type */
|
|
263
|
+
dnsType?: "AzureDns" | "DefaultDomainRegistrarDns";
|
|
264
|
+
/** Azure DNS Zone to use */
|
|
265
|
+
dnsZoneId?: string;
|
|
266
|
+
/** Target DNS type (would be used for migration) */
|
|
267
|
+
targetDnsType?: "AzureDns" | "DefaultDomainRegistrarDns";
|
|
268
|
+
authCode?: string;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois
|
|
272
|
+
* directories as per ICANN requirements.
|
|
273
|
+
*/
|
|
274
|
+
export interface Contact {
|
|
275
|
+
/** Mailing address. */
|
|
276
|
+
addressMailing?: Address;
|
|
277
|
+
/** Email address. */
|
|
278
|
+
email: string;
|
|
279
|
+
/** Fax number. */
|
|
280
|
+
fax?: string;
|
|
281
|
+
/** Job title. */
|
|
282
|
+
jobTitle?: string;
|
|
283
|
+
/** First name. */
|
|
284
|
+
nameFirst: string;
|
|
285
|
+
/** Last name. */
|
|
286
|
+
nameLast: string;
|
|
287
|
+
/** Middle name. */
|
|
288
|
+
nameMiddle?: string;
|
|
289
|
+
/** Organization contact belongs to. */
|
|
290
|
+
organization?: string;
|
|
291
|
+
/** Phone number. */
|
|
292
|
+
phone: string;
|
|
293
|
+
}
|
|
294
|
+
/** Address information for domain registration. */
|
|
295
|
+
export interface Address {
|
|
296
|
+
/** First line of an Address. */
|
|
297
|
+
address1: string;
|
|
298
|
+
/** The second line of the Address. Optional. */
|
|
299
|
+
address2?: string;
|
|
300
|
+
/** The city for the address. */
|
|
301
|
+
city: string;
|
|
302
|
+
/** The country for the address. */
|
|
303
|
+
country: string;
|
|
304
|
+
/** The postal code for the address. */
|
|
305
|
+
postalCode: string;
|
|
306
|
+
/** The state or province for the address. */
|
|
307
|
+
state: string;
|
|
308
|
+
}
|
|
309
|
+
/** Details of a hostname derived from a domain. */
|
|
310
|
+
export interface HostName {
|
|
311
|
+
/** Name of the hostname. */
|
|
312
|
+
name?: string;
|
|
313
|
+
/** List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. */
|
|
314
|
+
siteNames?: Array<string>;
|
|
315
|
+
/** Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. */
|
|
316
|
+
azureResourceName?: string;
|
|
317
|
+
/** Type of the Azure resource the hostname is assigned to. */
|
|
318
|
+
azureResourceType?: "Website" | "TrafficManager";
|
|
319
|
+
/** Type of the DNS record. */
|
|
320
|
+
customHostNameDnsRecordType?: "CName" | "A";
|
|
321
|
+
/** Type of the hostname. */
|
|
322
|
+
hostNameType?: "Verified" | "Managed";
|
|
323
|
+
}
|
|
324
|
+
/** Domain purchase consent object, representing acceptance of applicable legal agreements. */
|
|
325
|
+
export interface DomainPurchaseConsent {
|
|
326
|
+
/** List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under <code>TopLevelDomain</code> resource. */
|
|
327
|
+
agreementKeys?: Array<string>;
|
|
328
|
+
/** Client IP address. */
|
|
329
|
+
agreedBy?: string;
|
|
330
|
+
/** Timestamp when the agreements were accepted. */
|
|
331
|
+
agreedAt?: Date | string;
|
|
332
|
+
}
|
|
333
|
+
/** Domain recommendation search parameters. */
|
|
334
|
+
export interface DomainRecommendationSearchParameters {
|
|
335
|
+
/** Keywords to be used for generating domain recommendations. */
|
|
336
|
+
keywords?: string;
|
|
337
|
+
/** Maximum number of recommendations. */
|
|
338
|
+
maxDomainRecommendations?: number;
|
|
339
|
+
}
|
|
340
|
+
/** ARM resource for a domain. */
|
|
341
|
+
export interface DomainPatchResource extends ProxyOnlyResource {
|
|
342
|
+
/** DomainPatchResource resource specific properties */
|
|
343
|
+
properties?: DomainPatchResourceProperties;
|
|
344
|
+
}
|
|
345
|
+
/** DomainPatchResource resource specific properties */
|
|
346
|
+
export interface DomainPatchResourceProperties {
|
|
347
|
+
/** Administrative contact. */
|
|
348
|
+
contactAdmin: Contact;
|
|
349
|
+
/** Billing contact. */
|
|
350
|
+
contactBilling: Contact;
|
|
351
|
+
/** Registrant contact. */
|
|
352
|
+
contactRegistrant: Contact;
|
|
353
|
+
/** Technical contact. */
|
|
354
|
+
contactTech: Contact;
|
|
355
|
+
/** <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>. */
|
|
356
|
+
privacy?: boolean;
|
|
357
|
+
/** <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>. */
|
|
358
|
+
autoRenew?: boolean;
|
|
359
|
+
/** Legal agreement consent. */
|
|
360
|
+
consent: DomainPurchaseConsent;
|
|
361
|
+
/** Current DNS type */
|
|
362
|
+
dnsType?: "AzureDns" | "DefaultDomainRegistrarDns";
|
|
363
|
+
/** Azure DNS Zone to use */
|
|
364
|
+
dnsZoneId?: string;
|
|
365
|
+
/** Target DNS type (would be used for migration) */
|
|
366
|
+
targetDnsType?: "AzureDns" | "DefaultDomainRegistrarDns";
|
|
367
|
+
authCode?: string;
|
|
368
|
+
}
|
|
369
|
+
/** Domain ownership Identifier. */
|
|
370
|
+
export interface DomainOwnershipIdentifier extends ProxyOnlyResource {
|
|
371
|
+
/** DomainOwnershipIdentifier resource specific properties */
|
|
372
|
+
properties?: DomainOwnershipIdentifierProperties;
|
|
373
|
+
}
|
|
374
|
+
/** DomainOwnershipIdentifier resource specific properties */
|
|
375
|
+
export interface DomainOwnershipIdentifierProperties {
|
|
376
|
+
/** Ownership Id. */
|
|
377
|
+
ownershipId?: string;
|
|
378
|
+
}
|
|
379
|
+
/** A top level domain object. */
|
|
380
|
+
export interface TopLevelDomain extends ProxyOnlyResource {
|
|
381
|
+
/** TopLevelDomain resource specific properties */
|
|
382
|
+
properties?: TopLevelDomainProperties;
|
|
383
|
+
}
|
|
384
|
+
/** TopLevelDomain resource specific properties */
|
|
385
|
+
export interface TopLevelDomainProperties {
|
|
386
|
+
/** If <code>true</code>, then the top level domain supports domain privacy; otherwise, <code>false</code>. */
|
|
387
|
+
privacy?: boolean;
|
|
388
|
+
}
|
|
389
|
+
/** Options for retrieving the list of top level domain legal agreements. */
|
|
390
|
+
export interface TopLevelDomainAgreementOption {
|
|
391
|
+
/** If <code>true</code>, then the list of agreements will include agreements for domain privacy as well; otherwise, <code>false</code>. */
|
|
392
|
+
includePrivacy?: boolean;
|
|
393
|
+
/** If <code>true</code>, then the list of agreements will include agreements for domain transfer as well; otherwise, <code>false</code>. */
|
|
394
|
+
forTransfer?: boolean;
|
|
395
|
+
}
|
|
396
|
+
/** App Service Environment ARM resource. */
|
|
397
|
+
export interface AppServiceEnvironmentResource extends Resource {
|
|
398
|
+
/** Core resource properties */
|
|
399
|
+
properties?: AppServiceEnvironment;
|
|
400
|
+
}
|
|
401
|
+
/** Description of an App Service Environment. */
|
|
402
|
+
export interface AppServiceEnvironment {
|
|
403
|
+
/** Description of the Virtual Network. */
|
|
404
|
+
virtualNetwork: VirtualNetworkProfile;
|
|
405
|
+
/** Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. */
|
|
406
|
+
internalLoadBalancingMode?: "None" | "Web" | "Publishing" | "Web, Publishing";
|
|
407
|
+
/** Front-end VM size, e.g. "Medium", "Large". */
|
|
408
|
+
multiSize?: string;
|
|
409
|
+
/** Number of IP SSL addresses reserved for the App Service Environment. */
|
|
410
|
+
ipsslAddressCount?: number;
|
|
411
|
+
/** DNS suffix of the App Service Environment. */
|
|
412
|
+
dnsSuffix?: string;
|
|
413
|
+
/** Scale factor for front-ends. */
|
|
414
|
+
frontEndScaleFactor?: number;
|
|
415
|
+
/** Custom settings for changing the behavior of the App Service Environment. */
|
|
416
|
+
clusterSettings?: Array<NameValuePair>;
|
|
417
|
+
/** User added ip ranges to whitelist on ASE db */
|
|
418
|
+
userWhitelistedIpRanges?: Array<string>;
|
|
419
|
+
/** Dedicated Host Count */
|
|
420
|
+
dedicatedHostCount?: number;
|
|
421
|
+
/** Whether or not this App Service Environment is zone-redundant. */
|
|
422
|
+
zoneRedundant?: boolean;
|
|
423
|
+
}
|
|
424
|
+
/** Specification for using a Virtual Network. */
|
|
425
|
+
export interface VirtualNetworkProfile {
|
|
426
|
+
/** Resource id of the Virtual Network. */
|
|
427
|
+
id: string;
|
|
428
|
+
/** Subnet within the Virtual Network. */
|
|
429
|
+
subnet?: string;
|
|
430
|
+
}
|
|
431
|
+
/** Name value pair. */
|
|
432
|
+
export interface NameValuePair {
|
|
433
|
+
/** Pair name. */
|
|
434
|
+
name?: string;
|
|
435
|
+
/** Pair value. */
|
|
436
|
+
value?: string;
|
|
437
|
+
}
|
|
438
|
+
/** ARM resource for a app service environment. */
|
|
439
|
+
export interface AppServiceEnvironmentPatchResource extends ProxyOnlyResource {
|
|
440
|
+
/** Core resource properties */
|
|
441
|
+
properties?: AppServiceEnvironment;
|
|
442
|
+
}
|
|
443
|
+
/** Describes main public IP address and any extra virtual IPs. */
|
|
444
|
+
export interface AddressResponse extends ProxyOnlyResource {
|
|
445
|
+
/** AddressResponse resource specific properties */
|
|
446
|
+
properties?: AddressResponseProperties;
|
|
447
|
+
}
|
|
448
|
+
/** AddressResponse resource specific properties */
|
|
449
|
+
export interface AddressResponseProperties {
|
|
450
|
+
/** Main public virtual IP. */
|
|
451
|
+
serviceIpAddress?: string;
|
|
452
|
+
/** Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode. */
|
|
453
|
+
internalIpAddress?: string;
|
|
454
|
+
/** IP addresses appearing on outbound connections. */
|
|
455
|
+
outboundIpAddresses?: Array<string>;
|
|
456
|
+
/** Additional virtual IPs. */
|
|
457
|
+
vipMappings?: Array<VirtualIPMapping>;
|
|
458
|
+
}
|
|
459
|
+
/** Virtual IP mapping. */
|
|
460
|
+
export interface VirtualIPMapping {
|
|
461
|
+
/** Virtual IP address. */
|
|
462
|
+
virtualIP?: string;
|
|
463
|
+
/** Internal HTTP port. */
|
|
464
|
+
internalHttpPort?: number;
|
|
465
|
+
/** Internal HTTPS port. */
|
|
466
|
+
internalHttpsPort?: number;
|
|
467
|
+
/** Is virtual IP mapping in use. */
|
|
468
|
+
inUse?: boolean;
|
|
469
|
+
/** name of the service that virtual IP is assigned to */
|
|
470
|
+
serviceName?: string;
|
|
471
|
+
}
|
|
472
|
+
/** A web app, a mobile app backend, or an API app. */
|
|
473
|
+
export interface Site extends Resource {
|
|
474
|
+
/** Site resource specific properties */
|
|
475
|
+
properties?: SiteProperties;
|
|
476
|
+
/** Managed service identity. */
|
|
477
|
+
identity?: ManagedServiceIdentity;
|
|
478
|
+
/** Extended Location. */
|
|
479
|
+
extendedLocation?: ExtendedLocation;
|
|
480
|
+
}
|
|
481
|
+
/** Site resource specific properties */
|
|
482
|
+
export interface SiteProperties {
|
|
483
|
+
/** <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). */
|
|
484
|
+
enabled?: boolean;
|
|
485
|
+
/** Hostname SSL states are used to manage the SSL bindings for app's hostnames. */
|
|
486
|
+
hostNameSslStates?: Array<HostNameSslState>;
|
|
487
|
+
/** Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". */
|
|
488
|
+
serverFarmId?: string;
|
|
489
|
+
/** <code>true</code> if reserved; otherwise, <code>false</code>. */
|
|
490
|
+
reserved?: boolean;
|
|
491
|
+
/** Obsolete: Hyper-V sandbox. */
|
|
492
|
+
isXenon?: boolean;
|
|
493
|
+
/** Hyper-V sandbox. */
|
|
494
|
+
hyperV?: boolean;
|
|
495
|
+
/** Configuration of the app. */
|
|
496
|
+
siteConfig?: SiteConfig;
|
|
497
|
+
/** <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. */
|
|
498
|
+
scmSiteAlsoStopped?: boolean;
|
|
499
|
+
/** App Service Environment to use for the app. */
|
|
500
|
+
hostingEnvironmentProfile?: HostingEnvironmentProfile;
|
|
501
|
+
/** <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. */
|
|
502
|
+
clientAffinityEnabled?: boolean;
|
|
503
|
+
/** <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. */
|
|
504
|
+
clientCertEnabled?: boolean;
|
|
505
|
+
/**
|
|
506
|
+
* This composes with ClientCertEnabled setting.
|
|
507
|
+
* - ClientCertEnabled: false means ClientCert is ignored.
|
|
508
|
+
* - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
|
|
509
|
+
* - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.
|
|
510
|
+
*/
|
|
511
|
+
clientCertMode?: "Required" | "Optional" | "OptionalInteractiveUser";
|
|
512
|
+
/** client certificate authentication comma-separated exclusion paths */
|
|
513
|
+
clientCertExclusionPaths?: string;
|
|
514
|
+
/**
|
|
515
|
+
* <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.
|
|
516
|
+
* If <code>true</code>, the app is only accessible via API management process.
|
|
517
|
+
*/
|
|
518
|
+
hostNamesDisabled?: boolean;
|
|
519
|
+
/** Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. */
|
|
520
|
+
customDomainVerificationId?: string;
|
|
521
|
+
/** Size of the function container. */
|
|
522
|
+
containerSize?: number;
|
|
523
|
+
/** Maximum allowed daily memory-time quota (applicable on dynamic apps only). */
|
|
524
|
+
dailyMemoryTimeQuota?: number;
|
|
525
|
+
/** If specified during app creation, the app is cloned from a source app. */
|
|
526
|
+
cloningInfo?: CloningInfo;
|
|
527
|
+
/**
|
|
528
|
+
* HttpsOnly: configures a web site to accept only https requests. Issues redirect for
|
|
529
|
+
* http requests
|
|
530
|
+
*/
|
|
531
|
+
httpsOnly?: boolean;
|
|
532
|
+
/** Site redundancy mode */
|
|
533
|
+
redundancyMode?: "None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant";
|
|
534
|
+
/** Checks if Customer provided storage account is required */
|
|
535
|
+
storageAccountRequired?: boolean;
|
|
536
|
+
/** Identity to use for Key Vault Reference authentication. */
|
|
537
|
+
keyVaultReferenceIdentity?: string;
|
|
538
|
+
/**
|
|
539
|
+
* Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.
|
|
540
|
+
* This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}
|
|
541
|
+
*/
|
|
542
|
+
virtualNetworkSubnetId?: string;
|
|
543
|
+
}
|
|
544
|
+
/** SSL-enabled hostname. */
|
|
545
|
+
export interface HostNameSslState {
|
|
546
|
+
/** Hostname. */
|
|
547
|
+
name?: string;
|
|
548
|
+
/** SSL type. */
|
|
549
|
+
sslState?: "Disabled" | "SniEnabled" | "IpBasedEnabled";
|
|
550
|
+
/** Virtual IP address assigned to the hostname if IP based SSL is enabled. */
|
|
551
|
+
virtualIP?: string;
|
|
552
|
+
/** SSL certificate thumbprint. */
|
|
553
|
+
thumbprint?: string;
|
|
554
|
+
/** Set to <code>true</code> to update existing hostname. */
|
|
555
|
+
toUpdate?: boolean;
|
|
556
|
+
/** Indicates whether the hostname is a standard or repository hostname. */
|
|
557
|
+
hostType?: "Standard" | "Repository";
|
|
558
|
+
}
|
|
559
|
+
/** Configuration of an App Service app. */
|
|
560
|
+
export interface SiteConfig {
|
|
561
|
+
/** Number of workers. */
|
|
562
|
+
numberOfWorkers?: number;
|
|
563
|
+
/** Default documents. */
|
|
564
|
+
defaultDocuments?: Array<string>;
|
|
565
|
+
/** .NET Framework version. */
|
|
566
|
+
netFrameworkVersion?: string;
|
|
567
|
+
/** Version of PHP. */
|
|
568
|
+
phpVersion?: string;
|
|
569
|
+
/** Version of Python. */
|
|
570
|
+
pythonVersion?: string;
|
|
571
|
+
/** Version of Node.js. */
|
|
572
|
+
nodeVersion?: string;
|
|
573
|
+
/** Version of PowerShell. */
|
|
574
|
+
powerShellVersion?: string;
|
|
575
|
+
/** Linux App Framework and version */
|
|
576
|
+
linuxFxVersion?: string;
|
|
577
|
+
/** Xenon App Framework and version */
|
|
578
|
+
windowsFxVersion?: string;
|
|
579
|
+
/** <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. */
|
|
580
|
+
requestTracingEnabled?: boolean;
|
|
581
|
+
/** Request tracing expiration time. */
|
|
582
|
+
requestTracingExpirationTime?: Date | string;
|
|
583
|
+
/** <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. */
|
|
584
|
+
remoteDebuggingEnabled?: boolean;
|
|
585
|
+
/** Remote debugging version. */
|
|
586
|
+
remoteDebuggingVersion?: string;
|
|
587
|
+
/** <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. */
|
|
588
|
+
httpLoggingEnabled?: boolean;
|
|
589
|
+
/** Flag to use Managed Identity Creds for ACR pull */
|
|
590
|
+
acrUseManagedIdentityCreds?: boolean;
|
|
591
|
+
/** If using user managed identity, the user managed identity ClientId */
|
|
592
|
+
acrUserManagedIdentityID?: string;
|
|
593
|
+
/** HTTP logs directory size limit. */
|
|
594
|
+
logsDirectorySizeLimit?: number;
|
|
595
|
+
/** <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. */
|
|
596
|
+
detailedErrorLoggingEnabled?: boolean;
|
|
597
|
+
/** Publishing user name. */
|
|
598
|
+
publishingUsername?: string;
|
|
599
|
+
/** Application settings. */
|
|
600
|
+
appSettings?: Array<NameValuePair>;
|
|
601
|
+
/** Connection strings. */
|
|
602
|
+
connectionStrings?: Array<ConnStringInfo>;
|
|
603
|
+
/** Handler mappings. */
|
|
604
|
+
handlerMappings?: Array<HandlerMapping>;
|
|
605
|
+
/** Document root. */
|
|
606
|
+
documentRoot?: string;
|
|
607
|
+
/** SCM type. */
|
|
608
|
+
scmType?: "None" | "Dropbox" | "Tfs" | "LocalGit" | "GitHub" | "CodePlexGit" | "CodePlexHg" | "BitbucketGit" | "BitbucketHg" | "ExternalGit" | "ExternalHg" | "OneDrive" | "VSO" | "VSTSRM";
|
|
609
|
+
/** <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. */
|
|
610
|
+
use32BitWorkerProcess?: boolean;
|
|
611
|
+
/** <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. */
|
|
612
|
+
webSocketsEnabled?: boolean;
|
|
613
|
+
/** <code>true</code> if Always On is enabled; otherwise, <code>false</code>. */
|
|
614
|
+
alwaysOn?: boolean;
|
|
615
|
+
/** Java version. */
|
|
616
|
+
javaVersion?: string;
|
|
617
|
+
/** Java container. */
|
|
618
|
+
javaContainer?: string;
|
|
619
|
+
/** Java container version. */
|
|
620
|
+
javaContainerVersion?: string;
|
|
621
|
+
/** App command line to launch. */
|
|
622
|
+
appCommandLine?: string;
|
|
623
|
+
/** Managed pipeline mode. */
|
|
624
|
+
managedPipelineMode?: "Integrated" | "Classic";
|
|
625
|
+
/** Virtual applications. */
|
|
626
|
+
virtualApplications?: Array<VirtualApplication>;
|
|
627
|
+
/** Site load balancing. */
|
|
628
|
+
loadBalancing?: "WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash" | "PerSiteRoundRobin";
|
|
629
|
+
/** This is work around for polymorphic types. */
|
|
630
|
+
experiments?: Experiments;
|
|
631
|
+
/** Site limits. */
|
|
632
|
+
limits?: SiteLimits;
|
|
633
|
+
/** <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. */
|
|
634
|
+
autoHealEnabled?: boolean;
|
|
635
|
+
/** Auto Heal rules. */
|
|
636
|
+
autoHealRules?: AutoHealRules;
|
|
637
|
+
/** Tracing options. */
|
|
638
|
+
tracingOptions?: string;
|
|
639
|
+
/** Virtual Network name. */
|
|
640
|
+
vnetName?: string;
|
|
641
|
+
/** Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. */
|
|
642
|
+
vnetRouteAllEnabled?: boolean;
|
|
643
|
+
/** The number of private ports assigned to this app. These will be assigned dynamically on runtime. */
|
|
644
|
+
vnetPrivatePortsCount?: number;
|
|
645
|
+
/** Cross-Origin Resource Sharing (CORS) settings. */
|
|
646
|
+
cors?: CorsSettings;
|
|
647
|
+
/** Push endpoint settings. */
|
|
648
|
+
push?: PushSettings;
|
|
649
|
+
/** Information about the formal API definition for the app. */
|
|
650
|
+
apiDefinition?: ApiDefinitionInfo;
|
|
651
|
+
/** Azure API management settings linked to the app. */
|
|
652
|
+
apiManagementConfig?: ApiManagementConfig;
|
|
653
|
+
/** Auto-swap slot name. */
|
|
654
|
+
autoSwapSlotName?: string;
|
|
655
|
+
/** <code>true</code> to enable local MySQL; otherwise, <code>false</code>. */
|
|
656
|
+
localMySqlEnabled?: boolean;
|
|
657
|
+
/** Managed Service Identity Id */
|
|
658
|
+
managedServiceIdentityId?: number;
|
|
659
|
+
/** Explicit Managed Service Identity Id */
|
|
660
|
+
xManagedServiceIdentityId?: number;
|
|
661
|
+
/** Identity to use for Key Vault Reference authentication. */
|
|
662
|
+
keyVaultReferenceIdentity?: string;
|
|
663
|
+
/** IP security restrictions for main. */
|
|
664
|
+
ipSecurityRestrictions?: Array<IpSecurityRestriction>;
|
|
665
|
+
/** IP security restrictions for scm. */
|
|
666
|
+
scmIpSecurityRestrictions?: Array<IpSecurityRestriction>;
|
|
667
|
+
/** IP security restrictions for scm to use main. */
|
|
668
|
+
scmIpSecurityRestrictionsUseMain?: boolean;
|
|
669
|
+
/** Http20Enabled: configures a web site to allow clients to connect over http2.0 */
|
|
670
|
+
http20Enabled?: boolean;
|
|
671
|
+
/** MinTlsVersion: configures the minimum version of TLS required for SSL requests */
|
|
672
|
+
minTlsVersion?: "1.0" | "1.1" | "1.2";
|
|
673
|
+
/** ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site */
|
|
674
|
+
scmMinTlsVersion?: "1.0" | "1.1" | "1.2";
|
|
675
|
+
/** State of FTP / FTPS service */
|
|
676
|
+
ftpsState?: "AllAllowed" | "FtpsOnly" | "Disabled";
|
|
677
|
+
/**
|
|
678
|
+
* Number of preWarmed instances.
|
|
679
|
+
* This setting only applies to the Consumption and Elastic Plans
|
|
680
|
+
*/
|
|
681
|
+
preWarmedInstanceCount?: number;
|
|
682
|
+
/**
|
|
683
|
+
* Maximum number of workers that a site can scale out to.
|
|
684
|
+
* This setting only applies to the Consumption and Elastic Premium Plans
|
|
685
|
+
*/
|
|
686
|
+
functionAppScaleLimit?: number;
|
|
687
|
+
/** Health check path */
|
|
688
|
+
healthCheckPath?: string;
|
|
689
|
+
/**
|
|
690
|
+
* Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,
|
|
691
|
+
* the ScaleController will not monitor event sources directly, but will instead call to the
|
|
692
|
+
* runtime to get scale status.
|
|
693
|
+
*/
|
|
694
|
+
functionsRuntimeScaleMonitoringEnabled?: boolean;
|
|
695
|
+
/** Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones */
|
|
696
|
+
websiteTimeZone?: string;
|
|
697
|
+
/**
|
|
698
|
+
* Number of minimum instance count for a site
|
|
699
|
+
* This setting only applies to the Elastic Plans
|
|
700
|
+
*/
|
|
701
|
+
minimumElasticInstanceCount?: number;
|
|
702
|
+
/** List of Azure Storage Accounts. */
|
|
703
|
+
azureStorageAccounts?: Record<string, AzureStorageInfoValue>;
|
|
704
|
+
/** Property to allow or block all public traffic. */
|
|
705
|
+
publicNetworkAccess?: string;
|
|
706
|
+
}
|
|
707
|
+
/** Database connection string information. */
|
|
708
|
+
export interface ConnStringInfo {
|
|
709
|
+
/** Name of connection string. */
|
|
710
|
+
name?: string;
|
|
711
|
+
/** Connection string value. */
|
|
712
|
+
connectionString?: string;
|
|
713
|
+
/** Type of database. */
|
|
714
|
+
type?: "MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL";
|
|
715
|
+
}
|
|
716
|
+
/** MachineKey of an app. */
|
|
717
|
+
export interface SiteMachineKey {
|
|
718
|
+
/** MachineKey validation. */
|
|
719
|
+
validation?: string;
|
|
720
|
+
/** Validation key. */
|
|
721
|
+
validationKey?: string;
|
|
722
|
+
/** Algorithm used for decryption. */
|
|
723
|
+
decryption?: string;
|
|
724
|
+
/** Decryption key. */
|
|
725
|
+
decryptionKey?: string;
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* The IIS handler mappings used to define which handler processes HTTP requests with certain extension.
|
|
729
|
+
* For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.
|
|
730
|
+
*/
|
|
731
|
+
export interface HandlerMapping {
|
|
732
|
+
/** Requests with this extension will be handled using the specified FastCGI application. */
|
|
733
|
+
extension?: string;
|
|
734
|
+
/** The absolute path to the FastCGI application. */
|
|
735
|
+
scriptProcessor?: string;
|
|
736
|
+
/** Command-line arguments to be passed to the script processor. */
|
|
737
|
+
arguments?: string;
|
|
738
|
+
}
|
|
739
|
+
/** Virtual application in an app. */
|
|
740
|
+
export interface VirtualApplication {
|
|
741
|
+
/** Virtual path. */
|
|
742
|
+
virtualPath?: string;
|
|
743
|
+
/** Physical path. */
|
|
744
|
+
physicalPath?: string;
|
|
745
|
+
/** <code>true</code> if preloading is enabled; otherwise, <code>false</code>. */
|
|
746
|
+
preloadEnabled?: boolean;
|
|
747
|
+
/** Virtual directories for virtual application. */
|
|
748
|
+
virtualDirectories?: Array<VirtualDirectory>;
|
|
749
|
+
}
|
|
750
|
+
/** Directory for virtual application. */
|
|
751
|
+
export interface VirtualDirectory {
|
|
752
|
+
/** Path to virtual application. */
|
|
753
|
+
virtualPath?: string;
|
|
754
|
+
/** Physical path. */
|
|
755
|
+
physicalPath?: string;
|
|
756
|
+
}
|
|
757
|
+
/** Routing rules in production experiments. */
|
|
758
|
+
export interface Experiments {
|
|
759
|
+
/** List of ramp-up rules. */
|
|
760
|
+
rampUpRules?: Array<RampUpRule>;
|
|
761
|
+
}
|
|
762
|
+
/** Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. */
|
|
763
|
+
export interface RampUpRule {
|
|
764
|
+
/** Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. */
|
|
765
|
+
actionHostName?: string;
|
|
766
|
+
/** Percentage of the traffic which will be redirected to <code>ActionHostName</code>. */
|
|
767
|
+
reroutePercentage?: number;
|
|
768
|
+
/**
|
|
769
|
+
* In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or
|
|
770
|
+
* <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm
|
|
771
|
+
* can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.
|
|
772
|
+
*/
|
|
773
|
+
changeStep?: number;
|
|
774
|
+
/** Specifies interval in minutes to reevaluate ReroutePercentage. */
|
|
775
|
+
changeIntervalInMinutes?: number;
|
|
776
|
+
/** Specifies lower boundary above which ReroutePercentage will stay. */
|
|
777
|
+
minReroutePercentage?: number;
|
|
778
|
+
/** Specifies upper boundary below which ReroutePercentage will stay. */
|
|
779
|
+
maxReroutePercentage?: number;
|
|
780
|
+
/**
|
|
781
|
+
* Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.
|
|
782
|
+
* https://www.siteextensions.net/packages/TiPCallback/
|
|
783
|
+
*/
|
|
784
|
+
changeDecisionCallbackUrl?: string;
|
|
785
|
+
/** Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. */
|
|
786
|
+
name?: string;
|
|
787
|
+
}
|
|
788
|
+
/** Metric limits set on an app. */
|
|
789
|
+
export interface SiteLimits {
|
|
790
|
+
/** Maximum allowed CPU usage percentage. */
|
|
791
|
+
maxPercentageCpu?: number;
|
|
792
|
+
/** Maximum allowed memory usage in MB. */
|
|
793
|
+
maxMemoryInMb?: number;
|
|
794
|
+
/** Maximum allowed disk size usage in MB. */
|
|
795
|
+
maxDiskSizeInMb?: number;
|
|
796
|
+
}
|
|
797
|
+
/** Rules that can be defined for auto-heal. */
|
|
798
|
+
export interface AutoHealRules {
|
|
799
|
+
/** Conditions that describe when to execute the auto-heal actions. */
|
|
800
|
+
triggers?: AutoHealTriggers;
|
|
801
|
+
/** Actions to be executed when a rule is triggered. */
|
|
802
|
+
actions?: AutoHealActions;
|
|
803
|
+
}
|
|
804
|
+
/** Triggers for auto-heal. */
|
|
805
|
+
export interface AutoHealTriggers {
|
|
806
|
+
/** A rule based on total requests. */
|
|
807
|
+
requests?: RequestsBasedTrigger;
|
|
808
|
+
/** A rule based on private bytes. */
|
|
809
|
+
privateBytesInKB?: number;
|
|
810
|
+
/** A rule based on status codes. */
|
|
811
|
+
statusCodes?: Array<StatusCodesBasedTrigger>;
|
|
812
|
+
/** A rule based on request execution time. */
|
|
813
|
+
slowRequests?: SlowRequestsBasedTrigger;
|
|
814
|
+
/** A rule based on multiple Slow Requests Rule with path */
|
|
815
|
+
slowRequestsWithPath?: Array<SlowRequestsBasedTrigger>;
|
|
816
|
+
/** A rule based on status codes ranges. */
|
|
817
|
+
statusCodesRange?: Array<StatusCodesRangeBasedTrigger>;
|
|
818
|
+
}
|
|
819
|
+
/** Trigger based on total requests. */
|
|
820
|
+
export interface RequestsBasedTrigger {
|
|
821
|
+
/** Request Count. */
|
|
822
|
+
count?: number;
|
|
823
|
+
/** Time interval. */
|
|
824
|
+
timeInterval?: string;
|
|
825
|
+
}
|
|
826
|
+
/** Trigger based on status code. */
|
|
827
|
+
export interface StatusCodesBasedTrigger {
|
|
828
|
+
/** HTTP status code. */
|
|
829
|
+
status?: number;
|
|
830
|
+
/** Request Sub Status. */
|
|
831
|
+
subStatus?: number;
|
|
832
|
+
/** Win32 error code. */
|
|
833
|
+
win32Status?: number;
|
|
834
|
+
/** Request Count. */
|
|
835
|
+
count?: number;
|
|
836
|
+
/** Time interval. */
|
|
837
|
+
timeInterval?: string;
|
|
838
|
+
/** Request Path */
|
|
839
|
+
path?: string;
|
|
840
|
+
}
|
|
841
|
+
/** Trigger based on request execution time. */
|
|
842
|
+
export interface SlowRequestsBasedTrigger {
|
|
843
|
+
/** Time taken. */
|
|
844
|
+
timeTaken?: string;
|
|
845
|
+
/** Request Path. */
|
|
846
|
+
path?: string;
|
|
847
|
+
/** Request Count. */
|
|
848
|
+
count?: number;
|
|
849
|
+
/** Time interval. */
|
|
850
|
+
timeInterval?: string;
|
|
851
|
+
}
|
|
852
|
+
/** Trigger based on range of status codes. */
|
|
853
|
+
export interface StatusCodesRangeBasedTrigger {
|
|
854
|
+
/** HTTP status code. */
|
|
855
|
+
statusCodes?: string;
|
|
856
|
+
path?: string;
|
|
857
|
+
/** Request Count. */
|
|
858
|
+
count?: number;
|
|
859
|
+
/** Time interval. */
|
|
860
|
+
timeInterval?: string;
|
|
861
|
+
}
|
|
862
|
+
/** Actions which to take by the auto-heal module when a rule is triggered. */
|
|
863
|
+
export interface AutoHealActions {
|
|
864
|
+
/** Predefined action to be taken. */
|
|
865
|
+
actionType?: "Recycle" | "LogEvent" | "CustomAction";
|
|
866
|
+
/** Custom action to be taken. */
|
|
867
|
+
customAction?: AutoHealCustomAction;
|
|
868
|
+
/**
|
|
869
|
+
* Minimum time the process must execute
|
|
870
|
+
* before taking the action
|
|
871
|
+
*/
|
|
872
|
+
minProcessExecutionTime?: string;
|
|
873
|
+
}
|
|
874
|
+
/**
|
|
875
|
+
* Custom action to be executed
|
|
876
|
+
* when an auto heal rule is triggered.
|
|
877
|
+
*/
|
|
878
|
+
export interface AutoHealCustomAction {
|
|
879
|
+
/** Executable to be run. */
|
|
880
|
+
exe?: string;
|
|
881
|
+
/** Parameters for the executable. */
|
|
882
|
+
parameters?: string;
|
|
883
|
+
}
|
|
884
|
+
/** Cross-Origin Resource Sharing (CORS) settings for the app. */
|
|
885
|
+
export interface CorsSettings {
|
|
886
|
+
/**
|
|
887
|
+
* Gets or sets the list of origins that should be allowed to make cross-origin
|
|
888
|
+
* calls (for example: http://example.com:12345). Use "*" to allow all.
|
|
889
|
+
*/
|
|
890
|
+
allowedOrigins?: Array<string>;
|
|
891
|
+
/**
|
|
892
|
+
* Gets or sets whether CORS requests with credentials are allowed. See
|
|
893
|
+
* https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials
|
|
894
|
+
* for more details.
|
|
895
|
+
*/
|
|
896
|
+
supportCredentials?: boolean;
|
|
897
|
+
}
|
|
898
|
+
/** Push settings for the App. */
|
|
899
|
+
export interface PushSettings extends ProxyOnlyResource {
|
|
900
|
+
/** PushSettings resource specific properties */
|
|
901
|
+
properties?: PushSettingsProperties;
|
|
902
|
+
}
|
|
903
|
+
/** PushSettings resource specific properties */
|
|
904
|
+
export interface PushSettingsProperties {
|
|
905
|
+
/** Gets or sets a flag indicating whether the Push endpoint is enabled. */
|
|
906
|
+
isPushEnabled: boolean;
|
|
907
|
+
/** Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. */
|
|
908
|
+
tagWhitelistJson?: string;
|
|
909
|
+
/**
|
|
910
|
+
* Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.
|
|
911
|
+
* Tags can consist of alphanumeric characters and the following:
|
|
912
|
+
* '_', '@', '#', '.', ':', '-'.
|
|
913
|
+
* Validation should be performed at the PushRequestHandler.
|
|
914
|
+
*/
|
|
915
|
+
tagsRequiringAuth?: string;
|
|
916
|
+
/** Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. */
|
|
917
|
+
dynamicTagsJson?: string;
|
|
918
|
+
}
|
|
919
|
+
/** Information about the formal API definition for the app. */
|
|
920
|
+
export interface ApiDefinitionInfo {
|
|
921
|
+
/** The URL of the API definition. */
|
|
922
|
+
url?: string;
|
|
923
|
+
}
|
|
924
|
+
/** Azure API management (APIM) configuration linked to the app. */
|
|
925
|
+
export interface ApiManagementConfig {
|
|
926
|
+
/** APIM-Api Identifier. */
|
|
927
|
+
id?: string;
|
|
928
|
+
}
|
|
929
|
+
/** IP security restriction on an app. */
|
|
930
|
+
export interface IpSecurityRestriction {
|
|
931
|
+
/**
|
|
932
|
+
* IP address the security restriction is valid for.
|
|
933
|
+
* It can be in form of pure ipv4 address (required SubnetMask property) or
|
|
934
|
+
* CIDR notation such as ipv4/mask (leading bit match). For CIDR,
|
|
935
|
+
* SubnetMask property must not be specified.
|
|
936
|
+
*/
|
|
937
|
+
ipAddress?: string;
|
|
938
|
+
/** Subnet mask for the range of IP addresses the restriction is valid for. */
|
|
939
|
+
subnetMask?: string;
|
|
940
|
+
/** Virtual network resource id */
|
|
941
|
+
vnetSubnetResourceId?: string;
|
|
942
|
+
/** (internal) Vnet traffic tag */
|
|
943
|
+
vnetTrafficTag?: number;
|
|
944
|
+
/** (internal) Subnet traffic tag */
|
|
945
|
+
subnetTrafficTag?: number;
|
|
946
|
+
/** Allow or Deny access for this IP range. */
|
|
947
|
+
action?: string;
|
|
948
|
+
/** Defines what this IP filter will be used for. This is to support IP filtering on proxies. */
|
|
949
|
+
tag?: "Default" | "XffProxy" | "ServiceTag";
|
|
950
|
+
/** Priority of IP restriction rule. */
|
|
951
|
+
priority?: number;
|
|
952
|
+
/** IP restriction rule name. */
|
|
953
|
+
name?: string;
|
|
954
|
+
/** IP restriction rule description. */
|
|
955
|
+
description?: string;
|
|
956
|
+
/**
|
|
957
|
+
* IP restriction rule headers.
|
|
958
|
+
* X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples).
|
|
959
|
+
* The matching logic is ..
|
|
960
|
+
* - If the property is null or empty (default), all hosts(or lack of) are allowed.
|
|
961
|
+
* - A value is compared using ordinal-ignore-case (excluding port number).
|
|
962
|
+
* - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com
|
|
963
|
+
* but not the root domain contoso.com or multi-level foo.bar.contoso.com
|
|
964
|
+
* - Unicode host names are allowed but are converted to Punycode for matching.
|
|
965
|
+
*
|
|
966
|
+
* X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).
|
|
967
|
+
* The matching logic is ..
|
|
968
|
+
* - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.
|
|
969
|
+
* - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.
|
|
970
|
+
*
|
|
971
|
+
* X-Azure-FDID and X-FD-HealthProbe.
|
|
972
|
+
* The matching logic is exact match.
|
|
973
|
+
*/
|
|
974
|
+
headers?: Record<string, Array<string>>;
|
|
975
|
+
}
|
|
976
|
+
/** Azure Files or Blob Storage access information value for dictionary storage. */
|
|
977
|
+
export interface AzureStorageInfoValue {
|
|
978
|
+
/** Type of storage. */
|
|
979
|
+
type?: "AzureFiles" | "AzureBlob";
|
|
980
|
+
/** Name of the storage account. */
|
|
981
|
+
accountName?: string;
|
|
982
|
+
/** Name of the file share (container name, for Blob storage). */
|
|
983
|
+
shareName?: string;
|
|
984
|
+
/** Access key for the storage account. */
|
|
985
|
+
accessKey?: string;
|
|
986
|
+
/** Path to mount the storage within the site's runtime environment. */
|
|
987
|
+
mountPath?: string;
|
|
988
|
+
}
|
|
989
|
+
/** Specification for an App Service Environment to use for this resource. */
|
|
990
|
+
export interface HostingEnvironmentProfile {
|
|
991
|
+
/** Resource ID of the App Service Environment. */
|
|
992
|
+
id?: string;
|
|
993
|
+
}
|
|
994
|
+
/** Information needed for cloning operation. */
|
|
995
|
+
export interface CloningInfo {
|
|
996
|
+
/**
|
|
997
|
+
* Correlation ID of cloning operation. This ID ties multiple cloning operations
|
|
998
|
+
* together to use the same snapshot.
|
|
999
|
+
*
|
|
1000
|
+
* Value may contain a UUID
|
|
1001
|
+
*/
|
|
1002
|
+
correlationId?: string;
|
|
1003
|
+
/** <code>true</code> to overwrite destination app; otherwise, <code>false</code>. */
|
|
1004
|
+
overwrite?: boolean;
|
|
1005
|
+
/** <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. */
|
|
1006
|
+
cloneCustomHostNames?: boolean;
|
|
1007
|
+
/** <code>true</code> to clone source control from source app; otherwise, <code>false</code>. */
|
|
1008
|
+
cloneSourceControl?: boolean;
|
|
1009
|
+
/**
|
|
1010
|
+
* ARM resource ID of the source app. App resource ID is of the form
|
|
1011
|
+
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and
|
|
1012
|
+
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.
|
|
1013
|
+
*/
|
|
1014
|
+
sourceWebAppId: string;
|
|
1015
|
+
/** Location of source app ex: West US or North Europe */
|
|
1016
|
+
sourceWebAppLocation?: string;
|
|
1017
|
+
/** App Service Environment. */
|
|
1018
|
+
hostingEnvironment?: string;
|
|
1019
|
+
/**
|
|
1020
|
+
* Application setting overrides for cloned app. If specified, these settings override the settings cloned
|
|
1021
|
+
* from source app. Otherwise, application settings from source app are retained.
|
|
1022
|
+
*/
|
|
1023
|
+
appSettingsOverrides?: Record<string, string>;
|
|
1024
|
+
/** <code>true</code> to configure load balancing for source and destination app. */
|
|
1025
|
+
configureLoadBalancing?: boolean;
|
|
1026
|
+
/**
|
|
1027
|
+
* ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form
|
|
1028
|
+
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
|
|
1029
|
+
*/
|
|
1030
|
+
trafficManagerProfileId?: string;
|
|
1031
|
+
/** Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. */
|
|
1032
|
+
trafficManagerProfileName?: string;
|
|
1033
|
+
}
|
|
1034
|
+
/** The status of the last successful slot swap operation. */
|
|
1035
|
+
export interface SlotSwapStatus {
|
|
1036
|
+
}
|
|
1037
|
+
/** Managed service identity. */
|
|
1038
|
+
export interface ManagedServiceIdentity {
|
|
1039
|
+
/** Type of managed service identity. */
|
|
1040
|
+
type?: "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None";
|
|
1041
|
+
/** The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} */
|
|
1042
|
+
userAssignedIdentities?: Record<string, UserAssignedIdentity>;
|
|
1043
|
+
}
|
|
1044
|
+
/** User Assigned identity. */
|
|
1045
|
+
export interface UserAssignedIdentity {
|
|
1046
|
+
}
|
|
1047
|
+
/** Extended Location. */
|
|
1048
|
+
export interface ExtendedLocation {
|
|
1049
|
+
/** Name of extended location. */
|
|
1050
|
+
name?: string;
|
|
1051
|
+
}
|
|
1052
|
+
/** Full view of networking configuration for an ASE. */
|
|
1053
|
+
export interface AseV3NetworkingConfiguration extends ProxyOnlyResource {
|
|
1054
|
+
/** AseV3NetworkingConfiguration resource specific properties */
|
|
1055
|
+
properties?: AseV3NetworkingConfigurationProperties;
|
|
1056
|
+
}
|
|
1057
|
+
/** AseV3NetworkingConfiguration resource specific properties */
|
|
1058
|
+
export interface AseV3NetworkingConfigurationProperties {
|
|
1059
|
+
/** Property to enable and disable new private endpoint connection creation on ASE */
|
|
1060
|
+
allowNewPrivateEndpointConnections?: boolean;
|
|
1061
|
+
}
|
|
1062
|
+
/** Worker pool of an App Service Environment ARM resource. */
|
|
1063
|
+
export interface WorkerPoolResource extends ProxyOnlyResource {
|
|
1064
|
+
/** Core resource properties */
|
|
1065
|
+
properties?: WorkerPool;
|
|
1066
|
+
/** Description of a SKU for a scalable resource. */
|
|
1067
|
+
sku?: SkuDescription;
|
|
1068
|
+
}
|
|
1069
|
+
/** Worker pool of an App Service Environment. */
|
|
1070
|
+
export interface WorkerPool {
|
|
1071
|
+
/** Worker size ID for referencing this worker pool. */
|
|
1072
|
+
workerSizeId?: number;
|
|
1073
|
+
/** Shared or dedicated app hosting. */
|
|
1074
|
+
computeMode?: "Shared" | "Dedicated" | "Dynamic";
|
|
1075
|
+
/** VM size of the worker pool instances. */
|
|
1076
|
+
workerSize?: string;
|
|
1077
|
+
/** Number of instances in the worker pool. */
|
|
1078
|
+
workerCount?: number;
|
|
1079
|
+
}
|
|
1080
|
+
/** Description of a SKU for a scalable resource. */
|
|
1081
|
+
export interface SkuDescription {
|
|
1082
|
+
/** Name of the resource SKU. */
|
|
1083
|
+
name?: string;
|
|
1084
|
+
/** Service tier of the resource SKU. */
|
|
1085
|
+
tier?: string;
|
|
1086
|
+
/** Size specifier of the resource SKU. */
|
|
1087
|
+
size?: string;
|
|
1088
|
+
/** Family code of the resource SKU. */
|
|
1089
|
+
family?: string;
|
|
1090
|
+
/** Current number of instances assigned to the resource. */
|
|
1091
|
+
capacity?: number;
|
|
1092
|
+
/** Min, max, and default scale values of the SKU. */
|
|
1093
|
+
skuCapacity?: SkuCapacity;
|
|
1094
|
+
/** Locations of the SKU. */
|
|
1095
|
+
locations?: Array<string>;
|
|
1096
|
+
/** Capabilities of the SKU, e.g., is traffic manager enabled? */
|
|
1097
|
+
capabilities?: Array<Capability>;
|
|
1098
|
+
}
|
|
1099
|
+
/** Description of the App Service plan scale options. */
|
|
1100
|
+
export interface SkuCapacity {
|
|
1101
|
+
/** Minimum number of workers for this App Service plan SKU. */
|
|
1102
|
+
minimum?: number;
|
|
1103
|
+
/** Maximum number of workers for this App Service plan SKU. */
|
|
1104
|
+
maximum?: number;
|
|
1105
|
+
/** Maximum number of Elastic workers for this App Service plan SKU. */
|
|
1106
|
+
elasticMaximum?: number;
|
|
1107
|
+
/** Default number of workers for this App Service plan SKU. */
|
|
1108
|
+
default?: number;
|
|
1109
|
+
/** Available scale configurations for an App Service plan. */
|
|
1110
|
+
scaleType?: string;
|
|
1111
|
+
}
|
|
1112
|
+
/** Describes the capabilities/features allowed for a specific SKU. */
|
|
1113
|
+
export interface Capability {
|
|
1114
|
+
/** Name of the SKU capability. */
|
|
1115
|
+
name?: string;
|
|
1116
|
+
/** Value of the SKU capability. */
|
|
1117
|
+
value?: string;
|
|
1118
|
+
/** Reason of the SKU capability. */
|
|
1119
|
+
reason?: string;
|
|
1120
|
+
}
|
|
1121
|
+
/** Metadata for the metrics. */
|
|
1122
|
+
export interface ResourceMetricDefinition extends ProxyOnlyResource {
|
|
1123
|
+
/** ResourceMetricDefinition resource specific properties */
|
|
1124
|
+
properties?: ResourceMetricDefinitionProperties;
|
|
1125
|
+
}
|
|
1126
|
+
/** ResourceMetricDefinition resource specific properties */
|
|
1127
|
+
export interface ResourceMetricDefinitionProperties {
|
|
1128
|
+
}
|
|
1129
|
+
/** Metrics availability and retention. */
|
|
1130
|
+
export interface ResourceMetricAvailability {
|
|
1131
|
+
}
|
|
1132
|
+
/** Usage of the quota resource. */
|
|
1133
|
+
export interface Usage extends ProxyOnlyResource {
|
|
1134
|
+
/** Usage resource specific properties */
|
|
1135
|
+
properties?: UsageProperties;
|
|
1136
|
+
}
|
|
1137
|
+
/** Usage resource specific properties */
|
|
1138
|
+
export interface UsageProperties {
|
|
1139
|
+
}
|
|
1140
|
+
/** Body of the error response returned from the API. */
|
|
1141
|
+
export interface ErrorEntity {
|
|
1142
|
+
/** Type of error. */
|
|
1143
|
+
extendedCode?: string;
|
|
1144
|
+
/** Message template. */
|
|
1145
|
+
messageTemplate?: string;
|
|
1146
|
+
/** Parameters for the template. */
|
|
1147
|
+
parameters?: Array<string>;
|
|
1148
|
+
/** Inner errors. */
|
|
1149
|
+
innerErrors?: Array<ErrorEntity>;
|
|
1150
|
+
/** Error Details. */
|
|
1151
|
+
details?: Array<ErrorEntity>;
|
|
1152
|
+
/** The error target. */
|
|
1153
|
+
target?: string;
|
|
1154
|
+
/** Basic error code. */
|
|
1155
|
+
code?: string;
|
|
1156
|
+
/** Any details of the error. */
|
|
1157
|
+
message?: string;
|
|
1158
|
+
}
|
|
1159
|
+
/** Remote Private Endpoint Connection ARM resource. */
|
|
1160
|
+
export interface RemotePrivateEndpointConnectionARMResource extends ProxyOnlyResource {
|
|
1161
|
+
/** RemotePrivateEndpointConnectionARMResource resource specific properties */
|
|
1162
|
+
properties?: RemotePrivateEndpointConnectionARMResourceProperties;
|
|
1163
|
+
}
|
|
1164
|
+
/** RemotePrivateEndpointConnectionARMResource resource specific properties */
|
|
1165
|
+
export interface RemotePrivateEndpointConnectionARMResourceProperties {
|
|
1166
|
+
/** PrivateEndpoint of a remote private endpoint connection */
|
|
1167
|
+
privateEndpoint?: ArmIdWrapper;
|
|
1168
|
+
/** The state of a private link connection */
|
|
1169
|
+
privateLinkServiceConnectionState?: PrivateLinkConnectionState;
|
|
1170
|
+
/** Private IPAddresses mapped to the remote private endpoint */
|
|
1171
|
+
ipAddresses?: Array<string>;
|
|
1172
|
+
}
|
|
1173
|
+
/** A wrapper for an ARM resource id */
|
|
1174
|
+
export interface ArmIdWrapper {
|
|
1175
|
+
}
|
|
1176
|
+
/** The state of a private link connection */
|
|
1177
|
+
export interface PrivateLinkConnectionState {
|
|
1178
|
+
/** Status of a private link connection */
|
|
1179
|
+
status?: string;
|
|
1180
|
+
/** Description of a private link connection */
|
|
1181
|
+
description?: string;
|
|
1182
|
+
/** ActionsRequired for a private link connection */
|
|
1183
|
+
actionsRequired?: string;
|
|
1184
|
+
}
|
|
1185
|
+
/** Private Endpoint Connection Approval ARM resource. */
|
|
1186
|
+
export interface PrivateLinkConnectionApprovalRequestResource extends ProxyOnlyResource {
|
|
1187
|
+
/** Core resource properties */
|
|
1188
|
+
properties?: PrivateLinkConnectionApprovalRequest;
|
|
1189
|
+
}
|
|
1190
|
+
/** A request to approve or reject a private endpoint connection */
|
|
1191
|
+
export interface PrivateLinkConnectionApprovalRequest {
|
|
1192
|
+
/** The state of a private link connection */
|
|
1193
|
+
privateLinkServiceConnectionState?: PrivateLinkConnectionState;
|
|
1194
|
+
}
|
|
1195
|
+
/** App Service plan. */
|
|
1196
|
+
export interface AppServicePlan extends Resource {
|
|
1197
|
+
/** AppServicePlan resource specific properties */
|
|
1198
|
+
properties?: AppServicePlanProperties;
|
|
1199
|
+
/** Description of a SKU for a scalable resource. */
|
|
1200
|
+
sku?: SkuDescription;
|
|
1201
|
+
/** Extended Location. */
|
|
1202
|
+
extendedLocation?: ExtendedLocation;
|
|
1203
|
+
}
|
|
1204
|
+
/** AppServicePlan resource specific properties */
|
|
1205
|
+
export interface AppServicePlanProperties {
|
|
1206
|
+
/** Target worker tier assigned to the App Service plan. */
|
|
1207
|
+
workerTierName?: string;
|
|
1208
|
+
/** Specification for the App Service Environment to use for the App Service plan. */
|
|
1209
|
+
hostingEnvironmentProfile?: HostingEnvironmentProfile;
|
|
1210
|
+
/**
|
|
1211
|
+
* If <code>true</code>, apps assigned to this App Service plan can be scaled independently.
|
|
1212
|
+
* If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.
|
|
1213
|
+
*/
|
|
1214
|
+
perSiteScaling?: boolean;
|
|
1215
|
+
/** ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku */
|
|
1216
|
+
elasticScaleEnabled?: boolean;
|
|
1217
|
+
/** Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan */
|
|
1218
|
+
maximumElasticWorkerCount?: number;
|
|
1219
|
+
/** If <code>true</code>, this App Service Plan owns spot instances. */
|
|
1220
|
+
isSpot?: boolean;
|
|
1221
|
+
/** The time when the server farm expires. Valid only if it is a spot server farm. */
|
|
1222
|
+
spotExpirationTime?: Date | string;
|
|
1223
|
+
/** The time when the server farm free offer expires. */
|
|
1224
|
+
freeOfferExpirationTime?: Date | string;
|
|
1225
|
+
/** If Linux app service plan <code>true</code>, <code>false</code> otherwise. */
|
|
1226
|
+
reserved?: boolean;
|
|
1227
|
+
/** Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. */
|
|
1228
|
+
isXenon?: boolean;
|
|
1229
|
+
/** If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. */
|
|
1230
|
+
hyperV?: boolean;
|
|
1231
|
+
/** Scaling worker count. */
|
|
1232
|
+
targetWorkerCount?: number;
|
|
1233
|
+
/** Scaling worker size ID. */
|
|
1234
|
+
targetWorkerSizeId?: number;
|
|
1235
|
+
/** Specification for the Kubernetes Environment to use for the App Service plan. */
|
|
1236
|
+
kubeEnvironmentProfile?: KubeEnvironmentProfile;
|
|
1237
|
+
/**
|
|
1238
|
+
* If <code>true</code>, this App Service Plan will perform availability zone balancing.
|
|
1239
|
+
* If <code>false</code>, this App Service Plan will not perform availability zone balancing.
|
|
1240
|
+
*/
|
|
1241
|
+
zoneRedundant?: boolean;
|
|
1242
|
+
}
|
|
1243
|
+
/** Specification for a Kubernetes Environment to use for this resource. */
|
|
1244
|
+
export interface KubeEnvironmentProfile {
|
|
1245
|
+
/** Resource ID of the Kubernetes Environment. */
|
|
1246
|
+
id?: string;
|
|
1247
|
+
}
|
|
1248
|
+
/** ARM resource for a app service plan. */
|
|
1249
|
+
export interface AppServicePlanPatchResource extends ProxyOnlyResource {
|
|
1250
|
+
/** AppServicePlanPatchResource resource specific properties */
|
|
1251
|
+
properties?: AppServicePlanPatchResourceProperties;
|
|
1252
|
+
}
|
|
1253
|
+
/** AppServicePlanPatchResource resource specific properties */
|
|
1254
|
+
export interface AppServicePlanPatchResourceProperties {
|
|
1255
|
+
/** Target worker tier assigned to the App Service plan. */
|
|
1256
|
+
workerTierName?: string;
|
|
1257
|
+
/** Specification for the App Service Environment to use for the App Service plan. */
|
|
1258
|
+
hostingEnvironmentProfile?: HostingEnvironmentProfile;
|
|
1259
|
+
/**
|
|
1260
|
+
* If <code>true</code>, apps assigned to this App Service plan can be scaled independently.
|
|
1261
|
+
* If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.
|
|
1262
|
+
*/
|
|
1263
|
+
perSiteScaling?: boolean;
|
|
1264
|
+
/** ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku */
|
|
1265
|
+
elasticScaleEnabled?: boolean;
|
|
1266
|
+
/** Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan */
|
|
1267
|
+
maximumElasticWorkerCount?: number;
|
|
1268
|
+
/** If <code>true</code>, this App Service Plan owns spot instances. */
|
|
1269
|
+
isSpot?: boolean;
|
|
1270
|
+
/** The time when the server farm expires. Valid only if it is a spot server farm. */
|
|
1271
|
+
spotExpirationTime?: Date | string;
|
|
1272
|
+
/** The time when the server farm free offer expires. */
|
|
1273
|
+
freeOfferExpirationTime?: Date | string;
|
|
1274
|
+
/** If Linux app service plan <code>true</code>, <code>false</code> otherwise. */
|
|
1275
|
+
reserved?: boolean;
|
|
1276
|
+
/** Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. */
|
|
1277
|
+
isXenon?: boolean;
|
|
1278
|
+
/** If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. */
|
|
1279
|
+
hyperV?: boolean;
|
|
1280
|
+
/** Scaling worker count. */
|
|
1281
|
+
targetWorkerCount?: number;
|
|
1282
|
+
/** Scaling worker size ID. */
|
|
1283
|
+
targetWorkerSizeId?: number;
|
|
1284
|
+
/** Specification for the Kubernetes Environment to use for the App Service plan. */
|
|
1285
|
+
kubeEnvironmentProfile?: KubeEnvironmentProfile;
|
|
1286
|
+
/**
|
|
1287
|
+
* If <code>true</code>, this App Service Plan will perform availability zone balancing.
|
|
1288
|
+
* If <code>false</code>, this App Service Plan will not perform availability zone balancing.
|
|
1289
|
+
*/
|
|
1290
|
+
zoneRedundant?: boolean;
|
|
1291
|
+
}
|
|
1292
|
+
/** Hybrid Connection contract. This is used to configure a Hybrid Connection. */
|
|
1293
|
+
export interface HybridConnection extends ProxyOnlyResource {
|
|
1294
|
+
/** HybridConnection resource specific properties */
|
|
1295
|
+
properties?: HybridConnectionProperties;
|
|
1296
|
+
}
|
|
1297
|
+
/** HybridConnection resource specific properties */
|
|
1298
|
+
export interface HybridConnectionProperties {
|
|
1299
|
+
/** The name of the Service Bus namespace. */
|
|
1300
|
+
serviceBusNamespace?: string;
|
|
1301
|
+
/** The name of the Service Bus relay. */
|
|
1302
|
+
relayName?: string;
|
|
1303
|
+
/** The ARM URI to the Service Bus relay. */
|
|
1304
|
+
relayArmUri?: string;
|
|
1305
|
+
/** The hostname of the endpoint. */
|
|
1306
|
+
hostname?: string;
|
|
1307
|
+
/** The port of the endpoint. */
|
|
1308
|
+
port?: number;
|
|
1309
|
+
/** The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. */
|
|
1310
|
+
sendKeyName?: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned
|
|
1313
|
+
* normally, use the POST /listKeys API instead.
|
|
1314
|
+
*/
|
|
1315
|
+
sendKeyValue?: string;
|
|
1316
|
+
/** The suffix for the service bus endpoint. By default this is .servicebus.windows.net */
|
|
1317
|
+
serviceBusSuffix?: string;
|
|
1318
|
+
}
|
|
1319
|
+
/** Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection. */
|
|
1320
|
+
export interface HybridConnectionKey extends ProxyOnlyResource {
|
|
1321
|
+
/** HybridConnectionKey resource specific properties */
|
|
1322
|
+
properties?: HybridConnectionKeyProperties;
|
|
1323
|
+
}
|
|
1324
|
+
/** HybridConnectionKey resource specific properties */
|
|
1325
|
+
export interface HybridConnectionKeyProperties {
|
|
1326
|
+
}
|
|
1327
|
+
/** Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections. */
|
|
1328
|
+
export interface HybridConnectionLimits extends ProxyOnlyResource {
|
|
1329
|
+
/** HybridConnectionLimits resource specific properties */
|
|
1330
|
+
properties?: HybridConnectionLimitsProperties;
|
|
1331
|
+
}
|
|
1332
|
+
/** HybridConnectionLimits resource specific properties */
|
|
1333
|
+
export interface HybridConnectionLimitsProperties {
|
|
1334
|
+
}
|
|
1335
|
+
/** Virtual Network information ARM resource. */
|
|
1336
|
+
export interface VnetInfoResource extends ProxyOnlyResource {
|
|
1337
|
+
/** Core resource properties */
|
|
1338
|
+
properties?: VnetInfo;
|
|
1339
|
+
}
|
|
1340
|
+
/** Virtual Network information contract. */
|
|
1341
|
+
export interface VnetInfo {
|
|
1342
|
+
/** The Virtual Network's resource ID. */
|
|
1343
|
+
vnetResourceId?: string;
|
|
1344
|
+
/**
|
|
1345
|
+
* A certificate file (.cer) blob containing the public key of the private key used to authenticate a
|
|
1346
|
+
* Point-To-Site VPN connection.
|
|
1347
|
+
*/
|
|
1348
|
+
certBlob?: string;
|
|
1349
|
+
/** DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. */
|
|
1350
|
+
dnsServers?: string;
|
|
1351
|
+
/** Flag that is used to denote if this is VNET injection */
|
|
1352
|
+
isSwift?: boolean;
|
|
1353
|
+
}
|
|
1354
|
+
/** Virtual Network route contract used to pass routing information for a Virtual Network. */
|
|
1355
|
+
export interface VnetRoute extends ProxyOnlyResource {
|
|
1356
|
+
/** VnetRoute resource specific properties */
|
|
1357
|
+
properties?: VnetRouteProperties;
|
|
1358
|
+
}
|
|
1359
|
+
/** VnetRoute resource specific properties */
|
|
1360
|
+
export interface VnetRouteProperties {
|
|
1361
|
+
/** The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. */
|
|
1362
|
+
startAddress?: string;
|
|
1363
|
+
/** The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. */
|
|
1364
|
+
endAddress?: string;
|
|
1365
|
+
/**
|
|
1366
|
+
* The type of route this is:
|
|
1367
|
+
* DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918
|
|
1368
|
+
* INHERITED - Routes inherited from the real Virtual Network routes
|
|
1369
|
+
* STATIC - Static route set on the app only
|
|
1370
|
+
*
|
|
1371
|
+
* These values will be used for syncing an app's routes with those from a Virtual Network.
|
|
1372
|
+
*/
|
|
1373
|
+
routeType?: "DEFAULT" | "INHERITED" | "STATIC";
|
|
1374
|
+
}
|
|
1375
|
+
/** The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package. */
|
|
1376
|
+
export interface VnetGateway extends ProxyOnlyResource {
|
|
1377
|
+
/** VnetGateway resource specific properties */
|
|
1378
|
+
properties?: VnetGatewayProperties;
|
|
1379
|
+
}
|
|
1380
|
+
/** VnetGateway resource specific properties */
|
|
1381
|
+
export interface VnetGatewayProperties {
|
|
1382
|
+
/** The Virtual Network name. */
|
|
1383
|
+
vnetName?: string;
|
|
1384
|
+
/** The URI where the VPN package can be downloaded. */
|
|
1385
|
+
vpnPackageUri: string;
|
|
1386
|
+
}
|
|
1387
|
+
/** SSL certificate for an app. */
|
|
1388
|
+
export interface Certificate extends Resource {
|
|
1389
|
+
/** Certificate resource specific properties */
|
|
1390
|
+
properties?: CertificateProperties;
|
|
1391
|
+
}
|
|
1392
|
+
/** Certificate resource specific properties */
|
|
1393
|
+
export interface CertificateProperties {
|
|
1394
|
+
/** Certificate password. */
|
|
1395
|
+
password?: string;
|
|
1396
|
+
/** Host names the certificate applies to. */
|
|
1397
|
+
hostNames?: Array<string>;
|
|
1398
|
+
/**
|
|
1399
|
+
* Pfx blob.
|
|
1400
|
+
*
|
|
1401
|
+
* Value may contain base64 encoded characters
|
|
1402
|
+
*/
|
|
1403
|
+
pfxBlob?: string;
|
|
1404
|
+
/** Key Vault Csm resource Id. */
|
|
1405
|
+
keyVaultId?: string;
|
|
1406
|
+
/** Key Vault secret name. */
|
|
1407
|
+
keyVaultSecretName?: string;
|
|
1408
|
+
/** Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". */
|
|
1409
|
+
serverFarmId?: string;
|
|
1410
|
+
/** CNAME of the certificate to be issued via free certificate */
|
|
1411
|
+
canonicalName?: string;
|
|
1412
|
+
/** Method of domain validation for free cert */
|
|
1413
|
+
domainValidationMethod?: string;
|
|
1414
|
+
}
|
|
1415
|
+
/** ARM resource for a certificate. */
|
|
1416
|
+
export interface CertificatePatchResource extends ProxyOnlyResource {
|
|
1417
|
+
/** CertificatePatchResource resource specific properties */
|
|
1418
|
+
properties?: CertificatePatchResourceProperties;
|
|
1419
|
+
}
|
|
1420
|
+
/** CertificatePatchResource resource specific properties */
|
|
1421
|
+
export interface CertificatePatchResourceProperties {
|
|
1422
|
+
/** Certificate password. */
|
|
1423
|
+
password?: string;
|
|
1424
|
+
/** Host names the certificate applies to. */
|
|
1425
|
+
hostNames?: Array<string>;
|
|
1426
|
+
/**
|
|
1427
|
+
* Pfx blob.
|
|
1428
|
+
*
|
|
1429
|
+
* Value may contain base64 encoded characters
|
|
1430
|
+
*/
|
|
1431
|
+
pfxBlob?: string;
|
|
1432
|
+
/** Key Vault Csm resource Id. */
|
|
1433
|
+
keyVaultId?: string;
|
|
1434
|
+
/** Key Vault secret name. */
|
|
1435
|
+
keyVaultSecretName?: string;
|
|
1436
|
+
/** Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". */
|
|
1437
|
+
serverFarmId?: string;
|
|
1438
|
+
/** CNAME of the certificate to be issued via free certificate */
|
|
1439
|
+
canonicalName?: string;
|
|
1440
|
+
/** Method of domain validation for free cert */
|
|
1441
|
+
domainValidationMethod?: string;
|
|
1442
|
+
}
|
|
1443
|
+
/** Container App. */
|
|
1444
|
+
export interface ContainerApp extends Resource {
|
|
1445
|
+
/** ContainerApp resource specific properties */
|
|
1446
|
+
properties?: ContainerAppProperties;
|
|
1447
|
+
}
|
|
1448
|
+
/** ContainerApp resource specific properties */
|
|
1449
|
+
export interface ContainerAppProperties {
|
|
1450
|
+
/** Resource ID of the Container App's KubeEnvironment. */
|
|
1451
|
+
kubeEnvironmentId?: string;
|
|
1452
|
+
/** Non versioned Container App configuration properties. */
|
|
1453
|
+
configuration?: Configuration;
|
|
1454
|
+
/** Container App versioned application definition. */
|
|
1455
|
+
template?: Template;
|
|
1456
|
+
}
|
|
1457
|
+
/** Non versioned Container App configuration properties that define the mutable settings of a Container app */
|
|
1458
|
+
export interface Configuration {
|
|
1459
|
+
/** Collection of secrets used by a Container app */
|
|
1460
|
+
secrets?: Array<Secret>;
|
|
1461
|
+
/**
|
|
1462
|
+
* ActiveRevisionsMode controls how active revisions are handled for the Container app:
|
|
1463
|
+
* <list><item>Multiple: multiple revisions can be active. If no value if provided, this is the default</item><item>Single: Only one revision can be active at a time. Revision weights can not be used in this mode</item></list>
|
|
1464
|
+
*/
|
|
1465
|
+
activeRevisionsMode?: "multiple" | "single";
|
|
1466
|
+
/** Ingress configurations. */
|
|
1467
|
+
ingress?: Ingress;
|
|
1468
|
+
/** Collection of private container registry credentials for containers used by the Container app */
|
|
1469
|
+
registries?: Array<RegistryCredentials>;
|
|
1470
|
+
}
|
|
1471
|
+
/** Container App Secret. */
|
|
1472
|
+
export interface Secret {
|
|
1473
|
+
/** Secret Name. */
|
|
1474
|
+
name?: string;
|
|
1475
|
+
/** Secret Value. */
|
|
1476
|
+
value?: string;
|
|
1477
|
+
}
|
|
1478
|
+
/** Container App Ingress configuration. */
|
|
1479
|
+
export interface Ingress {
|
|
1480
|
+
/** Bool indicating if app exposes an external http endpoint */
|
|
1481
|
+
external?: boolean;
|
|
1482
|
+
/** Target Port in containers for traffic from ingress */
|
|
1483
|
+
targetPort?: number;
|
|
1484
|
+
/** Ingress transport protocol */
|
|
1485
|
+
transport?: "auto" | "http" | "http2";
|
|
1486
|
+
traffic?: Array<TrafficWeight>;
|
|
1487
|
+
/** Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections */
|
|
1488
|
+
allowInsecure?: boolean;
|
|
1489
|
+
}
|
|
1490
|
+
/** Traffic weight assigned to a revision */
|
|
1491
|
+
export interface TrafficWeight {
|
|
1492
|
+
/** Name of a revision */
|
|
1493
|
+
revisionName?: string;
|
|
1494
|
+
/** Traffic weight assigned to a revision */
|
|
1495
|
+
weight?: number;
|
|
1496
|
+
/** Indicates that the traffic weight belongs to a latest stable revision */
|
|
1497
|
+
latestRevision?: boolean;
|
|
1498
|
+
}
|
|
1499
|
+
/** Container App Private Registry */
|
|
1500
|
+
export interface RegistryCredentials {
|
|
1501
|
+
/** Container Registry Server */
|
|
1502
|
+
server?: string;
|
|
1503
|
+
/** Container Registry Username */
|
|
1504
|
+
username?: string;
|
|
1505
|
+
/** The name of the Secret that contains the registry login password */
|
|
1506
|
+
passwordSecretRef?: string;
|
|
1507
|
+
}
|
|
1508
|
+
/**
|
|
1509
|
+
* Container App versioned application definition.
|
|
1510
|
+
* Defines the desired state of an immutable revision.
|
|
1511
|
+
* Any changes to this section Will result in a new revision being created
|
|
1512
|
+
*/
|
|
1513
|
+
export interface Template {
|
|
1514
|
+
/** User friendly suffix that is appended to the revision name */
|
|
1515
|
+
revisionSuffix?: string;
|
|
1516
|
+
/** List of container definitions for the Container App. */
|
|
1517
|
+
containers?: Array<Container>;
|
|
1518
|
+
/** Scaling properties for the Container App. */
|
|
1519
|
+
scale?: Scale;
|
|
1520
|
+
/** Dapr configuration for the Container App. */
|
|
1521
|
+
dapr?: Dapr;
|
|
1522
|
+
}
|
|
1523
|
+
/** Container App container definition. */
|
|
1524
|
+
export interface Container {
|
|
1525
|
+
/** Container image tag. */
|
|
1526
|
+
image?: string;
|
|
1527
|
+
/** Custom container name. */
|
|
1528
|
+
name?: string;
|
|
1529
|
+
/** Container start command. */
|
|
1530
|
+
command?: Array<string>;
|
|
1531
|
+
/** Container start command arguments. */
|
|
1532
|
+
args?: Array<string>;
|
|
1533
|
+
/** Container environment variables. */
|
|
1534
|
+
env?: Array<EnvironmentVar>;
|
|
1535
|
+
/** Container resource requirements. */
|
|
1536
|
+
resources?: ContainerResources;
|
|
1537
|
+
}
|
|
1538
|
+
/** Container App container environment variable. */
|
|
1539
|
+
export interface EnvironmentVar {
|
|
1540
|
+
/** Environment variable name. */
|
|
1541
|
+
name?: string;
|
|
1542
|
+
/** Non-secret environment variable value. */
|
|
1543
|
+
value?: string;
|
|
1544
|
+
/** Name of the Container App secret from which to pull the environment variable value. */
|
|
1545
|
+
secretRef?: string;
|
|
1546
|
+
}
|
|
1547
|
+
/** Container App container resource requirements. */
|
|
1548
|
+
export interface ContainerResources {
|
|
1549
|
+
/** Required CPU in cores, e.g. 0.5 */
|
|
1550
|
+
cpu?: number;
|
|
1551
|
+
/** Required memory, e.g. "250Mb" */
|
|
1552
|
+
memory?: string;
|
|
1553
|
+
}
|
|
1554
|
+
/** Container App scaling configurations. */
|
|
1555
|
+
export interface Scale {
|
|
1556
|
+
/** Optional. Minimum number of container replicas. */
|
|
1557
|
+
minReplicas?: number;
|
|
1558
|
+
/** Optional. Maximum number of container replicas. Defaults to 10 if not set. */
|
|
1559
|
+
maxReplicas?: number;
|
|
1560
|
+
/** Scaling rules. */
|
|
1561
|
+
rules?: Array<ScaleRule>;
|
|
1562
|
+
}
|
|
1563
|
+
/** Container App container scaling rule. */
|
|
1564
|
+
export interface ScaleRule {
|
|
1565
|
+
/** Scale Rule Name */
|
|
1566
|
+
name?: string;
|
|
1567
|
+
/** Azure Queue based scaling. */
|
|
1568
|
+
azureQueue?: QueueScaleRule;
|
|
1569
|
+
/** Custom scale rule. */
|
|
1570
|
+
custom?: CustomScaleRule;
|
|
1571
|
+
/** HTTP requests based scaling. */
|
|
1572
|
+
http?: HttpScaleRule;
|
|
1573
|
+
}
|
|
1574
|
+
/** Container App container Azure Queue based scaling rule. */
|
|
1575
|
+
export interface QueueScaleRule {
|
|
1576
|
+
/** Queue name. */
|
|
1577
|
+
queueName?: string;
|
|
1578
|
+
/** Queue length. */
|
|
1579
|
+
queueLength?: number;
|
|
1580
|
+
/** Authentication secrets for the queue scale rule. */
|
|
1581
|
+
auth?: Array<ScaleRuleAuth>;
|
|
1582
|
+
}
|
|
1583
|
+
/** Auth Secrets for Container App Scale Rule */
|
|
1584
|
+
export interface ScaleRuleAuth {
|
|
1585
|
+
/** Name of the Container App secret from which to pull the auth params. */
|
|
1586
|
+
secretRef?: string;
|
|
1587
|
+
/** Trigger Parameter that uses the secret */
|
|
1588
|
+
triggerParameter?: string;
|
|
1589
|
+
}
|
|
1590
|
+
/** Container App container Custom scaling rule. */
|
|
1591
|
+
export interface CustomScaleRule {
|
|
1592
|
+
/**
|
|
1593
|
+
* Type of the custom scale rule
|
|
1594
|
+
* eg: azure-servicebus, redis etc.
|
|
1595
|
+
*/
|
|
1596
|
+
type?: string;
|
|
1597
|
+
/** Metadata properties to describe custom scale rule. */
|
|
1598
|
+
metadata?: Record<string, string>;
|
|
1599
|
+
/** Authentication secrets for the custom scale rule. */
|
|
1600
|
+
auth?: Array<ScaleRuleAuth>;
|
|
1601
|
+
}
|
|
1602
|
+
/** Container App container Custom scaling rule. */
|
|
1603
|
+
export interface HttpScaleRule {
|
|
1604
|
+
/** Metadata properties to describe http scale rule. */
|
|
1605
|
+
metadata?: Record<string, string>;
|
|
1606
|
+
/** Authentication secrets for the custom scale rule. */
|
|
1607
|
+
auth?: Array<ScaleRuleAuth>;
|
|
1608
|
+
}
|
|
1609
|
+
/** Container App Dapr configuration. */
|
|
1610
|
+
export interface Dapr {
|
|
1611
|
+
/** Boolean indicating if the Dapr side car is enabled */
|
|
1612
|
+
enabled?: boolean;
|
|
1613
|
+
/** Dapr application identifier */
|
|
1614
|
+
appId?: string;
|
|
1615
|
+
/** Port on which the Dapr side car */
|
|
1616
|
+
appPort?: number;
|
|
1617
|
+
/** Collection of Dapr components */
|
|
1618
|
+
components?: Array<DaprComponent>;
|
|
1619
|
+
}
|
|
1620
|
+
/** Dapr component configuration */
|
|
1621
|
+
export interface DaprComponent {
|
|
1622
|
+
/** Component name */
|
|
1623
|
+
name?: string;
|
|
1624
|
+
/** Component type */
|
|
1625
|
+
type?: string;
|
|
1626
|
+
/** Component version */
|
|
1627
|
+
version?: string;
|
|
1628
|
+
/** Component metadata */
|
|
1629
|
+
metadata?: Array<DaprMetadata>;
|
|
1630
|
+
}
|
|
1631
|
+
/** Container App Dapr component metadata. */
|
|
1632
|
+
export interface DaprMetadata {
|
|
1633
|
+
/** Metadata property name. */
|
|
1634
|
+
name?: string;
|
|
1635
|
+
/** Metadata property value. */
|
|
1636
|
+
value?: string;
|
|
1637
|
+
/** Name of the Container App secret from which to pull the metadata property value. */
|
|
1638
|
+
secretRef?: string;
|
|
1639
|
+
}
|
|
1640
|
+
/** Container App Revision. */
|
|
1641
|
+
export interface Revision extends Resource {
|
|
1642
|
+
/** Revision resource specific properties */
|
|
1643
|
+
properties?: RevisionProperties;
|
|
1644
|
+
}
|
|
1645
|
+
/** Revision resource specific properties */
|
|
1646
|
+
export interface RevisionProperties {
|
|
1647
|
+
}
|
|
1648
|
+
/** A deleted app. */
|
|
1649
|
+
export interface DeletedSite extends ProxyOnlyResource {
|
|
1650
|
+
/** DeletedSite resource specific properties */
|
|
1651
|
+
properties?: DeletedSiteProperties;
|
|
1652
|
+
}
|
|
1653
|
+
/** DeletedSite resource specific properties */
|
|
1654
|
+
export interface DeletedSiteProperties {
|
|
1655
|
+
}
|
|
1656
|
+
/** Class representing detector definition */
|
|
1657
|
+
export interface DiagnosticCategory extends ProxyOnlyResource {
|
|
1658
|
+
/** DiagnosticCategory resource specific properties */
|
|
1659
|
+
properties?: DiagnosticCategoryProperties;
|
|
1660
|
+
}
|
|
1661
|
+
/** DiagnosticCategory resource specific properties */
|
|
1662
|
+
export interface DiagnosticCategoryProperties {
|
|
1663
|
+
}
|
|
1664
|
+
/** Definition of Analysis */
|
|
1665
|
+
export interface AnalysisDefinition extends ProxyOnlyResource {
|
|
1666
|
+
/** AnalysisDefinition resource specific properties */
|
|
1667
|
+
properties?: AnalysisDefinitionProperties;
|
|
1668
|
+
}
|
|
1669
|
+
/** AnalysisDefinition resource specific properties */
|
|
1670
|
+
export interface AnalysisDefinitionProperties {
|
|
1671
|
+
}
|
|
1672
|
+
/** Class representing a diagnostic analysis done on an application */
|
|
1673
|
+
export interface DiagnosticAnalysis extends ProxyOnlyResource {
|
|
1674
|
+
/** DiagnosticAnalysis resource specific properties */
|
|
1675
|
+
properties?: DiagnosticAnalysisProperties;
|
|
1676
|
+
}
|
|
1677
|
+
/** DiagnosticAnalysis resource specific properties */
|
|
1678
|
+
export interface DiagnosticAnalysisProperties {
|
|
1679
|
+
/** Start time of the period */
|
|
1680
|
+
startTime?: Date | string;
|
|
1681
|
+
/** End time of the period */
|
|
1682
|
+
endTime?: Date | string;
|
|
1683
|
+
/** List of time periods. */
|
|
1684
|
+
abnormalTimePeriods?: Array<AbnormalTimePeriod>;
|
|
1685
|
+
/** Data by each detector */
|
|
1686
|
+
payload?: Array<AnalysisData>;
|
|
1687
|
+
/** Data by each detector for detectors that did not corelate */
|
|
1688
|
+
nonCorrelatedDetectors?: Array<DetectorDefinition>;
|
|
1689
|
+
}
|
|
1690
|
+
/** Class representing Abnormal Time Period identified in diagnosis */
|
|
1691
|
+
export interface AbnormalTimePeriod {
|
|
1692
|
+
/** Start time of the downtime */
|
|
1693
|
+
startTime?: Date | string;
|
|
1694
|
+
/** End time of the downtime */
|
|
1695
|
+
endTime?: Date | string;
|
|
1696
|
+
/** List of Possible Cause of downtime */
|
|
1697
|
+
events?: Array<DetectorAbnormalTimePeriod>;
|
|
1698
|
+
/** List of proposed solutions */
|
|
1699
|
+
solutions?: Array<Solution>;
|
|
1700
|
+
}
|
|
1701
|
+
/** Class representing Abnormal Time Period detected. */
|
|
1702
|
+
export interface DetectorAbnormalTimePeriod {
|
|
1703
|
+
/** Start time of the correlated event */
|
|
1704
|
+
startTime?: Date | string;
|
|
1705
|
+
/** End time of the correlated event */
|
|
1706
|
+
endTime?: Date | string;
|
|
1707
|
+
/** Message describing the event */
|
|
1708
|
+
message?: string;
|
|
1709
|
+
/** Represents the name of the Detector */
|
|
1710
|
+
source?: string;
|
|
1711
|
+
/** Represents the rank of the Detector */
|
|
1712
|
+
priority?: number;
|
|
1713
|
+
/** Downtime metadata */
|
|
1714
|
+
metaData?: Array<Array<NameValuePair>>;
|
|
1715
|
+
/** Represents the type of the Detector */
|
|
1716
|
+
type?: "ServiceIncident" | "AppDeployment" | "AppCrash" | "RuntimeIssueDetected" | "AseDeployment" | "UserIssue" | "PlatformIssue" | "Other";
|
|
1717
|
+
/** List of proposed solutions */
|
|
1718
|
+
solutions?: Array<Solution>;
|
|
1719
|
+
}
|
|
1720
|
+
/** Class Representing Solution for problems detected. */
|
|
1721
|
+
export interface Solution {
|
|
1722
|
+
/** Solution Id. */
|
|
1723
|
+
id?: number;
|
|
1724
|
+
/** Display Name of the solution */
|
|
1725
|
+
displayName?: string;
|
|
1726
|
+
/** Order of the solution. */
|
|
1727
|
+
order?: number;
|
|
1728
|
+
/** Description of the solution */
|
|
1729
|
+
description?: string;
|
|
1730
|
+
/** Type of Solution */
|
|
1731
|
+
type?: "QuickSolution" | "DeepInvestigation" | "BestPractices";
|
|
1732
|
+
/** Solution Data. */
|
|
1733
|
+
data?: Array<Array<NameValuePair>>;
|
|
1734
|
+
/** Solution Metadata. */
|
|
1735
|
+
metadata?: Array<Array<NameValuePair>>;
|
|
1736
|
+
}
|
|
1737
|
+
/** Class Representing Detector Evidence used for analysis */
|
|
1738
|
+
export interface AnalysisData {
|
|
1739
|
+
/** Name of the Detector */
|
|
1740
|
+
source?: string;
|
|
1741
|
+
/** Detector Definition */
|
|
1742
|
+
detectorDefinition?: DetectorDefinition;
|
|
1743
|
+
/** Source Metrics */
|
|
1744
|
+
metrics?: Array<DiagnosticMetricSet>;
|
|
1745
|
+
/** Additional Source Data */
|
|
1746
|
+
data?: Array<Array<NameValuePair>>;
|
|
1747
|
+
/** Detector Meta Data */
|
|
1748
|
+
detectorMetaData?: ResponseMetaData;
|
|
1749
|
+
}
|
|
1750
|
+
/** Class representing detector definition */
|
|
1751
|
+
export interface DetectorDefinition {
|
|
1752
|
+
}
|
|
1753
|
+
/** Class representing Diagnostic Metric information */
|
|
1754
|
+
export interface DiagnosticMetricSet {
|
|
1755
|
+
/** Name of the metric */
|
|
1756
|
+
name?: string;
|
|
1757
|
+
/** Metric's unit */
|
|
1758
|
+
unit?: string;
|
|
1759
|
+
/** Start time of the period */
|
|
1760
|
+
startTime?: Date | string;
|
|
1761
|
+
/** End time of the period */
|
|
1762
|
+
endTime?: Date | string;
|
|
1763
|
+
/** Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D */
|
|
1764
|
+
timeGrain?: string;
|
|
1765
|
+
/** Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain} */
|
|
1766
|
+
values?: Array<DiagnosticMetricSample>;
|
|
1767
|
+
}
|
|
1768
|
+
/** Class representing Diagnostic Metric */
|
|
1769
|
+
export interface DiagnosticMetricSample {
|
|
1770
|
+
/** Time at which metric is measured */
|
|
1771
|
+
timestamp?: Date | string;
|
|
1772
|
+
/**
|
|
1773
|
+
* Role Instance. Null if this counter is not per instance
|
|
1774
|
+
* This is returned and should be whichever instance name we desire to be returned
|
|
1775
|
+
* i.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0)
|
|
1776
|
+
* where RDWORKERNAME is Machine name below and RoleInstance name in parenthesis
|
|
1777
|
+
*/
|
|
1778
|
+
roleInstance?: string;
|
|
1779
|
+
/** Total value of the metric. If multiple measurements are made this will have sum of all. */
|
|
1780
|
+
total?: number;
|
|
1781
|
+
/** Maximum of the metric sampled during the time period */
|
|
1782
|
+
maximum?: number;
|
|
1783
|
+
/** Minimum of the metric sampled during the time period */
|
|
1784
|
+
minimum?: number;
|
|
1785
|
+
/** Whether the values are aggregates across all workers or not */
|
|
1786
|
+
isAggregated?: boolean;
|
|
1787
|
+
}
|
|
1788
|
+
export interface ResponseMetaData {
|
|
1789
|
+
/** Source of the Data */
|
|
1790
|
+
dataSource?: DataSource;
|
|
1791
|
+
}
|
|
1792
|
+
/** Class representing data source used by the detectors */
|
|
1793
|
+
export interface DataSource {
|
|
1794
|
+
/** Instructions if any for the data source */
|
|
1795
|
+
instructions?: Array<string>;
|
|
1796
|
+
/** Datasource Uri Links */
|
|
1797
|
+
dataSourceUri?: Array<NameValuePair>;
|
|
1798
|
+
}
|
|
1799
|
+
/** ARM resource for a detector definition */
|
|
1800
|
+
export interface DetectorDefinitionResource extends ProxyOnlyResource {
|
|
1801
|
+
/** Core resource properties */
|
|
1802
|
+
properties?: DetectorDefinition;
|
|
1803
|
+
}
|
|
1804
|
+
/** Class representing Response from Diagnostic Detectors */
|
|
1805
|
+
export interface DiagnosticDetectorResponse extends ProxyOnlyResource {
|
|
1806
|
+
/** DiagnosticDetectorResponse resource specific properties */
|
|
1807
|
+
properties?: DiagnosticDetectorResponseProperties;
|
|
1808
|
+
}
|
|
1809
|
+
/** DiagnosticDetectorResponse resource specific properties */
|
|
1810
|
+
export interface DiagnosticDetectorResponseProperties {
|
|
1811
|
+
/** Start time of the period */
|
|
1812
|
+
startTime?: Date | string;
|
|
1813
|
+
/** End time of the period */
|
|
1814
|
+
endTime?: Date | string;
|
|
1815
|
+
/** Flag representing Issue was detected. */
|
|
1816
|
+
issueDetected?: boolean;
|
|
1817
|
+
/** Detector's definition */
|
|
1818
|
+
detectorDefinition?: DetectorDefinition;
|
|
1819
|
+
/** Metrics provided by the detector */
|
|
1820
|
+
metrics?: Array<DiagnosticMetricSet>;
|
|
1821
|
+
/** List of Correlated events found by the detector */
|
|
1822
|
+
abnormalTimePeriods?: Array<DetectorAbnormalTimePeriod>;
|
|
1823
|
+
/** Additional Data that detector wants to send. */
|
|
1824
|
+
data?: Array<Array<NameValuePair>>;
|
|
1825
|
+
/** Meta Data */
|
|
1826
|
+
responseMetaData?: ResponseMetaData;
|
|
1827
|
+
}
|
|
1828
|
+
/** A snapshot of an app. */
|
|
1829
|
+
export interface Snapshot extends ProxyOnlyResource {
|
|
1830
|
+
/** Snapshot resource specific properties */
|
|
1831
|
+
properties?: SnapshotProperties;
|
|
1832
|
+
}
|
|
1833
|
+
/** Snapshot resource specific properties */
|
|
1834
|
+
export interface SnapshotProperties {
|
|
1835
|
+
}
|
|
1836
|
+
/** A Kubernetes cluster specialized for web workloads by Azure App Service */
|
|
1837
|
+
export interface KubeEnvironment extends Resource {
|
|
1838
|
+
/** KubeEnvironment resource specific properties */
|
|
1839
|
+
properties?: KubeEnvironmentProperties;
|
|
1840
|
+
/** Extended Location. */
|
|
1841
|
+
extendedLocation?: ExtendedLocation;
|
|
1842
|
+
}
|
|
1843
|
+
/** KubeEnvironment resource specific properties */
|
|
1844
|
+
export interface KubeEnvironmentProperties {
|
|
1845
|
+
/** Only visible within Vnet/Subnet */
|
|
1846
|
+
internalLoadBalancerEnabled?: boolean;
|
|
1847
|
+
/** Static IP of the KubeEnvironment */
|
|
1848
|
+
staticIp?: string;
|
|
1849
|
+
/** Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed */
|
|
1850
|
+
environmentType?: string;
|
|
1851
|
+
/**
|
|
1852
|
+
* Cluster configuration which determines the ARC cluster
|
|
1853
|
+
* components types. Eg: Choosing between BuildService kind,
|
|
1854
|
+
* FrontEnd Service ArtifactsStorageType etc.
|
|
1855
|
+
*/
|
|
1856
|
+
arcConfiguration?: ArcConfiguration;
|
|
1857
|
+
/**
|
|
1858
|
+
* Cluster configuration which enables the log daemon to export
|
|
1859
|
+
* app logs to a destination. Currently only "log-analytics" is
|
|
1860
|
+
* supported
|
|
1861
|
+
*/
|
|
1862
|
+
appLogsConfiguration?: AppLogsConfiguration;
|
|
1863
|
+
/** Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration */
|
|
1864
|
+
containerAppsConfiguration?: ContainerAppsConfiguration;
|
|
1865
|
+
aksResourceID?: string;
|
|
1866
|
+
}
|
|
1867
|
+
export interface ArcConfiguration {
|
|
1868
|
+
artifactsStorageType?: "LocalNode" | "NetworkFileSystem";
|
|
1869
|
+
artifactStorageClassName?: string;
|
|
1870
|
+
artifactStorageMountPath?: string;
|
|
1871
|
+
artifactStorageNodeName?: string;
|
|
1872
|
+
artifactStorageAccessMode?: string;
|
|
1873
|
+
frontEndServiceConfiguration?: FrontEndConfiguration;
|
|
1874
|
+
kubeConfig?: string;
|
|
1875
|
+
}
|
|
1876
|
+
export interface FrontEndConfiguration {
|
|
1877
|
+
kind?: "NodePort" | "LoadBalancer";
|
|
1878
|
+
}
|
|
1879
|
+
export interface AppLogsConfiguration {
|
|
1880
|
+
destination?: string;
|
|
1881
|
+
logAnalyticsConfiguration?: LogAnalyticsConfiguration;
|
|
1882
|
+
}
|
|
1883
|
+
export interface LogAnalyticsConfiguration {
|
|
1884
|
+
customerId?: string;
|
|
1885
|
+
sharedKey?: string;
|
|
1886
|
+
}
|
|
1887
|
+
export interface ContainerAppsConfiguration {
|
|
1888
|
+
/** Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry */
|
|
1889
|
+
daprAIInstrumentationKey?: string;
|
|
1890
|
+
/** IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. */
|
|
1891
|
+
platformReservedCidr?: string;
|
|
1892
|
+
/** An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server */
|
|
1893
|
+
platformReservedDnsIP?: string;
|
|
1894
|
+
/** Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. */
|
|
1895
|
+
controlPlaneSubnetResourceId?: string;
|
|
1896
|
+
/** Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. */
|
|
1897
|
+
appSubnetResourceId?: string;
|
|
1898
|
+
/** CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. */
|
|
1899
|
+
dockerBridgeCidr?: string;
|
|
1900
|
+
}
|
|
1901
|
+
/** ARM resource for a KubeEnvironment when patching */
|
|
1902
|
+
export interface KubeEnvironmentPatchResource extends ProxyOnlyResource {
|
|
1903
|
+
/** KubeEnvironmentPatchResource resource specific properties */
|
|
1904
|
+
properties?: KubeEnvironmentPatchResourceProperties;
|
|
1905
|
+
}
|
|
1906
|
+
/** KubeEnvironmentPatchResource resource specific properties */
|
|
1907
|
+
export interface KubeEnvironmentPatchResourceProperties {
|
|
1908
|
+
/** Only visible within Vnet/Subnet */
|
|
1909
|
+
internalLoadBalancerEnabled?: boolean;
|
|
1910
|
+
/** Static IP of the KubeEnvironment */
|
|
1911
|
+
staticIp?: string;
|
|
1912
|
+
/**
|
|
1913
|
+
* Cluster configuration which determines the ARC cluster
|
|
1914
|
+
* components types. Eg: Choosing between BuildService kind,
|
|
1915
|
+
* FrontEnd Service ArtifactsStorageType etc.
|
|
1916
|
+
*/
|
|
1917
|
+
arcConfiguration?: ArcConfiguration;
|
|
1918
|
+
/**
|
|
1919
|
+
* Cluster configuration which enables the log daemon to export
|
|
1920
|
+
* app logs to a destination. Currently only "log-analytics" is
|
|
1921
|
+
* supported
|
|
1922
|
+
*/
|
|
1923
|
+
appLogsConfiguration?: AppLogsConfiguration;
|
|
1924
|
+
/** Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration */
|
|
1925
|
+
containerAppsConfiguration?: ContainerAppsConfiguration;
|
|
1926
|
+
aksResourceID?: string;
|
|
1927
|
+
}
|
|
1928
|
+
/** ARM resource for a ApplicationStack. */
|
|
1929
|
+
export interface ApplicationStackResource extends ProxyOnlyResource {
|
|
1930
|
+
/** Core resource properties */
|
|
1931
|
+
properties?: ApplicationStack;
|
|
1932
|
+
}
|
|
1933
|
+
/** Application stack. */
|
|
1934
|
+
export interface ApplicationStack {
|
|
1935
|
+
/** Application stack name. */
|
|
1936
|
+
name?: string;
|
|
1937
|
+
/** Application stack display name. */
|
|
1938
|
+
display?: string;
|
|
1939
|
+
/** Application stack dependency. */
|
|
1940
|
+
dependency?: string;
|
|
1941
|
+
/** List of major versions available. */
|
|
1942
|
+
majorVersions?: Array<StackMajorVersion>;
|
|
1943
|
+
/** List of frameworks associated with application stack. */
|
|
1944
|
+
frameworks?: Array<ApplicationStack>;
|
|
1945
|
+
/** <code>true</code> if this is the stack is deprecated; otherwise, <code>false</code>. */
|
|
1946
|
+
isDeprecated?: Array<ApplicationStack>;
|
|
1947
|
+
}
|
|
1948
|
+
/** Application stack major version. */
|
|
1949
|
+
export interface StackMajorVersion {
|
|
1950
|
+
/** Application stack major version (display only). */
|
|
1951
|
+
displayVersion?: string;
|
|
1952
|
+
/** Application stack major version (runtime only). */
|
|
1953
|
+
runtimeVersion?: string;
|
|
1954
|
+
/** <code>true</code> if this is the default major version; otherwise, <code>false</code>. */
|
|
1955
|
+
isDefault?: boolean;
|
|
1956
|
+
/** Minor versions associated with the major version. */
|
|
1957
|
+
minorVersions?: Array<StackMinorVersion>;
|
|
1958
|
+
/** <code>true</code> if this supports Application Insights; otherwise, <code>false</code>. */
|
|
1959
|
+
applicationInsights?: boolean;
|
|
1960
|
+
/** <code>true</code> if this stack is in Preview, otherwise <code>false</code>. */
|
|
1961
|
+
isPreview?: boolean;
|
|
1962
|
+
/** <code>true</code> if this stack has been deprecated, otherwise <code>false</code>. */
|
|
1963
|
+
isDeprecated?: boolean;
|
|
1964
|
+
/** <code>true</code> if this stack should be hidden for new customers on portal, otherwise <code>false</code>. */
|
|
1965
|
+
isHidden?: boolean;
|
|
1966
|
+
/**
|
|
1967
|
+
* <appSettings>
|
|
1968
|
+
* <appSetting name="FUNCTIONS_WORKER_RUNTIME" value="dotnet" />
|
|
1969
|
+
* </appSettings>
|
|
1970
|
+
* Example: All the function apps need AppSetting: "FUNCTIONS_WORKER_RUNTIME" to be set stack name
|
|
1971
|
+
*/
|
|
1972
|
+
appSettingsDictionary?: Record<string, Record<string, unknown>>;
|
|
1973
|
+
/**
|
|
1974
|
+
* <siteConfigProperties>
|
|
1975
|
+
* <siteConfigProperty name="Use32BitWorkerProcess" value="false" />
|
|
1976
|
+
* </siteConfigProperties>
|
|
1977
|
+
* Example: All Linux Function Apps, need Use32BitWorkerProcess to be set to 0
|
|
1978
|
+
*/
|
|
1979
|
+
siteConfigPropertiesDictionary?: Record<string, Record<string, unknown>>;
|
|
1980
|
+
}
|
|
1981
|
+
/** Application stack minor version. */
|
|
1982
|
+
export interface StackMinorVersion {
|
|
1983
|
+
/** Application stack minor version (display only). */
|
|
1984
|
+
displayVersion?: string;
|
|
1985
|
+
/** Application stack minor version (runtime only). */
|
|
1986
|
+
runtimeVersion?: string;
|
|
1987
|
+
/** <code>true</code> if this is the default minor version; otherwise, <code>false</code>. */
|
|
1988
|
+
isDefault?: boolean;
|
|
1989
|
+
/** <code>true</code> if this supports Remote Debugging, otherwise <code>false</code>. */
|
|
1990
|
+
isRemoteDebuggingEnabled?: boolean;
|
|
1991
|
+
}
|
|
1992
|
+
/** Function App Stack. */
|
|
1993
|
+
export interface FunctionAppStack extends ProxyOnlyResource {
|
|
1994
|
+
/** FunctionAppStack resource specific properties */
|
|
1995
|
+
properties?: FunctionAppStackProperties;
|
|
1996
|
+
}
|
|
1997
|
+
/** FunctionAppStack resource specific properties */
|
|
1998
|
+
export interface FunctionAppStackProperties {
|
|
1999
|
+
}
|
|
2000
|
+
/** Function App stack major version. */
|
|
2001
|
+
export interface FunctionAppMajorVersion {
|
|
2002
|
+
}
|
|
2003
|
+
/** Function App stack minor version. */
|
|
2004
|
+
export interface FunctionAppMinorVersion {
|
|
2005
|
+
}
|
|
2006
|
+
/** Function App stack runtimes. */
|
|
2007
|
+
export interface FunctionAppRuntimes {
|
|
2008
|
+
}
|
|
2009
|
+
/** Function App runtime settings. */
|
|
2010
|
+
export interface FunctionAppRuntimeSettings {
|
|
2011
|
+
}
|
|
2012
|
+
/** App Insights Web App stack settings. */
|
|
2013
|
+
export interface AppInsightsWebAppStackSettings {
|
|
2014
|
+
}
|
|
2015
|
+
/** GitHub Actions Web App stack settings. */
|
|
2016
|
+
export interface GitHubActionWebAppStackSettings {
|
|
2017
|
+
}
|
|
2018
|
+
/** Site config properties dictionary. */
|
|
2019
|
+
export interface SiteConfigPropertiesDictionary {
|
|
2020
|
+
}
|
|
2021
|
+
/** Web App stack. */
|
|
2022
|
+
export interface WebAppStack extends ProxyOnlyResource {
|
|
2023
|
+
/** WebAppStack resource specific properties */
|
|
2024
|
+
properties?: WebAppStackProperties;
|
|
2025
|
+
}
|
|
2026
|
+
/** WebAppStack resource specific properties */
|
|
2027
|
+
export interface WebAppStackProperties {
|
|
2028
|
+
}
|
|
2029
|
+
/** Web App stack major version. */
|
|
2030
|
+
export interface WebAppMajorVersion {
|
|
2031
|
+
}
|
|
2032
|
+
/** Web App stack minor version. */
|
|
2033
|
+
export interface WebAppMinorVersion {
|
|
2034
|
+
}
|
|
2035
|
+
/** Web App stack runtimes. */
|
|
2036
|
+
export interface WebAppRuntimes {
|
|
2037
|
+
}
|
|
2038
|
+
/** Web App runtime settings. */
|
|
2039
|
+
export interface WebAppRuntimeSettings {
|
|
2040
|
+
}
|
|
2041
|
+
/** Linux Java Container settings. */
|
|
2042
|
+
export interface LinuxJavaContainerSettings {
|
|
2043
|
+
}
|
|
2044
|
+
/** Windows Java Container settings. */
|
|
2045
|
+
export interface WindowsJavaContainerSettings {
|
|
2046
|
+
}
|
|
2047
|
+
/** Represents a recommendation result generated by the recommendation engine. */
|
|
2048
|
+
export interface Recommendation extends ProxyOnlyResource {
|
|
2049
|
+
/** Recommendation resource specific properties */
|
|
2050
|
+
properties?: RecommendationProperties;
|
|
2051
|
+
}
|
|
2052
|
+
/** Recommendation resource specific properties */
|
|
2053
|
+
export interface RecommendationProperties {
|
|
2054
|
+
/** Timestamp when this instance was created. */
|
|
2055
|
+
creationTime?: Date | string;
|
|
2056
|
+
/**
|
|
2057
|
+
* A GUID value that each recommendation object is associated with.
|
|
2058
|
+
*
|
|
2059
|
+
* Value may contain a UUID
|
|
2060
|
+
*/
|
|
2061
|
+
recommendationId?: string;
|
|
2062
|
+
/** Full ARM resource ID string that this recommendation object is associated with. */
|
|
2063
|
+
resourceId?: string;
|
|
2064
|
+
/** Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. */
|
|
2065
|
+
resourceScope?: "ServerFarm" | "Subscription" | "WebSite";
|
|
2066
|
+
/** Unique name of the rule. */
|
|
2067
|
+
ruleName?: string;
|
|
2068
|
+
/** UI friendly name of the rule (may not be unique). */
|
|
2069
|
+
displayName?: string;
|
|
2070
|
+
/** Recommendation text. */
|
|
2071
|
+
message?: string;
|
|
2072
|
+
/** Level indicating how critical this recommendation can impact. */
|
|
2073
|
+
level?: "Critical" | "Warning" | "Information" | "NonUrgentSuggestion";
|
|
2074
|
+
/** List of channels that this recommendation can apply. */
|
|
2075
|
+
channels?: "Notification" | "Api" | "Email" | "Webhook" | "All";
|
|
2076
|
+
/** Name of action recommended by this object. */
|
|
2077
|
+
actionName?: string;
|
|
2078
|
+
/** True if this recommendation is still valid (i.e. "actionable"). False if it is invalid. */
|
|
2079
|
+
enabled?: number;
|
|
2080
|
+
/** The list of states of this recommendation. If it's null then it should be considered "Active". */
|
|
2081
|
+
states?: Array<string>;
|
|
2082
|
+
/** The beginning time in UTC of a range that the recommendation refers to. */
|
|
2083
|
+
startTime?: Date | string;
|
|
2084
|
+
/** The end time in UTC of a range that the recommendation refers to. */
|
|
2085
|
+
endTime?: Date | string;
|
|
2086
|
+
/** When to notify this recommendation next in UTC. Null means that this will never be notified anymore. */
|
|
2087
|
+
nextNotificationTime?: Date | string;
|
|
2088
|
+
/** Date and time in UTC when this notification expires. */
|
|
2089
|
+
notificationExpirationTime?: Date | string;
|
|
2090
|
+
/** Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet. */
|
|
2091
|
+
notifiedTime?: Date | string;
|
|
2092
|
+
/** A metric value measured by the rule. */
|
|
2093
|
+
score?: number;
|
|
2094
|
+
/** True if this is associated with a dynamically added rule */
|
|
2095
|
+
isDynamic?: boolean;
|
|
2096
|
+
/** Extension name of the portal if exists. */
|
|
2097
|
+
extensionName?: string;
|
|
2098
|
+
/** Deep link to a blade on the portal. */
|
|
2099
|
+
bladeName?: string;
|
|
2100
|
+
/** Forward link to an external document associated with the rule. */
|
|
2101
|
+
forwardLink?: string;
|
|
2102
|
+
}
|
|
2103
|
+
/** Represents a recommendation rule that the recommendation engine can perform. */
|
|
2104
|
+
export interface RecommendationRule extends ProxyOnlyResource {
|
|
2105
|
+
/** RecommendationRule resource specific properties */
|
|
2106
|
+
properties?: RecommendationRuleProperties;
|
|
2107
|
+
}
|
|
2108
|
+
/** RecommendationRule resource specific properties */
|
|
2109
|
+
export interface RecommendationRuleProperties {
|
|
2110
|
+
/** Unique name of the rule. */
|
|
2111
|
+
recommendationName?: string;
|
|
2112
|
+
/** UI friendly name of the rule. */
|
|
2113
|
+
displayName?: string;
|
|
2114
|
+
/** Localized name of the rule (Good for UI). */
|
|
2115
|
+
message?: string;
|
|
2116
|
+
/**
|
|
2117
|
+
* Recommendation ID of an associated recommendation object tied to the rule, if exists.
|
|
2118
|
+
* If such an object doesn't exist, it is set to null.
|
|
2119
|
+
*
|
|
2120
|
+
* Value may contain a UUID
|
|
2121
|
+
*/
|
|
2122
|
+
recommendationId?: string;
|
|
2123
|
+
/** Localized detailed description of the rule. */
|
|
2124
|
+
description?: string;
|
|
2125
|
+
/** Name of action that is recommended by this rule in string. */
|
|
2126
|
+
actionName?: string;
|
|
2127
|
+
/** Level of impact indicating how critical this rule is. */
|
|
2128
|
+
level?: "Critical" | "Warning" | "Information" | "NonUrgentSuggestion";
|
|
2129
|
+
/** List of available channels that this rule applies. */
|
|
2130
|
+
channels?: "Notification" | "Api" | "Email" | "Webhook" | "All";
|
|
2131
|
+
/** True if this is associated with a dynamically added rule */
|
|
2132
|
+
isDynamic?: boolean;
|
|
2133
|
+
/** Extension name of the portal if exists. Applicable to dynamic rule only. */
|
|
2134
|
+
extensionName?: string;
|
|
2135
|
+
/** Deep link to a blade on the portal. Applicable to dynamic rule only. */
|
|
2136
|
+
bladeName?: string;
|
|
2137
|
+
/** Forward link to an external document associated with the rule. Applicable to dynamic rule only. */
|
|
2138
|
+
forwardLink?: string;
|
|
2139
|
+
}
|
|
2140
|
+
/** Used for getting ResourceHealthCheck settings. */
|
|
2141
|
+
export interface ResourceHealthMetadata extends ProxyOnlyResource {
|
|
2142
|
+
/** ResourceHealthMetadata resource specific properties */
|
|
2143
|
+
properties?: ResourceHealthMetadataProperties;
|
|
2144
|
+
}
|
|
2145
|
+
/** ResourceHealthMetadata resource specific properties */
|
|
2146
|
+
export interface ResourceHealthMetadataProperties {
|
|
2147
|
+
/** The category that the resource matches in the RHC Policy File */
|
|
2148
|
+
category?: string;
|
|
2149
|
+
/** Is there a health signal for the resource */
|
|
2150
|
+
signalAvailability?: boolean;
|
|
2151
|
+
}
|
|
2152
|
+
/** User credentials used for publishing activity. */
|
|
2153
|
+
export interface User extends ProxyOnlyResource {
|
|
2154
|
+
/** User resource specific properties */
|
|
2155
|
+
properties?: UserProperties;
|
|
2156
|
+
}
|
|
2157
|
+
/** User resource specific properties */
|
|
2158
|
+
export interface UserProperties {
|
|
2159
|
+
/** Username used for publishing. */
|
|
2160
|
+
publishingUserName: string;
|
|
2161
|
+
/**
|
|
2162
|
+
* Password used for publishing.
|
|
2163
|
+
*
|
|
2164
|
+
* Value may contain a password
|
|
2165
|
+
*/
|
|
2166
|
+
publishingPassword?: string;
|
|
2167
|
+
/**
|
|
2168
|
+
* Password hash used for publishing.
|
|
2169
|
+
*
|
|
2170
|
+
* Value may contain a password
|
|
2171
|
+
*/
|
|
2172
|
+
publishingPasswordHash?: string;
|
|
2173
|
+
/**
|
|
2174
|
+
* Password hash salt used for publishing.
|
|
2175
|
+
*
|
|
2176
|
+
* Value may contain a password
|
|
2177
|
+
*/
|
|
2178
|
+
publishingPasswordHashSalt?: string;
|
|
2179
|
+
/** Url of SCM site. */
|
|
2180
|
+
scmUri?: string;
|
|
2181
|
+
}
|
|
2182
|
+
/** The source control OAuth token. */
|
|
2183
|
+
export interface SourceControl extends ProxyOnlyResource {
|
|
2184
|
+
/** SourceControl resource specific properties */
|
|
2185
|
+
properties?: SourceControlProperties;
|
|
2186
|
+
}
|
|
2187
|
+
/** SourceControl resource specific properties */
|
|
2188
|
+
export interface SourceControlProperties {
|
|
2189
|
+
/** OAuth access token. */
|
|
2190
|
+
token?: string;
|
|
2191
|
+
/** OAuth access token secret. */
|
|
2192
|
+
tokenSecret?: string;
|
|
2193
|
+
/** OAuth refresh token. */
|
|
2194
|
+
refreshToken?: string;
|
|
2195
|
+
/** OAuth token expiration. */
|
|
2196
|
+
expirationTime?: Date | string;
|
|
2197
|
+
}
|
|
2198
|
+
/** App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services. */
|
|
2199
|
+
export interface BillingMeter extends ProxyOnlyResource {
|
|
2200
|
+
/** BillingMeter resource specific properties */
|
|
2201
|
+
properties?: BillingMeterProperties;
|
|
2202
|
+
}
|
|
2203
|
+
/** BillingMeter resource specific properties */
|
|
2204
|
+
export interface BillingMeterProperties {
|
|
2205
|
+
/** Meter GUID onboarded in Commerce */
|
|
2206
|
+
meterId?: string;
|
|
2207
|
+
/** Azure Location of billable resource */
|
|
2208
|
+
billingLocation?: string;
|
|
2209
|
+
/** Short Name from App Service Azure pricing Page */
|
|
2210
|
+
shortName?: string;
|
|
2211
|
+
/** Friendly name of the meter */
|
|
2212
|
+
friendlyName?: string;
|
|
2213
|
+
/** App Service ResourceType meter used for */
|
|
2214
|
+
resourceType?: string;
|
|
2215
|
+
/** App Service OS type meter used for */
|
|
2216
|
+
osType?: string;
|
|
2217
|
+
/** Meter Multiplier */
|
|
2218
|
+
multiplier?: number;
|
|
2219
|
+
}
|
|
2220
|
+
/** Resource name availability request content. */
|
|
2221
|
+
export interface ResourceNameAvailabilityRequest {
|
|
2222
|
+
/** Resource name to verify. */
|
|
2223
|
+
name: string;
|
|
2224
|
+
/** Resource type used for verification. */
|
|
2225
|
+
type: "Site" | "Slot" | "HostingEnvironment" | "PublishingUser" | "Microsoft.Web/sites" | "Microsoft.Web/sites/slots" | "Microsoft.Web/hostingEnvironments" | "Microsoft.Web/publishingUsers";
|
|
2226
|
+
/** Is fully qualified domain name. */
|
|
2227
|
+
isFqdn?: boolean;
|
|
2228
|
+
}
|
|
2229
|
+
/** A hostname and its assigned sites */
|
|
2230
|
+
export interface CustomHostnameSites extends ProxyOnlyResource {
|
|
2231
|
+
/** CustomHostnameSites resource specific properties */
|
|
2232
|
+
properties?: CustomHostnameSitesProperties;
|
|
2233
|
+
}
|
|
2234
|
+
/** CustomHostnameSites resource specific properties */
|
|
2235
|
+
export interface CustomHostnameSitesProperties {
|
|
2236
|
+
customHostname?: string;
|
|
2237
|
+
region?: string;
|
|
2238
|
+
siteResourceIds?: Array<Identifier>;
|
|
2239
|
+
}
|
|
2240
|
+
/** A domain specific resource identifier. */
|
|
2241
|
+
export interface Identifier extends ProxyOnlyResource {
|
|
2242
|
+
/** Identifier resource specific properties */
|
|
2243
|
+
properties?: IdentifierProperties;
|
|
2244
|
+
}
|
|
2245
|
+
/** Identifier resource specific properties */
|
|
2246
|
+
export interface IdentifierProperties {
|
|
2247
|
+
/** String representation of the identity. */
|
|
2248
|
+
id?: string;
|
|
2249
|
+
}
|
|
2250
|
+
/** Geographical region. */
|
|
2251
|
+
export interface GeoRegion extends ProxyOnlyResource {
|
|
2252
|
+
/** GeoRegion resource specific properties */
|
|
2253
|
+
properties?: GeoRegionProperties;
|
|
2254
|
+
}
|
|
2255
|
+
/** GeoRegion resource specific properties */
|
|
2256
|
+
export interface GeoRegionProperties {
|
|
2257
|
+
}
|
|
2258
|
+
/** Premier add-on offer. */
|
|
2259
|
+
export interface PremierAddOnOffer extends ProxyOnlyResource {
|
|
2260
|
+
/** PremierAddOnOffer resource specific properties */
|
|
2261
|
+
properties?: PremierAddOnOfferProperties;
|
|
2262
|
+
}
|
|
2263
|
+
/** PremierAddOnOffer resource specific properties */
|
|
2264
|
+
export interface PremierAddOnOfferProperties {
|
|
2265
|
+
/** Premier add on SKU. */
|
|
2266
|
+
sku?: string;
|
|
2267
|
+
/** Premier add on offer Product. */
|
|
2268
|
+
product?: string;
|
|
2269
|
+
/** Premier add on offer Vendor. */
|
|
2270
|
+
vendor?: string;
|
|
2271
|
+
/** <code>true</code> if promotion code is required; otherwise, <code>false</code>. */
|
|
2272
|
+
promoCodeRequired?: boolean;
|
|
2273
|
+
/** Premier add on offer Quota. */
|
|
2274
|
+
quota?: number;
|
|
2275
|
+
/** App Service plans this offer is restricted to. */
|
|
2276
|
+
webHostingPlanRestrictions?: "None" | "Free" | "Shared" | "Basic" | "Standard" | "Premium";
|
|
2277
|
+
/** Privacy policy URL. */
|
|
2278
|
+
privacyPolicyUrl?: string;
|
|
2279
|
+
/** Legal terms URL. */
|
|
2280
|
+
legalTermsUrl?: string;
|
|
2281
|
+
/** Marketplace publisher. */
|
|
2282
|
+
marketplacePublisher?: string;
|
|
2283
|
+
/** Marketplace offer. */
|
|
2284
|
+
marketplaceOffer?: string;
|
|
2285
|
+
}
|
|
2286
|
+
/** The required set of inputs to validate a VNET */
|
|
2287
|
+
export interface VnetParameters extends ProxyOnlyResource {
|
|
2288
|
+
/** VnetParameters resource specific properties */
|
|
2289
|
+
properties?: VnetParametersProperties;
|
|
2290
|
+
}
|
|
2291
|
+
/** VnetParameters resource specific properties */
|
|
2292
|
+
export interface VnetParametersProperties {
|
|
2293
|
+
/** The Resource Group of the VNET to be validated */
|
|
2294
|
+
vnetResourceGroup?: string;
|
|
2295
|
+
/** The name of the VNET to be validated */
|
|
2296
|
+
vnetName?: string;
|
|
2297
|
+
/** The subnet name to be validated */
|
|
2298
|
+
vnetSubnetName?: string;
|
|
2299
|
+
/** The ARM Resource ID of the subnet to validate */
|
|
2300
|
+
subnetResourceId?: string;
|
|
2301
|
+
}
|
|
2302
|
+
/** A class that describes the reason for a validation failure. */
|
|
2303
|
+
export interface VnetValidationFailureDetails extends ProxyOnlyResource {
|
|
2304
|
+
/** VnetValidationFailureDetails resource specific properties */
|
|
2305
|
+
properties?: VnetValidationFailureDetailsProperties;
|
|
2306
|
+
}
|
|
2307
|
+
/** VnetValidationFailureDetails resource specific properties */
|
|
2308
|
+
export interface VnetValidationFailureDetailsProperties {
|
|
2309
|
+
/** Text describing the validation outcome. */
|
|
2310
|
+
message?: string;
|
|
2311
|
+
/** A flag describing whether or not validation failed. */
|
|
2312
|
+
failed?: boolean;
|
|
2313
|
+
/** A list of tests that failed in the validation. */
|
|
2314
|
+
failedTests?: Array<VnetValidationTestFailure>;
|
|
2315
|
+
/** A list of warnings generated during validation. */
|
|
2316
|
+
warnings?: Array<VnetValidationTestFailure>;
|
|
2317
|
+
}
|
|
2318
|
+
/** A class that describes a test that failed during NSG and UDR validation. */
|
|
2319
|
+
export interface VnetValidationTestFailure extends ProxyOnlyResource {
|
|
2320
|
+
/** VnetValidationTestFailure resource specific properties */
|
|
2321
|
+
properties?: VnetValidationTestFailureProperties;
|
|
2322
|
+
}
|
|
2323
|
+
/** VnetValidationTestFailure resource specific properties */
|
|
2324
|
+
export interface VnetValidationTestFailureProperties {
|
|
2325
|
+
/** The name of the test that failed. */
|
|
2326
|
+
testName?: string;
|
|
2327
|
+
/** The details of what caused the failure, e.g. the blocking rule name, etc. */
|
|
2328
|
+
details?: string;
|
|
2329
|
+
}
|
|
2330
|
+
/** Object with a list of the resources that need to be moved and the resource group they should be moved to. */
|
|
2331
|
+
export interface CsmMoveResourceEnvelope {
|
|
2332
|
+
targetResourceGroup?: string;
|
|
2333
|
+
resources?: Array<string>;
|
|
2334
|
+
}
|
|
2335
|
+
/** Resource validation request content. */
|
|
2336
|
+
export interface ValidateRequest {
|
|
2337
|
+
/** Resource name to verify. */
|
|
2338
|
+
name: string;
|
|
2339
|
+
/** Resource type used for verification. */
|
|
2340
|
+
type: "ServerFarm" | "Site" | "Microsoft.Web/hostingEnvironments";
|
|
2341
|
+
/** Expected location of the resource. */
|
|
2342
|
+
location: string;
|
|
2343
|
+
/** Properties of the resource to validate. */
|
|
2344
|
+
properties: ValidateProperties;
|
|
2345
|
+
}
|
|
2346
|
+
/** App properties used for validation. */
|
|
2347
|
+
export interface ValidateProperties {
|
|
2348
|
+
/** ARM resource ID of an App Service plan that would host the app. */
|
|
2349
|
+
serverFarmId?: string;
|
|
2350
|
+
/** Name of the target SKU for the App Service plan. */
|
|
2351
|
+
skuName?: string;
|
|
2352
|
+
/** <code>true</code> if App Service plan is for Linux workers; otherwise, <code>false</code>. */
|
|
2353
|
+
needLinuxWorkers?: boolean;
|
|
2354
|
+
/** <code>true</code> if App Service plan is for Spot instances; otherwise, <code>false</code>. */
|
|
2355
|
+
isSpot?: boolean;
|
|
2356
|
+
/** Target capacity of the App Service plan (number of VMs). */
|
|
2357
|
+
capacity?: number;
|
|
2358
|
+
/** Name of App Service Environment where app or App Service plan should be created. */
|
|
2359
|
+
hostingEnvironment?: string;
|
|
2360
|
+
/** <code>true</code> if App Service plan is running as a windows container */
|
|
2361
|
+
isXenon?: boolean;
|
|
2362
|
+
/** Base URL of the container registry */
|
|
2363
|
+
containerRegistryBaseUrl?: string;
|
|
2364
|
+
/** Username for to access the container registry */
|
|
2365
|
+
containerRegistryUsername?: string;
|
|
2366
|
+
/** Password for to access the container registry */
|
|
2367
|
+
containerRegistryPassword?: string;
|
|
2368
|
+
/** Repository name (image name) */
|
|
2369
|
+
containerImageRepository?: string;
|
|
2370
|
+
/** Image tag */
|
|
2371
|
+
containerImageTag?: string;
|
|
2372
|
+
/** Platform (windows or linux) */
|
|
2373
|
+
containerImagePlatform?: string;
|
|
2374
|
+
/** App Service Environment Properties */
|
|
2375
|
+
appServiceEnvironment?: AppServiceEnvironment;
|
|
2376
|
+
}
|
|
2377
|
+
/** Request entity for previewing the Static Site workflow */
|
|
2378
|
+
export interface StaticSitesWorkflowPreviewRequest extends ProxyOnlyResource {
|
|
2379
|
+
/** StaticSitesWorkflowPreviewRequest resource specific properties */
|
|
2380
|
+
properties?: StaticSitesWorkflowPreviewRequestProperties;
|
|
2381
|
+
}
|
|
2382
|
+
/** StaticSitesWorkflowPreviewRequest resource specific properties */
|
|
2383
|
+
export interface StaticSitesWorkflowPreviewRequestProperties {
|
|
2384
|
+
/** URL for the repository of the static site. */
|
|
2385
|
+
repositoryUrl?: string;
|
|
2386
|
+
/** The target branch in the repository. */
|
|
2387
|
+
branch?: string;
|
|
2388
|
+
/** Build properties to configure on the repository. */
|
|
2389
|
+
buildProperties?: StaticSiteBuildProperties;
|
|
2390
|
+
}
|
|
2391
|
+
/** Build properties for the static site. */
|
|
2392
|
+
export interface StaticSiteBuildProperties {
|
|
2393
|
+
/** The path to the app code within the repository. */
|
|
2394
|
+
appLocation?: string;
|
|
2395
|
+
/** The path to the api code within the repository. */
|
|
2396
|
+
apiLocation?: string;
|
|
2397
|
+
/** Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) */
|
|
2398
|
+
appArtifactLocation?: string;
|
|
2399
|
+
/** The output path of the app after building. */
|
|
2400
|
+
outputLocation?: string;
|
|
2401
|
+
/** A custom command to run during deployment of the static content application. */
|
|
2402
|
+
appBuildCommand?: string;
|
|
2403
|
+
/** A custom command to run during deployment of the Azure Functions API application. */
|
|
2404
|
+
apiBuildCommand?: string;
|
|
2405
|
+
/** Skip Github Action workflow generation. */
|
|
2406
|
+
skipGithubActionWorkflowGeneration?: boolean;
|
|
2407
|
+
/** Github Action secret name override. */
|
|
2408
|
+
githubActionSecretNameOverride?: string;
|
|
2409
|
+
}
|
|
2410
|
+
/** Preview for the Static Site Workflow to be generated */
|
|
2411
|
+
export interface StaticSitesWorkflowPreview extends ProxyOnlyResource {
|
|
2412
|
+
/** StaticSitesWorkflowPreview resource specific properties */
|
|
2413
|
+
properties?: StaticSitesWorkflowPreviewProperties;
|
|
2414
|
+
}
|
|
2415
|
+
/** StaticSitesWorkflowPreview resource specific properties */
|
|
2416
|
+
export interface StaticSitesWorkflowPreviewProperties {
|
|
2417
|
+
}
|
|
2418
|
+
/** Static Site ARM resource. */
|
|
2419
|
+
export interface StaticSiteARMResource extends Resource {
|
|
2420
|
+
/** Core resource properties */
|
|
2421
|
+
properties?: StaticSite;
|
|
2422
|
+
/** Description of a SKU for a scalable resource. */
|
|
2423
|
+
sku?: SkuDescription;
|
|
2424
|
+
/** Managed service identity. */
|
|
2425
|
+
identity?: ManagedServiceIdentity;
|
|
2426
|
+
}
|
|
2427
|
+
/** A static site. */
|
|
2428
|
+
export interface StaticSite {
|
|
2429
|
+
/** URL for the repository of the static site. */
|
|
2430
|
+
repositoryUrl?: string;
|
|
2431
|
+
/** The target branch in the repository. */
|
|
2432
|
+
branch?: string;
|
|
2433
|
+
/** A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. */
|
|
2434
|
+
repositoryToken?: string;
|
|
2435
|
+
/** Build properties to configure on the repository. */
|
|
2436
|
+
buildProperties?: StaticSiteBuildProperties;
|
|
2437
|
+
/** State indicating whether staging environments are allowed or not allowed for a static web app. */
|
|
2438
|
+
stagingEnvironmentPolicy?: "Enabled" | "Disabled";
|
|
2439
|
+
/** <code>false</code> if config file is locked for this static web app; otherwise, <code>true</code>. */
|
|
2440
|
+
allowConfigFileUpdates?: boolean;
|
|
2441
|
+
/** Template options for generating a new repository. */
|
|
2442
|
+
templateProperties?: StaticSiteTemplateOptions;
|
|
2443
|
+
/** The provider that submitted the last deployment to the primary environment of the static site. */
|
|
2444
|
+
provider?: string;
|
|
2445
|
+
/** State indicating the status of the enterprise grade CDN serving traffic to the static web app. */
|
|
2446
|
+
enterpriseGradeCdnStatus?: "Enabled" | "Enabling" | "Disabled" | "Disabling";
|
|
2447
|
+
}
|
|
2448
|
+
/** Message envelope that contains the common Azure resource manager properties and the resource provider specific content. */
|
|
2449
|
+
export interface ResponseMessageEnvelopeRemotePrivateEndpointConnection {
|
|
2450
|
+
/**
|
|
2451
|
+
* Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this
|
|
2452
|
+
* value for GET requests only.
|
|
2453
|
+
* For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}
|
|
2454
|
+
*/
|
|
2455
|
+
id?: string;
|
|
2456
|
+
/** Name of resource. */
|
|
2457
|
+
name?: string;
|
|
2458
|
+
/** Type of resource e.g "Microsoft.Web/sites". */
|
|
2459
|
+
type?: string;
|
|
2460
|
+
/** Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. */
|
|
2461
|
+
location?: string;
|
|
2462
|
+
/** Tags associated with resource. */
|
|
2463
|
+
tags?: Record<string, string>;
|
|
2464
|
+
/** Azure resource manager plan. */
|
|
2465
|
+
plan?: ArmPlan;
|
|
2466
|
+
/** Resource specific properties. */
|
|
2467
|
+
properties?: RemotePrivateEndpointConnection;
|
|
2468
|
+
/** SKU description of the resource. */
|
|
2469
|
+
sku?: SkuDescription;
|
|
2470
|
+
/** Azure-AsyncOperation Status info. */
|
|
2471
|
+
status?: string;
|
|
2472
|
+
/** Azure-AsyncOperation Error info. */
|
|
2473
|
+
error?: ErrorEntity;
|
|
2474
|
+
/** MSI resource */
|
|
2475
|
+
identity?: ManagedServiceIdentity;
|
|
2476
|
+
/** Logical Availability Zones the service is hosted in */
|
|
2477
|
+
zones?: Array<string>;
|
|
2478
|
+
}
|
|
2479
|
+
/** The plan object in Azure Resource Manager, represents a marketplace plan. */
|
|
2480
|
+
export interface ArmPlan {
|
|
2481
|
+
/** The name. */
|
|
2482
|
+
name?: string;
|
|
2483
|
+
/** The publisher. */
|
|
2484
|
+
publisher?: string;
|
|
2485
|
+
/** The product. */
|
|
2486
|
+
product?: string;
|
|
2487
|
+
/** The promotion code. */
|
|
2488
|
+
promotionCode?: string;
|
|
2489
|
+
/** Version of product. */
|
|
2490
|
+
version?: string;
|
|
2491
|
+
}
|
|
2492
|
+
/** A remote private endpoint connection */
|
|
2493
|
+
export interface RemotePrivateEndpointConnection extends ProxyOnlyResource {
|
|
2494
|
+
/** RemotePrivateEndpointConnection resource specific properties */
|
|
2495
|
+
properties?: RemotePrivateEndpointConnectionProperties;
|
|
2496
|
+
}
|
|
2497
|
+
/** RemotePrivateEndpointConnection resource specific properties */
|
|
2498
|
+
export interface RemotePrivateEndpointConnectionProperties {
|
|
2499
|
+
/** PrivateEndpoint of a remote private endpoint connection */
|
|
2500
|
+
privateEndpoint?: ArmIdWrapper;
|
|
2501
|
+
/** The state of a private link connection */
|
|
2502
|
+
privateLinkServiceConnectionState?: PrivateLinkConnectionState;
|
|
2503
|
+
/** Private IPAddresses mapped to the remote private endpoint */
|
|
2504
|
+
ipAddresses?: Array<string>;
|
|
2505
|
+
}
|
|
2506
|
+
/** Template Options for the static site. */
|
|
2507
|
+
export interface StaticSiteTemplateOptions {
|
|
2508
|
+
/** URL of the template repository. The newly generated repository will be based on this one. */
|
|
2509
|
+
templateRepositoryUrl?: string;
|
|
2510
|
+
/** Owner of the newly generated repository. */
|
|
2511
|
+
owner?: string;
|
|
2512
|
+
/** Name of the newly generated repository. */
|
|
2513
|
+
repositoryName?: string;
|
|
2514
|
+
/** Description of the newly generated repository. */
|
|
2515
|
+
description?: string;
|
|
2516
|
+
/** Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). */
|
|
2517
|
+
isPrivate?: boolean;
|
|
2518
|
+
}
|
|
2519
|
+
/** A static site user provided function. */
|
|
2520
|
+
export interface StaticSiteUserProvidedFunctionApp extends ProxyOnlyResource {
|
|
2521
|
+
/** StaticSiteUserProvidedFunctionApp resource specific properties */
|
|
2522
|
+
properties?: StaticSiteUserProvidedFunctionAppProperties;
|
|
2523
|
+
}
|
|
2524
|
+
/** StaticSiteUserProvidedFunctionApp resource specific properties */
|
|
2525
|
+
export interface StaticSiteUserProvidedFunctionAppProperties {
|
|
2526
|
+
/** The resource id of the function app registered with the static site */
|
|
2527
|
+
functionAppResourceId?: string;
|
|
2528
|
+
/** The region of the function app registered with the static site */
|
|
2529
|
+
functionAppRegion?: string;
|
|
2530
|
+
}
|
|
2531
|
+
/** ARM resource for a static site when patching */
|
|
2532
|
+
export interface StaticSitePatchResource extends ProxyOnlyResource {
|
|
2533
|
+
/** Core resource properties */
|
|
2534
|
+
properties?: StaticSite;
|
|
2535
|
+
}
|
|
2536
|
+
/** Static Site User ARM resource. */
|
|
2537
|
+
export interface StaticSiteUserARMResource extends ProxyOnlyResource {
|
|
2538
|
+
/** StaticSiteUserARMResource resource specific properties */
|
|
2539
|
+
properties?: StaticSiteUserARMResourceProperties;
|
|
2540
|
+
}
|
|
2541
|
+
/** StaticSiteUserARMResource resource specific properties */
|
|
2542
|
+
export interface StaticSiteUserARMResourceProperties {
|
|
2543
|
+
/** The roles for the static site user, in free-form string format */
|
|
2544
|
+
roles?: string;
|
|
2545
|
+
}
|
|
2546
|
+
/** Static Site Build ARM resource. */
|
|
2547
|
+
export interface StaticSiteBuildARMResource extends ProxyOnlyResource {
|
|
2548
|
+
/** StaticSiteBuildARMResource resource specific properties */
|
|
2549
|
+
properties?: StaticSiteBuildARMResourceProperties;
|
|
2550
|
+
}
|
|
2551
|
+
/** StaticSiteBuildARMResource resource specific properties */
|
|
2552
|
+
export interface StaticSiteBuildARMResourceProperties {
|
|
2553
|
+
}
|
|
2554
|
+
/** String dictionary resource. */
|
|
2555
|
+
export interface StringDictionary extends ProxyOnlyResource {
|
|
2556
|
+
/** Settings. */
|
|
2557
|
+
properties?: Record<string, string>;
|
|
2558
|
+
}
|
|
2559
|
+
/** Static Site Function Overview ARM resource. */
|
|
2560
|
+
export interface StaticSiteFunctionOverviewARMResource extends ProxyOnlyResource {
|
|
2561
|
+
/** StaticSiteFunctionOverviewARMResource resource specific properties */
|
|
2562
|
+
properties?: StaticSiteFunctionOverviewARMResourceProperties;
|
|
2563
|
+
}
|
|
2564
|
+
/** StaticSiteFunctionOverviewARMResource resource specific properties */
|
|
2565
|
+
export interface StaticSiteFunctionOverviewARMResourceProperties {
|
|
2566
|
+
}
|
|
2567
|
+
/** Static Site User Provided Function App ARM resource. */
|
|
2568
|
+
export interface StaticSiteUserProvidedFunctionAppARMResource extends ProxyOnlyResource {
|
|
2569
|
+
/** StaticSiteUserProvidedFunctionAppARMResource resource specific properties */
|
|
2570
|
+
properties?: StaticSiteUserProvidedFunctionAppARMResourceProperties;
|
|
2571
|
+
}
|
|
2572
|
+
/** StaticSiteUserProvidedFunctionAppARMResource resource specific properties */
|
|
2573
|
+
export interface StaticSiteUserProvidedFunctionAppARMResourceProperties {
|
|
2574
|
+
/** The resource id of the function app registered with the static site */
|
|
2575
|
+
functionAppResourceId?: string;
|
|
2576
|
+
/** The region of the function app registered with the static site */
|
|
2577
|
+
functionAppRegion?: string;
|
|
2578
|
+
}
|
|
2579
|
+
/** Static site zip deployment ARM resource. */
|
|
2580
|
+
export interface StaticSiteZipDeploymentARMResource extends ProxyOnlyResource {
|
|
2581
|
+
/** Core resource properties */
|
|
2582
|
+
properties?: StaticSiteZipDeployment;
|
|
2583
|
+
}
|
|
2584
|
+
/** A static site zip deployment. */
|
|
2585
|
+
export interface StaticSiteZipDeployment {
|
|
2586
|
+
/** URL for the zipped app content */
|
|
2587
|
+
appZipUrl?: string;
|
|
2588
|
+
/** URL for the zipped api content */
|
|
2589
|
+
apiZipUrl?: string;
|
|
2590
|
+
/** A title to label the deployment */
|
|
2591
|
+
deploymentTitle?: string;
|
|
2592
|
+
/** The provider submitting this deployment */
|
|
2593
|
+
provider?: string;
|
|
2594
|
+
/** The language of the api content, if it exists */
|
|
2595
|
+
functionLanguage?: string;
|
|
2596
|
+
}
|
|
2597
|
+
/** Static sites user roles invitation resource. */
|
|
2598
|
+
export interface StaticSiteUserInvitationRequestResource extends ProxyOnlyResource {
|
|
2599
|
+
/** StaticSiteUserInvitationRequestResource resource specific properties */
|
|
2600
|
+
properties?: StaticSiteUserInvitationRequestResourceProperties;
|
|
2601
|
+
}
|
|
2602
|
+
/** StaticSiteUserInvitationRequestResource resource specific properties */
|
|
2603
|
+
export interface StaticSiteUserInvitationRequestResourceProperties {
|
|
2604
|
+
/** The domain name for the static site custom domain. */
|
|
2605
|
+
domain?: string;
|
|
2606
|
+
/** The identity provider for the static site user. */
|
|
2607
|
+
provider?: string;
|
|
2608
|
+
/** The user id for the static site user. */
|
|
2609
|
+
userDetails?: string;
|
|
2610
|
+
/** The roles for the static site user, in free-form string format */
|
|
2611
|
+
roles?: string;
|
|
2612
|
+
/** The number of hours the sas token stays valid */
|
|
2613
|
+
numHoursToExpiration?: number;
|
|
2614
|
+
}
|
|
2615
|
+
/** Static sites user roles invitation link resource. */
|
|
2616
|
+
export interface StaticSiteUserInvitationResponseResource extends ProxyOnlyResource {
|
|
2617
|
+
/** StaticSiteUserInvitationResponseResource resource specific properties */
|
|
2618
|
+
properties?: StaticSiteUserInvitationResponseResourceProperties;
|
|
2619
|
+
}
|
|
2620
|
+
/** StaticSiteUserInvitationResponseResource resource specific properties */
|
|
2621
|
+
export interface StaticSiteUserInvitationResponseResourceProperties {
|
|
2622
|
+
}
|
|
2623
|
+
/** Static Site Custom Domain Overview ARM resource. */
|
|
2624
|
+
export interface StaticSiteCustomDomainOverviewARMResource extends ProxyOnlyResource {
|
|
2625
|
+
/** StaticSiteCustomDomainOverviewARMResource resource specific properties */
|
|
2626
|
+
properties?: StaticSiteCustomDomainOverviewARMResourceProperties;
|
|
2627
|
+
}
|
|
2628
|
+
/** StaticSiteCustomDomainOverviewARMResource resource specific properties */
|
|
2629
|
+
export interface StaticSiteCustomDomainOverviewARMResourceProperties {
|
|
2630
|
+
}
|
|
2631
|
+
/** Static Site Custom Domain Request Properties ARM resource. */
|
|
2632
|
+
export interface StaticSiteCustomDomainRequestPropertiesARMResource extends ProxyOnlyResource {
|
|
2633
|
+
/** StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties */
|
|
2634
|
+
properties?: StaticSiteCustomDomainRequestPropertiesARMResourceProperties;
|
|
2635
|
+
}
|
|
2636
|
+
/** StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties */
|
|
2637
|
+
export interface StaticSiteCustomDomainRequestPropertiesARMResourceProperties {
|
|
2638
|
+
/** Validation method for adding a custom domain */
|
|
2639
|
+
validationMethod?: string;
|
|
2640
|
+
}
|
|
2641
|
+
/** String list resource. */
|
|
2642
|
+
export interface StringList extends ProxyOnlyResource {
|
|
2643
|
+
/** List of string resources. */
|
|
2644
|
+
properties?: Array<string>;
|
|
2645
|
+
}
|
|
2646
|
+
/** Static Site Reset Properties ARM resource. */
|
|
2647
|
+
export interface StaticSiteResetPropertiesARMResource extends ProxyOnlyResource {
|
|
2648
|
+
/** StaticSiteResetPropertiesARMResource resource specific properties */
|
|
2649
|
+
properties?: StaticSiteResetPropertiesARMResourceProperties;
|
|
2650
|
+
}
|
|
2651
|
+
/** StaticSiteResetPropertiesARMResource resource specific properties */
|
|
2652
|
+
export interface StaticSiteResetPropertiesARMResourceProperties {
|
|
2653
|
+
/** The token which proves admin privileges to the repository. */
|
|
2654
|
+
repositoryToken?: string;
|
|
2655
|
+
/** Determines whether the repository should be updated with the new properties. */
|
|
2656
|
+
shouldUpdateRepository?: boolean;
|
|
2657
|
+
}
|
|
2658
|
+
/** ARM resource for a site. */
|
|
2659
|
+
export interface SitePatchResource extends ProxyOnlyResource {
|
|
2660
|
+
/** SitePatchResource resource specific properties */
|
|
2661
|
+
properties?: SitePatchResourceProperties;
|
|
2662
|
+
/** Managed service identity. */
|
|
2663
|
+
identity?: ManagedServiceIdentity;
|
|
2664
|
+
}
|
|
2665
|
+
/** SitePatchResource resource specific properties */
|
|
2666
|
+
export interface SitePatchResourceProperties {
|
|
2667
|
+
/** <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). */
|
|
2668
|
+
enabled?: boolean;
|
|
2669
|
+
/** Hostname SSL states are used to manage the SSL bindings for app's hostnames. */
|
|
2670
|
+
hostNameSslStates?: Array<HostNameSslState>;
|
|
2671
|
+
/** Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". */
|
|
2672
|
+
serverFarmId?: string;
|
|
2673
|
+
/** <code>true</code> if reserved; otherwise, <code>false</code>. */
|
|
2674
|
+
reserved?: boolean;
|
|
2675
|
+
/** Obsolete: Hyper-V sandbox. */
|
|
2676
|
+
isXenon?: boolean;
|
|
2677
|
+
/** Hyper-V sandbox. */
|
|
2678
|
+
hyperV?: boolean;
|
|
2679
|
+
/** Configuration of the app. */
|
|
2680
|
+
siteConfig?: SiteConfig;
|
|
2681
|
+
/** <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. */
|
|
2682
|
+
scmSiteAlsoStopped?: boolean;
|
|
2683
|
+
/** App Service Environment to use for the app. */
|
|
2684
|
+
hostingEnvironmentProfile?: HostingEnvironmentProfile;
|
|
2685
|
+
/** <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. */
|
|
2686
|
+
clientAffinityEnabled?: boolean;
|
|
2687
|
+
/** <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. */
|
|
2688
|
+
clientCertEnabled?: boolean;
|
|
2689
|
+
/**
|
|
2690
|
+
* This composes with ClientCertEnabled setting.
|
|
2691
|
+
* - ClientCertEnabled: false means ClientCert is ignored.
|
|
2692
|
+
* - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
|
|
2693
|
+
* - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.
|
|
2694
|
+
*/
|
|
2695
|
+
clientCertMode?: "Required" | "Optional" | "OptionalInteractiveUser";
|
|
2696
|
+
/** client certificate authentication comma-separated exclusion paths */
|
|
2697
|
+
clientCertExclusionPaths?: string;
|
|
2698
|
+
/**
|
|
2699
|
+
* <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.
|
|
2700
|
+
* If <code>true</code>, the app is only accessible via API management process.
|
|
2701
|
+
*/
|
|
2702
|
+
hostNamesDisabled?: boolean;
|
|
2703
|
+
/** Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. */
|
|
2704
|
+
customDomainVerificationId?: string;
|
|
2705
|
+
/** Size of the function container. */
|
|
2706
|
+
containerSize?: number;
|
|
2707
|
+
/** Maximum allowed daily memory-time quota (applicable on dynamic apps only). */
|
|
2708
|
+
dailyMemoryTimeQuota?: number;
|
|
2709
|
+
/** If specified during app creation, the app is cloned from a source app. */
|
|
2710
|
+
cloningInfo?: CloningInfo;
|
|
2711
|
+
/**
|
|
2712
|
+
* HttpsOnly: configures a web site to accept only https requests. Issues redirect for
|
|
2713
|
+
* http requests
|
|
2714
|
+
*/
|
|
2715
|
+
httpsOnly?: boolean;
|
|
2716
|
+
/** Site redundancy mode */
|
|
2717
|
+
redundancyMode?: "None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant";
|
|
2718
|
+
/** Checks if Customer provided storage account is required */
|
|
2719
|
+
storageAccountRequired?: boolean;
|
|
2720
|
+
/** Identity to use for Key Vault Reference authentication. */
|
|
2721
|
+
keyVaultReferenceIdentity?: string;
|
|
2722
|
+
/**
|
|
2723
|
+
* Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.
|
|
2724
|
+
* This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}
|
|
2725
|
+
*/
|
|
2726
|
+
virtualNetworkSubnetId?: string;
|
|
2727
|
+
}
|
|
2728
|
+
/** Custom domain analysis. */
|
|
2729
|
+
export interface CustomHostnameAnalysisResult extends ProxyOnlyResource {
|
|
2730
|
+
/** CustomHostnameAnalysisResult resource specific properties */
|
|
2731
|
+
properties?: CustomHostnameAnalysisResultProperties;
|
|
2732
|
+
}
|
|
2733
|
+
/** CustomHostnameAnalysisResult resource specific properties */
|
|
2734
|
+
export interface CustomHostnameAnalysisResultProperties {
|
|
2735
|
+
/** CName records controller can see for this hostname. */
|
|
2736
|
+
cNameRecords?: Array<string>;
|
|
2737
|
+
/** TXT records controller can see for this hostname. */
|
|
2738
|
+
txtRecords?: Array<string>;
|
|
2739
|
+
/** A records controller can see for this hostname. */
|
|
2740
|
+
aRecords?: Array<string>;
|
|
2741
|
+
/** Alternate CName records controller can see for this hostname. */
|
|
2742
|
+
alternateCNameRecords?: Array<string>;
|
|
2743
|
+
/** Alternate TXT records controller can see for this hostname. */
|
|
2744
|
+
alternateTxtRecords?: Array<string>;
|
|
2745
|
+
}
|
|
2746
|
+
/** Deployment slot parameters. */
|
|
2747
|
+
export interface CsmSlotEntity {
|
|
2748
|
+
/** Destination deployment slot during swap operation. */
|
|
2749
|
+
targetSlot: string;
|
|
2750
|
+
/** <code>true</code> to preserve Virtual Network to the slot during swap; otherwise, <code>false</code>. */
|
|
2751
|
+
preserveVnet: boolean;
|
|
2752
|
+
}
|
|
2753
|
+
/** Description of a backup which will be performed. */
|
|
2754
|
+
export interface BackupRequest extends ProxyOnlyResource {
|
|
2755
|
+
/** BackupRequest resource specific properties */
|
|
2756
|
+
properties?: BackupRequestProperties;
|
|
2757
|
+
}
|
|
2758
|
+
/** BackupRequest resource specific properties */
|
|
2759
|
+
export interface BackupRequestProperties {
|
|
2760
|
+
/** Name of the backup. */
|
|
2761
|
+
backupName?: string;
|
|
2762
|
+
/** True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. */
|
|
2763
|
+
enabled?: boolean;
|
|
2764
|
+
/** SAS URL to the container. */
|
|
2765
|
+
storageAccountUrl: string;
|
|
2766
|
+
/** Schedule for the backup if it is executed periodically. */
|
|
2767
|
+
backupSchedule?: BackupSchedule;
|
|
2768
|
+
/** Databases included in the backup. */
|
|
2769
|
+
databases?: Array<DatabaseBackupSetting>;
|
|
2770
|
+
}
|
|
2771
|
+
/** Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. */
|
|
2772
|
+
export interface BackupSchedule {
|
|
2773
|
+
/** How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) */
|
|
2774
|
+
frequencyInterval: number;
|
|
2775
|
+
/** The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) */
|
|
2776
|
+
frequencyUnit: "Day" | "Hour";
|
|
2777
|
+
/** True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. */
|
|
2778
|
+
keepAtLeastOneBackup: boolean;
|
|
2779
|
+
/** After how many days backups should be deleted. */
|
|
2780
|
+
retentionPeriodInDays: number;
|
|
2781
|
+
/** When the schedule should start working. */
|
|
2782
|
+
startTime?: Date | string;
|
|
2783
|
+
}
|
|
2784
|
+
/** Database backup settings. */
|
|
2785
|
+
export interface DatabaseBackupSetting {
|
|
2786
|
+
/** Database type (e.g. SqlAzure / MySql). */
|
|
2787
|
+
databaseType: "SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql";
|
|
2788
|
+
name?: string;
|
|
2789
|
+
/**
|
|
2790
|
+
* Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.
|
|
2791
|
+
* This is used during restore with overwrite connection strings options.
|
|
2792
|
+
*/
|
|
2793
|
+
connectionStringName?: string;
|
|
2794
|
+
/** Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. */
|
|
2795
|
+
connectionString?: string;
|
|
2796
|
+
}
|
|
2797
|
+
/** Backup description. */
|
|
2798
|
+
export interface BackupItem extends ProxyOnlyResource {
|
|
2799
|
+
/** BackupItem resource specific properties */
|
|
2800
|
+
properties?: BackupItemProperties;
|
|
2801
|
+
}
|
|
2802
|
+
/** BackupItem resource specific properties */
|
|
2803
|
+
export interface BackupItemProperties {
|
|
2804
|
+
}
|
|
2805
|
+
/** Description of a restore request. */
|
|
2806
|
+
export interface RestoreRequest extends ProxyOnlyResource {
|
|
2807
|
+
/** RestoreRequest resource specific properties */
|
|
2808
|
+
properties?: RestoreRequestProperties;
|
|
2809
|
+
}
|
|
2810
|
+
/** RestoreRequest resource specific properties */
|
|
2811
|
+
export interface RestoreRequestProperties {
|
|
2812
|
+
/** SAS URL to the container. */
|
|
2813
|
+
storageAccountUrl: string;
|
|
2814
|
+
/** Name of a blob which contains the backup. */
|
|
2815
|
+
blobName?: string;
|
|
2816
|
+
/** <code>true</code> if the restore operation can overwrite target app; otherwise, <code>false</code>. <code>true</code> is needed if trying to restore over an existing app. */
|
|
2817
|
+
overwrite: boolean;
|
|
2818
|
+
/** Name of an app. */
|
|
2819
|
+
siteName?: string;
|
|
2820
|
+
/** Collection of databases which should be restored. This list has to match the list of databases included in the backup. */
|
|
2821
|
+
databases?: Array<DatabaseBackupSetting>;
|
|
2822
|
+
/**
|
|
2823
|
+
* Changes a logic when restoring an app with custom domains. <code>true</code> to remove custom domains automatically. If <code>false</code>, custom domains are added to
|
|
2824
|
+
* the app's object when it is being restored, but that might fail due to conflicts during the operation.
|
|
2825
|
+
*/
|
|
2826
|
+
ignoreConflictingHostNames?: boolean;
|
|
2827
|
+
/** Ignore the databases and only restore the site content */
|
|
2828
|
+
ignoreDatabases?: boolean;
|
|
2829
|
+
/** Specify app service plan that will own restored site. */
|
|
2830
|
+
appServicePlan?: string;
|
|
2831
|
+
/** Operation type. */
|
|
2832
|
+
operationType?: "Default" | "Clone" | "Relocation" | "Snapshot" | "CloudFS";
|
|
2833
|
+
/** <code>true</code> if SiteConfig.ConnectionStrings should be set in new app; otherwise, <code>false</code>. */
|
|
2834
|
+
adjustConnectionStrings?: boolean;
|
|
2835
|
+
/** App Service Environment name, if needed (only when restoring an app to an App Service Environment). */
|
|
2836
|
+
hostingEnvironment?: string;
|
|
2837
|
+
}
|
|
2838
|
+
/** Publishing Credentials Policies parameters. */
|
|
2839
|
+
export interface CsmPublishingCredentialsPoliciesEntity extends ProxyOnlyResource {
|
|
2840
|
+
/** CsmPublishingCredentialsPoliciesEntity resource specific properties */
|
|
2841
|
+
properties?: CsmPublishingCredentialsPoliciesEntityProperties;
|
|
2842
|
+
}
|
|
2843
|
+
/** CsmPublishingCredentialsPoliciesEntity resource specific properties */
|
|
2844
|
+
export interface CsmPublishingCredentialsPoliciesEntityProperties {
|
|
2845
|
+
/** <code>true</code> to allow access to a publishing method; otherwise, <code>false</code>. */
|
|
2846
|
+
allow: boolean;
|
|
2847
|
+
}
|
|
2848
|
+
/** Web app configuration ARM resource. */
|
|
2849
|
+
export interface SiteConfigResource extends ProxyOnlyResource {
|
|
2850
|
+
/** Core resource properties */
|
|
2851
|
+
properties?: SiteConfig;
|
|
2852
|
+
}
|
|
2853
|
+
/** Configuration settings for the Azure App Service Authentication / Authorization feature. */
|
|
2854
|
+
export interface SiteAuthSettings extends ProxyOnlyResource {
|
|
2855
|
+
/** SiteAuthSettings resource specific properties */
|
|
2856
|
+
properties?: SiteAuthSettingsProperties;
|
|
2857
|
+
}
|
|
2858
|
+
/** SiteAuthSettings resource specific properties */
|
|
2859
|
+
export interface SiteAuthSettingsProperties {
|
|
2860
|
+
/** <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>. */
|
|
2861
|
+
enabled?: boolean;
|
|
2862
|
+
/**
|
|
2863
|
+
* The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
|
|
2864
|
+
* The setting in this value can control the behavior of certain features in the Authentication / Authorization module.
|
|
2865
|
+
*/
|
|
2866
|
+
runtimeVersion?: string;
|
|
2867
|
+
/** The action to take when an unauthenticated client attempts to access the app. */
|
|
2868
|
+
unauthenticatedClientAction?: "RedirectToLoginPage" | "AllowAnonymous";
|
|
2869
|
+
/**
|
|
2870
|
+
* <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>.
|
|
2871
|
+
* The default is <code>false</code>.
|
|
2872
|
+
*/
|
|
2873
|
+
tokenStoreEnabled?: boolean;
|
|
2874
|
+
/**
|
|
2875
|
+
* External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.
|
|
2876
|
+
* This is an advanced setting typically only needed by Windows Store application backends.
|
|
2877
|
+
* Note that URLs within the current domain are always implicitly allowed.
|
|
2878
|
+
*/
|
|
2879
|
+
allowedExternalRedirectUrls?: Array<string>;
|
|
2880
|
+
/**
|
|
2881
|
+
* The default authentication provider to use when multiple providers are configured.
|
|
2882
|
+
* This setting is only needed if multiple providers are configured and the unauthenticated client
|
|
2883
|
+
* action is set to "RedirectToLoginPage".
|
|
2884
|
+
*/
|
|
2885
|
+
defaultProvider?: "AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter" | "Github";
|
|
2886
|
+
/**
|
|
2887
|
+
* The number of hours after session token expiration that a session token can be used to
|
|
2888
|
+
* call the token refresh API. The default is 72 hours.
|
|
2889
|
+
*/
|
|
2890
|
+
tokenRefreshExtensionHours?: number;
|
|
2891
|
+
/**
|
|
2892
|
+
* The Client ID of this relying party application, known as the client_id.
|
|
2893
|
+
* This setting is required for enabling OpenID Connection authentication with Azure Active Directory or
|
|
2894
|
+
* other 3rd party OpenID Connect providers.
|
|
2895
|
+
* More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
|
|
2896
|
+
*/
|
|
2897
|
+
clientId?: string;
|
|
2898
|
+
/**
|
|
2899
|
+
* The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).
|
|
2900
|
+
* This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.
|
|
2901
|
+
* Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.
|
|
2902
|
+
* More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
|
|
2903
|
+
*/
|
|
2904
|
+
clientSecret?: string;
|
|
2905
|
+
/** The app setting name that contains the client secret of the relying party application. */
|
|
2906
|
+
clientSecretSettingName?: string;
|
|
2907
|
+
/**
|
|
2908
|
+
* An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as
|
|
2909
|
+
* a replacement for the Client Secret. It is also optional.
|
|
2910
|
+
*/
|
|
2911
|
+
clientSecretCertificateThumbprint?: string;
|
|
2912
|
+
/**
|
|
2913
|
+
* The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
|
|
2914
|
+
* When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
|
|
2915
|
+
* This URI is a case-sensitive identifier for the token issuer.
|
|
2916
|
+
* More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
|
|
2917
|
+
*/
|
|
2918
|
+
issuer?: string;
|
|
2919
|
+
/** Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. */
|
|
2920
|
+
validateIssuer?: boolean;
|
|
2921
|
+
/**
|
|
2922
|
+
* Allowed audience values to consider when validating JWTs issued by
|
|
2923
|
+
* Azure Active Directory. Note that the <code>ClientID</code> value is always considered an
|
|
2924
|
+
* allowed audience, regardless of this setting.
|
|
2925
|
+
*/
|
|
2926
|
+
allowedAudiences?: Array<string>;
|
|
2927
|
+
/**
|
|
2928
|
+
* Login parameters to send to the OpenID Connect authorization endpoint when
|
|
2929
|
+
* a user logs in. Each parameter must be in the form "key=value".
|
|
2930
|
+
*/
|
|
2931
|
+
additionalLoginParams?: Array<string>;
|
|
2932
|
+
/** Gets a JSON string containing the Azure AD Acl settings. */
|
|
2933
|
+
aadClaimsAuthorization?: string;
|
|
2934
|
+
/**
|
|
2935
|
+
* The OpenID Connect Client ID for the Google web application.
|
|
2936
|
+
* This setting is required for enabling Google Sign-In.
|
|
2937
|
+
* Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
|
|
2938
|
+
*/
|
|
2939
|
+
googleClientId?: string;
|
|
2940
|
+
/**
|
|
2941
|
+
* The client secret associated with the Google web application.
|
|
2942
|
+
* This setting is required for enabling Google Sign-In.
|
|
2943
|
+
* Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
|
|
2944
|
+
*/
|
|
2945
|
+
googleClientSecret?: string;
|
|
2946
|
+
/**
|
|
2947
|
+
* The app setting name that contains the client secret associated with
|
|
2948
|
+
* the Google web application.
|
|
2949
|
+
*/
|
|
2950
|
+
googleClientSecretSettingName?: string;
|
|
2951
|
+
/**
|
|
2952
|
+
* The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
|
|
2953
|
+
* This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes.
|
|
2954
|
+
* Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
|
|
2955
|
+
*/
|
|
2956
|
+
googleOAuthScopes?: Array<string>;
|
|
2957
|
+
/**
|
|
2958
|
+
* The App ID of the Facebook app used for login.
|
|
2959
|
+
* This setting is required for enabling Facebook Login.
|
|
2960
|
+
* Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
|
|
2961
|
+
*/
|
|
2962
|
+
facebookAppId?: string;
|
|
2963
|
+
/**
|
|
2964
|
+
* The App Secret of the Facebook app used for Facebook Login.
|
|
2965
|
+
* This setting is required for enabling Facebook Login.
|
|
2966
|
+
* Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
|
|
2967
|
+
*/
|
|
2968
|
+
facebookAppSecret?: string;
|
|
2969
|
+
/** The app setting name that contains the app secret used for Facebook Login. */
|
|
2970
|
+
facebookAppSecretSettingName?: string;
|
|
2971
|
+
/**
|
|
2972
|
+
* The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
|
|
2973
|
+
* This setting is optional.
|
|
2974
|
+
* Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
|
|
2975
|
+
*/
|
|
2976
|
+
facebookOAuthScopes?: Array<string>;
|
|
2977
|
+
/**
|
|
2978
|
+
* The Client Id of the GitHub app used for login.
|
|
2979
|
+
* This setting is required for enabling Github login
|
|
2980
|
+
*/
|
|
2981
|
+
gitHubClientId?: string;
|
|
2982
|
+
/**
|
|
2983
|
+
* The Client Secret of the GitHub app used for Github Login.
|
|
2984
|
+
* This setting is required for enabling Github login.
|
|
2985
|
+
*/
|
|
2986
|
+
gitHubClientSecret?: string;
|
|
2987
|
+
/**
|
|
2988
|
+
* The app setting name that contains the client secret of the Github
|
|
2989
|
+
* app used for GitHub Login.
|
|
2990
|
+
*/
|
|
2991
|
+
gitHubClientSecretSettingName?: string;
|
|
2992
|
+
/**
|
|
2993
|
+
* The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
|
|
2994
|
+
* This setting is optional
|
|
2995
|
+
*/
|
|
2996
|
+
gitHubOAuthScopes?: Array<string>;
|
|
2997
|
+
/**
|
|
2998
|
+
* The OAuth 1.0a consumer key of the Twitter application used for sign-in.
|
|
2999
|
+
* This setting is required for enabling Twitter Sign-In.
|
|
3000
|
+
* Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
|
|
3001
|
+
*/
|
|
3002
|
+
twitterConsumerKey?: string;
|
|
3003
|
+
/**
|
|
3004
|
+
* The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
|
|
3005
|
+
* This setting is required for enabling Twitter Sign-In.
|
|
3006
|
+
* Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
|
|
3007
|
+
*/
|
|
3008
|
+
twitterConsumerSecret?: string;
|
|
3009
|
+
/**
|
|
3010
|
+
* The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
|
|
3011
|
+
* application used for sign-in.
|
|
3012
|
+
*/
|
|
3013
|
+
twitterConsumerSecretSettingName?: string;
|
|
3014
|
+
/**
|
|
3015
|
+
* The OAuth 2.0 client ID that was created for the app used for authentication.
|
|
3016
|
+
* This setting is required for enabling Microsoft Account authentication.
|
|
3017
|
+
* Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
|
|
3018
|
+
*/
|
|
3019
|
+
microsoftAccountClientId?: string;
|
|
3020
|
+
/**
|
|
3021
|
+
* The OAuth 2.0 client secret that was created for the app used for authentication.
|
|
3022
|
+
* This setting is required for enabling Microsoft Account authentication.
|
|
3023
|
+
* Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
|
|
3024
|
+
*/
|
|
3025
|
+
microsoftAccountClientSecret?: string;
|
|
3026
|
+
/**
|
|
3027
|
+
* The app setting name containing the OAuth 2.0 client secret that was created for the
|
|
3028
|
+
* app used for authentication.
|
|
3029
|
+
*/
|
|
3030
|
+
microsoftAccountClientSecretSettingName?: string;
|
|
3031
|
+
/**
|
|
3032
|
+
* The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
|
|
3033
|
+
* This setting is optional. If not specified, "wl.basic" is used as the default scope.
|
|
3034
|
+
* Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx
|
|
3035
|
+
*/
|
|
3036
|
+
microsoftAccountOAuthScopes?: Array<string>;
|
|
3037
|
+
/**
|
|
3038
|
+
* "true" if the auth config settings should be read from a file,
|
|
3039
|
+
* "false" otherwise
|
|
3040
|
+
*/
|
|
3041
|
+
isAuthFromFile?: string;
|
|
3042
|
+
/**
|
|
3043
|
+
* The path of the config file containing auth settings.
|
|
3044
|
+
* If the path is relative, base will the site's root directory.
|
|
3045
|
+
*/
|
|
3046
|
+
authFilePath?: string;
|
|
3047
|
+
/**
|
|
3048
|
+
* The ConfigVersion of the Authentication / Authorization feature in use for the current app.
|
|
3049
|
+
* The setting in this value can control the behavior of the control plane for Authentication / Authorization.
|
|
3050
|
+
*/
|
|
3051
|
+
configVersion?: string;
|
|
3052
|
+
}
|
|
3053
|
+
/** Configuration settings for the Azure App Service Authentication / Authorization V2 feature. */
|
|
3054
|
+
export interface SiteAuthSettingsV2 extends ProxyOnlyResource {
|
|
3055
|
+
/** SiteAuthSettingsV2 resource specific properties */
|
|
3056
|
+
properties?: SiteAuthSettingsV2Properties;
|
|
3057
|
+
}
|
|
3058
|
+
/** SiteAuthSettingsV2 resource specific properties */
|
|
3059
|
+
export interface SiteAuthSettingsV2Properties {
|
|
3060
|
+
/** The configuration settings of the platform of App Service Authentication/Authorization. */
|
|
3061
|
+
platform?: AuthPlatform;
|
|
3062
|
+
/** The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. */
|
|
3063
|
+
globalValidation?: GlobalValidation;
|
|
3064
|
+
/** The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. */
|
|
3065
|
+
identityProviders?: IdentityProviders;
|
|
3066
|
+
/** The configuration settings of the login flow of users using App Service Authentication/Authorization. */
|
|
3067
|
+
login?: Login;
|
|
3068
|
+
/** The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. */
|
|
3069
|
+
httpSettings?: HttpSettings;
|
|
3070
|
+
}
|
|
3071
|
+
/** The configuration settings of the platform of App Service Authentication/Authorization. */
|
|
3072
|
+
export interface AuthPlatform {
|
|
3073
|
+
/** <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>. */
|
|
3074
|
+
enabled?: boolean;
|
|
3075
|
+
/**
|
|
3076
|
+
* The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
|
|
3077
|
+
* The setting in this value can control the behavior of certain features in the Authentication / Authorization module.
|
|
3078
|
+
*/
|
|
3079
|
+
runtimeVersion?: string;
|
|
3080
|
+
/**
|
|
3081
|
+
* The path of the config file containing auth settings if they come from a file.
|
|
3082
|
+
* If the path is relative, base will the site's root directory.
|
|
3083
|
+
*/
|
|
3084
|
+
configFilePath?: string;
|
|
3085
|
+
}
|
|
3086
|
+
/** The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. */
|
|
3087
|
+
export interface GlobalValidation {
|
|
3088
|
+
/** <code>true</code> if the authentication flow is required any request is made; otherwise, <code>false</code>. */
|
|
3089
|
+
requireAuthentication?: boolean;
|
|
3090
|
+
/** The action to take when an unauthenticated client attempts to access the app. */
|
|
3091
|
+
unauthenticatedClientAction?: "RedirectToLoginPage" | "AllowAnonymous" | "Return401" | "Return403";
|
|
3092
|
+
/**
|
|
3093
|
+
* The default authentication provider to use when multiple providers are configured.
|
|
3094
|
+
* This setting is only needed if multiple providers are configured and the unauthenticated client
|
|
3095
|
+
* action is set to "RedirectToLoginPage".
|
|
3096
|
+
*/
|
|
3097
|
+
redirectToProvider?: string;
|
|
3098
|
+
/** The paths for which unauthenticated flow would not be redirected to the login page. */
|
|
3099
|
+
excludedPaths?: Array<string>;
|
|
3100
|
+
}
|
|
3101
|
+
/** The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. */
|
|
3102
|
+
export interface IdentityProviders {
|
|
3103
|
+
/** The configuration settings of the Azure Active directory provider. */
|
|
3104
|
+
azureActiveDirectory?: AzureActiveDirectory;
|
|
3105
|
+
/** The configuration settings of the Facebook provider. */
|
|
3106
|
+
facebook?: Facebook;
|
|
3107
|
+
/** The configuration settings of the GitHub provider. */
|
|
3108
|
+
gitHub?: GitHub;
|
|
3109
|
+
/** The configuration settings of the Google provider. */
|
|
3110
|
+
google?: Google;
|
|
3111
|
+
/** The configuration settings of the legacy Microsoft Account provider. */
|
|
3112
|
+
legacyMicrosoftAccount?: LegacyMicrosoftAccount;
|
|
3113
|
+
/** The configuration settings of the Twitter provider. */
|
|
3114
|
+
twitter?: Twitter;
|
|
3115
|
+
/** The configuration settings of the Apple provider. */
|
|
3116
|
+
apple?: Apple;
|
|
3117
|
+
/** The configuration settings of the Azure Static Web Apps provider. */
|
|
3118
|
+
azureStaticWebApps?: AzureStaticWebApps;
|
|
3119
|
+
/**
|
|
3120
|
+
* The map of the name of the alias of each custom Open ID Connect provider to the
|
|
3121
|
+
* configuration settings of the custom Open ID Connect provider.
|
|
3122
|
+
*/
|
|
3123
|
+
customOpenIdConnectProviders?: Record<string, CustomOpenIdConnectProvider>;
|
|
3124
|
+
}
|
|
3125
|
+
/** The configuration settings of the Azure Active directory provider. */
|
|
3126
|
+
export interface AzureActiveDirectory {
|
|
3127
|
+
/** <code>false</code> if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, <code>true</code>. */
|
|
3128
|
+
enabled?: boolean;
|
|
3129
|
+
/** The configuration settings of the Azure Active Directory app registration. */
|
|
3130
|
+
registration?: AzureActiveDirectoryRegistration;
|
|
3131
|
+
/** The configuration settings of the Azure Active Directory login flow. */
|
|
3132
|
+
login?: AzureActiveDirectoryLogin;
|
|
3133
|
+
/** The configuration settings of the Azure Active Directory token validation flow. */
|
|
3134
|
+
validation?: AzureActiveDirectoryValidation;
|
|
3135
|
+
/**
|
|
3136
|
+
* Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.
|
|
3137
|
+
* This is an internal flag primarily intended to support the Azure Management Portal. Users should not
|
|
3138
|
+
* read or write to this property.
|
|
3139
|
+
*/
|
|
3140
|
+
isAutoProvisioned?: boolean;
|
|
3141
|
+
}
|
|
3142
|
+
/** The configuration settings of the Azure Active Directory app registration. */
|
|
3143
|
+
export interface AzureActiveDirectoryRegistration {
|
|
3144
|
+
/**
|
|
3145
|
+
* The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
|
|
3146
|
+
* When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.
|
|
3147
|
+
* This URI is a case-sensitive identifier for the token issuer.
|
|
3148
|
+
* More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
|
|
3149
|
+
*/
|
|
3150
|
+
openIdIssuer?: string;
|
|
3151
|
+
/**
|
|
3152
|
+
* The Client ID of this relying party application, known as the client_id.
|
|
3153
|
+
* This setting is required for enabling OpenID Connection authentication with Azure Active Directory or
|
|
3154
|
+
* other 3rd party OpenID Connect providers.
|
|
3155
|
+
* More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
|
|
3156
|
+
*/
|
|
3157
|
+
clientId?: string;
|
|
3158
|
+
/** The app setting name that contains the client secret of the relying party application. */
|
|
3159
|
+
clientSecretSettingName?: string;
|
|
3160
|
+
/**
|
|
3161
|
+
* An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as
|
|
3162
|
+
* a replacement for the Client Secret. It is also optional.
|
|
3163
|
+
*/
|
|
3164
|
+
clientSecretCertificateThumbprint?: string;
|
|
3165
|
+
/**
|
|
3166
|
+
* An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as
|
|
3167
|
+
* a replacement for the Client Secret Certificate Thumbprint. It is also optional.
|
|
3168
|
+
*/
|
|
3169
|
+
clientSecretCertificateSubjectAlternativeName?: string;
|
|
3170
|
+
/**
|
|
3171
|
+
* An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as
|
|
3172
|
+
* a replacement for the Client Secret Certificate Thumbprint. It is also optional.
|
|
3173
|
+
*/
|
|
3174
|
+
clientSecretCertificateIssuer?: string;
|
|
3175
|
+
}
|
|
3176
|
+
/** The configuration settings of the Azure Active Directory login flow. */
|
|
3177
|
+
export interface AzureActiveDirectoryLogin {
|
|
3178
|
+
/**
|
|
3179
|
+
* Login parameters to send to the OpenID Connect authorization endpoint when
|
|
3180
|
+
* a user logs in. Each parameter must be in the form "key=value".
|
|
3181
|
+
*/
|
|
3182
|
+
loginParameters?: Array<string>;
|
|
3183
|
+
/** <code>true</code> if the www-authenticate provider should be omitted from the request; otherwise, <code>false</code>. */
|
|
3184
|
+
disableWWWAuthenticate?: boolean;
|
|
3185
|
+
}
|
|
3186
|
+
/** The configuration settings of the Azure Active Directory token validation flow. */
|
|
3187
|
+
export interface AzureActiveDirectoryValidation {
|
|
3188
|
+
/** The configuration settings of the checks that should be made while validating the JWT Claims. */
|
|
3189
|
+
jwtClaimChecks?: JwtClaimChecks;
|
|
3190
|
+
/** The list of audiences that can make successful authentication/authorization requests. */
|
|
3191
|
+
allowedAudiences?: Array<string>;
|
|
3192
|
+
/** The configuration settings of the default authorization policy. */
|
|
3193
|
+
defaultAuthorizationPolicy?: DefaultAuthorizationPolicy;
|
|
3194
|
+
}
|
|
3195
|
+
/** The configuration settings of the checks that should be made while validating the JWT Claims. */
|
|
3196
|
+
export interface JwtClaimChecks {
|
|
3197
|
+
/** The list of the allowed groups. */
|
|
3198
|
+
allowedGroups?: Array<string>;
|
|
3199
|
+
/** The list of the allowed client applications. */
|
|
3200
|
+
allowedClientApplications?: Array<string>;
|
|
3201
|
+
}
|
|
3202
|
+
/** The configuration settings of the Azure Active Directory default authorization policy. */
|
|
3203
|
+
export interface DefaultAuthorizationPolicy {
|
|
3204
|
+
/** The configuration settings of the Azure Active Directory allowed principals. */
|
|
3205
|
+
allowedPrincipals?: AllowedPrincipals;
|
|
3206
|
+
/** The configuration settings of the Azure Active Directory allowed applications. */
|
|
3207
|
+
allowedApplications?: Array<string>;
|
|
3208
|
+
}
|
|
3209
|
+
/** The configuration settings of the Azure Active Directory allowed principals. */
|
|
3210
|
+
export interface AllowedPrincipals {
|
|
3211
|
+
/** The list of the allowed groups. */
|
|
3212
|
+
groups?: Array<string>;
|
|
3213
|
+
/** The list of the allowed identities. */
|
|
3214
|
+
identities?: Array<string>;
|
|
3215
|
+
}
|
|
3216
|
+
/** The configuration settings of the Facebook provider. */
|
|
3217
|
+
export interface Facebook {
|
|
3218
|
+
/** <code>false</code> if the Facebook provider should not be enabled despite the set registration; otherwise, <code>true</code>. */
|
|
3219
|
+
enabled?: boolean;
|
|
3220
|
+
/** The configuration settings of the app registration for the Facebook provider. */
|
|
3221
|
+
registration?: AppRegistration;
|
|
3222
|
+
/** The version of the Facebook api to be used while logging in. */
|
|
3223
|
+
graphApiVersion?: string;
|
|
3224
|
+
/** The configuration settings of the login flow. */
|
|
3225
|
+
login?: LoginScopes;
|
|
3226
|
+
}
|
|
3227
|
+
/** The configuration settings of the app registration for providers that have app ids and app secrets */
|
|
3228
|
+
export interface AppRegistration {
|
|
3229
|
+
/** The App ID of the app used for login. */
|
|
3230
|
+
appId?: string;
|
|
3231
|
+
/** The app setting name that contains the app secret. */
|
|
3232
|
+
appSecretSettingName?: string;
|
|
3233
|
+
}
|
|
3234
|
+
/** The configuration settings of the login flow, including the scopes that should be requested. */
|
|
3235
|
+
export interface LoginScopes {
|
|
3236
|
+
/** A list of the scopes that should be requested while authenticating. */
|
|
3237
|
+
scopes?: Array<string>;
|
|
3238
|
+
}
|
|
3239
|
+
/** The configuration settings of the GitHub provider. */
|
|
3240
|
+
export interface GitHub {
|
|
3241
|
+
/** <code>false</code> if the GitHub provider should not be enabled despite the set registration; otherwise, <code>true</code>. */
|
|
3242
|
+
enabled?: boolean;
|
|
3243
|
+
/** The configuration settings of the app registration for the GitHub provider. */
|
|
3244
|
+
registration?: ClientRegistration;
|
|
3245
|
+
/** The configuration settings of the login flow. */
|
|
3246
|
+
login?: LoginScopes;
|
|
3247
|
+
}
|
|
3248
|
+
/** The configuration settings of the app registration for providers that have client ids and client secrets */
|
|
3249
|
+
export interface ClientRegistration {
|
|
3250
|
+
/** The Client ID of the app used for login. */
|
|
3251
|
+
clientId?: string;
|
|
3252
|
+
/** The app setting name that contains the client secret. */
|
|
3253
|
+
clientSecretSettingName?: string;
|
|
3254
|
+
}
|
|
3255
|
+
/** The configuration settings of the Google provider. */
|
|
3256
|
+
export interface Google {
|
|
3257
|
+
/** <code>false</code> if the Google provider should not be enabled despite the set registration; otherwise, <code>true</code>. */
|
|
3258
|
+
enabled?: boolean;
|
|
3259
|
+
/** The configuration settings of the app registration for the Google provider. */
|
|
3260
|
+
registration?: ClientRegistration;
|
|
3261
|
+
/** The configuration settings of the login flow. */
|
|
3262
|
+
login?: LoginScopes;
|
|
3263
|
+
/** The configuration settings of the Azure Active Directory token validation flow. */
|
|
3264
|
+
validation?: AllowedAudiencesValidation;
|
|
3265
|
+
}
|
|
3266
|
+
/** The configuration settings of the Allowed Audiences validation flow. */
|
|
3267
|
+
export interface AllowedAudiencesValidation {
|
|
3268
|
+
/** The configuration settings of the allowed list of audiences from which to validate the JWT token. */
|
|
3269
|
+
allowedAudiences?: Array<string>;
|
|
3270
|
+
}
|
|
3271
|
+
/** The configuration settings of the legacy Microsoft Account provider. */
|
|
3272
|
+
export interface LegacyMicrosoftAccount {
|
|
3273
|
+
/** <code>false</code> if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, <code>true</code>. */
|
|
3274
|
+
enabled?: boolean;
|
|
3275
|
+
/** The configuration settings of the app registration for the legacy Microsoft Account provider. */
|
|
3276
|
+
registration?: ClientRegistration;
|
|
3277
|
+
/** The configuration settings of the login flow. */
|
|
3278
|
+
login?: LoginScopes;
|
|
3279
|
+
/** The configuration settings of the legacy Microsoft Account provider token validation flow. */
|
|
3280
|
+
validation?: AllowedAudiencesValidation;
|
|
3281
|
+
}
|
|
3282
|
+
/** The configuration settings of the Twitter provider. */
|
|
3283
|
+
export interface Twitter {
|
|
3284
|
+
/** <code>false</code> if the Twitter provider should not be enabled despite the set registration; otherwise, <code>true</code>. */
|
|
3285
|
+
enabled?: boolean;
|
|
3286
|
+
/** The configuration settings of the app registration for the Twitter provider. */
|
|
3287
|
+
registration?: TwitterRegistration;
|
|
3288
|
+
}
|
|
3289
|
+
/** The configuration settings of the app registration for the Twitter provider. */
|
|
3290
|
+
export interface TwitterRegistration {
|
|
3291
|
+
/**
|
|
3292
|
+
* The OAuth 1.0a consumer key of the Twitter application used for sign-in.
|
|
3293
|
+
* This setting is required for enabling Twitter Sign-In.
|
|
3294
|
+
* Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
|
|
3295
|
+
*/
|
|
3296
|
+
consumerKey?: string;
|
|
3297
|
+
/**
|
|
3298
|
+
* The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
|
|
3299
|
+
* application used for sign-in.
|
|
3300
|
+
*/
|
|
3301
|
+
consumerSecretSettingName?: string;
|
|
3302
|
+
}
|
|
3303
|
+
/** The configuration settings of the Apple provider. */
|
|
3304
|
+
export interface Apple {
|
|
3305
|
+
/** <code>false</code> if the Apple provider should not be enabled despite the set registration; otherwise, <code>true</code>. */
|
|
3306
|
+
enabled?: boolean;
|
|
3307
|
+
/** The configuration settings of the Apple registration. */
|
|
3308
|
+
registration?: AppleRegistration;
|
|
3309
|
+
/** The configuration settings of the login flow. */
|
|
3310
|
+
login?: LoginScopes;
|
|
3311
|
+
}
|
|
3312
|
+
/** The configuration settings of the registration for the Apple provider */
|
|
3313
|
+
export interface AppleRegistration {
|
|
3314
|
+
/** The Client ID of the app used for login. */
|
|
3315
|
+
clientId?: string;
|
|
3316
|
+
/** The app setting name that contains the client secret. */
|
|
3317
|
+
clientSecretSettingName?: string;
|
|
3318
|
+
}
|
|
3319
|
+
/** The configuration settings of the Azure Static Web Apps provider. */
|
|
3320
|
+
export interface AzureStaticWebApps {
|
|
3321
|
+
/** <code>false</code> if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, <code>true</code>. */
|
|
3322
|
+
enabled?: boolean;
|
|
3323
|
+
/** The configuration settings of the Azure Static Web Apps registration. */
|
|
3324
|
+
registration?: AzureStaticWebAppsRegistration;
|
|
3325
|
+
}
|
|
3326
|
+
/** The configuration settings of the registration for the Azure Static Web Apps provider */
|
|
3327
|
+
export interface AzureStaticWebAppsRegistration {
|
|
3328
|
+
/** The Client ID of the app used for login. */
|
|
3329
|
+
clientId?: string;
|
|
3330
|
+
}
|
|
3331
|
+
/** The configuration settings of the custom Open ID Connect provider. */
|
|
3332
|
+
export interface CustomOpenIdConnectProvider {
|
|
3333
|
+
/** <code>false</code> if the custom Open ID provider provider should not be enabled; otherwise, <code>true</code>. */
|
|
3334
|
+
enabled?: boolean;
|
|
3335
|
+
/** The configuration settings of the app registration for the custom Open ID Connect provider. */
|
|
3336
|
+
registration?: OpenIdConnectRegistration;
|
|
3337
|
+
/** The configuration settings of the login flow of the custom Open ID Connect provider. */
|
|
3338
|
+
login?: OpenIdConnectLogin;
|
|
3339
|
+
}
|
|
3340
|
+
/** The configuration settings of the app registration for the custom Open ID Connect provider. */
|
|
3341
|
+
export interface OpenIdConnectRegistration {
|
|
3342
|
+
/** The client id of the custom Open ID Connect provider. */
|
|
3343
|
+
clientId?: string;
|
|
3344
|
+
/** The authentication credentials of the custom Open ID Connect provider. */
|
|
3345
|
+
clientCredential?: OpenIdConnectClientCredential;
|
|
3346
|
+
/** The configuration settings of the endpoints used for the custom Open ID Connect provider. */
|
|
3347
|
+
openIdConnectConfiguration?: OpenIdConnectConfig;
|
|
3348
|
+
}
|
|
3349
|
+
/** The authentication client credentials of the custom Open ID Connect provider. */
|
|
3350
|
+
export interface OpenIdConnectClientCredential {
|
|
3351
|
+
/** The method that should be used to authenticate the user. */
|
|
3352
|
+
method?: "ClientSecretPost";
|
|
3353
|
+
/** The app setting that contains the client secret for the custom Open ID Connect provider. */
|
|
3354
|
+
clientSecretSettingName?: string;
|
|
3355
|
+
}
|
|
3356
|
+
/** The configuration settings of the endpoints used for the custom Open ID Connect provider. */
|
|
3357
|
+
export interface OpenIdConnectConfig {
|
|
3358
|
+
/** The endpoint to be used to make an authorization request. */
|
|
3359
|
+
authorizationEndpoint?: string;
|
|
3360
|
+
/** The endpoint to be used to request a token. */
|
|
3361
|
+
tokenEndpoint?: string;
|
|
3362
|
+
/** The endpoint that issues the token. */
|
|
3363
|
+
issuer?: string;
|
|
3364
|
+
/** The endpoint that provides the keys necessary to validate the token. */
|
|
3365
|
+
certificationUri?: string;
|
|
3366
|
+
/** The endpoint that contains all the configuration endpoints for the provider. */
|
|
3367
|
+
wellKnownOpenIdConfiguration?: string;
|
|
3368
|
+
}
|
|
3369
|
+
/** The configuration settings of the login flow of the custom Open ID Connect provider. */
|
|
3370
|
+
export interface OpenIdConnectLogin {
|
|
3371
|
+
/** The name of the claim that contains the users name. */
|
|
3372
|
+
nameClaimType?: string;
|
|
3373
|
+
/** A list of the scopes that should be requested while authenticating. */
|
|
3374
|
+
scopes?: Array<string>;
|
|
3375
|
+
}
|
|
3376
|
+
/** The configuration settings of the login flow of users using App Service Authentication/Authorization. */
|
|
3377
|
+
export interface Login {
|
|
3378
|
+
/** The routes that specify the endpoints used for login and logout requests. */
|
|
3379
|
+
routes?: LoginRoutes;
|
|
3380
|
+
/** The configuration settings of the token store. */
|
|
3381
|
+
tokenStore?: TokenStore;
|
|
3382
|
+
/** <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>. */
|
|
3383
|
+
preserveUrlFragmentsForLogins?: boolean;
|
|
3384
|
+
/**
|
|
3385
|
+
* External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.
|
|
3386
|
+
* This is an advanced setting typically only needed by Windows Store application backends.
|
|
3387
|
+
* Note that URLs within the current domain are always implicitly allowed.
|
|
3388
|
+
*/
|
|
3389
|
+
allowedExternalRedirectUrls?: Array<string>;
|
|
3390
|
+
/** The configuration settings of the session cookie's expiration. */
|
|
3391
|
+
cookieExpiration?: CookieExpiration;
|
|
3392
|
+
/** The configuration settings of the nonce used in the login flow. */
|
|
3393
|
+
nonce?: Nonce;
|
|
3394
|
+
}
|
|
3395
|
+
/** The routes that specify the endpoints used for login and logout requests. */
|
|
3396
|
+
export interface LoginRoutes {
|
|
3397
|
+
/** The endpoint at which a logout request should be made. */
|
|
3398
|
+
logoutEndpoint?: string;
|
|
3399
|
+
}
|
|
3400
|
+
/** The configuration settings of the token store. */
|
|
3401
|
+
export interface TokenStore {
|
|
3402
|
+
/**
|
|
3403
|
+
* <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>.
|
|
3404
|
+
* The default is <code>false</code>.
|
|
3405
|
+
*/
|
|
3406
|
+
enabled?: boolean;
|
|
3407
|
+
/**
|
|
3408
|
+
* The number of hours after session token expiration that a session token can be used to
|
|
3409
|
+
* call the token refresh API. The default is 72 hours.
|
|
3410
|
+
*/
|
|
3411
|
+
tokenRefreshExtensionHours?: number;
|
|
3412
|
+
/** The configuration settings of the storage of the tokens if a file system is used. */
|
|
3413
|
+
fileSystem?: FileSystemTokenStore;
|
|
3414
|
+
/** The configuration settings of the storage of the tokens if blob storage is used. */
|
|
3415
|
+
azureBlobStorage?: BlobStorageTokenStore;
|
|
3416
|
+
}
|
|
3417
|
+
/** The configuration settings of the storage of the tokens if a file system is used. */
|
|
3418
|
+
export interface FileSystemTokenStore {
|
|
3419
|
+
/** The directory in which the tokens will be stored. */
|
|
3420
|
+
directory?: string;
|
|
3421
|
+
}
|
|
3422
|
+
/** The configuration settings of the storage of the tokens if blob storage is used. */
|
|
3423
|
+
export interface BlobStorageTokenStore {
|
|
3424
|
+
/** The name of the app setting containing the SAS URL of the blob storage containing the tokens. */
|
|
3425
|
+
sasUrlSettingName?: string;
|
|
3426
|
+
}
|
|
3427
|
+
/** The configuration settings of the session cookie's expiration. */
|
|
3428
|
+
export interface CookieExpiration {
|
|
3429
|
+
/** The convention used when determining the session cookie's expiration. */
|
|
3430
|
+
convention?: "FixedTime" | "IdentityProviderDerived";
|
|
3431
|
+
/** The time after the request is made when the session cookie should expire. */
|
|
3432
|
+
timeToExpiration?: string;
|
|
3433
|
+
}
|
|
3434
|
+
/** The configuration settings of the nonce used in the login flow. */
|
|
3435
|
+
export interface Nonce {
|
|
3436
|
+
/** <code>false</code> if the nonce should not be validated while completing the login flow; otherwise, <code>true</code>. */
|
|
3437
|
+
validateNonce?: boolean;
|
|
3438
|
+
/** The time after the request is made when the nonce should expire. */
|
|
3439
|
+
nonceExpirationInterval?: string;
|
|
3440
|
+
}
|
|
3441
|
+
/** The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. */
|
|
3442
|
+
export interface HttpSettings {
|
|
3443
|
+
/** <code>false</code> if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, <code>true</code>. */
|
|
3444
|
+
requireHttps?: boolean;
|
|
3445
|
+
/** The configuration settings of the paths HTTP requests. */
|
|
3446
|
+
routes?: HttpSettingsRoutes;
|
|
3447
|
+
/** The configuration settings of a forward proxy used to make the requests. */
|
|
3448
|
+
forwardProxy?: ForwardProxy;
|
|
3449
|
+
}
|
|
3450
|
+
/** The configuration settings of the paths HTTP requests. */
|
|
3451
|
+
export interface HttpSettingsRoutes {
|
|
3452
|
+
/** The prefix that should precede all the authentication/authorization paths. */
|
|
3453
|
+
apiPrefix?: string;
|
|
3454
|
+
}
|
|
3455
|
+
/** The configuration settings of a forward proxy used to make the requests. */
|
|
3456
|
+
export interface ForwardProxy {
|
|
3457
|
+
/** The convention used to determine the url of the request made. */
|
|
3458
|
+
convention?: "NoProxy" | "Standard" | "Custom";
|
|
3459
|
+
/** The name of the header containing the host of the request. */
|
|
3460
|
+
customHostHeaderName?: string;
|
|
3461
|
+
/** The name of the header containing the scheme of the request. */
|
|
3462
|
+
customProtoHeaderName?: string;
|
|
3463
|
+
}
|
|
3464
|
+
/** AzureStorageInfo dictionary resource. */
|
|
3465
|
+
export interface AzureStoragePropertyDictionaryResource extends ProxyOnlyResource {
|
|
3466
|
+
/** Azure storage accounts. */
|
|
3467
|
+
properties?: Record<string, AzureStorageInfoValue>;
|
|
3468
|
+
}
|
|
3469
|
+
/** Description of site key vault references. */
|
|
3470
|
+
export interface ApiKVReference extends ProxyOnlyResource {
|
|
3471
|
+
/** ApiKVReference resource specific properties */
|
|
3472
|
+
properties?: ApiKVReferenceProperties;
|
|
3473
|
+
}
|
|
3474
|
+
/** ApiKVReference resource specific properties */
|
|
3475
|
+
export interface ApiKVReferenceProperties {
|
|
3476
|
+
reference?: string;
|
|
3477
|
+
status?: "Initialized" | "Resolved" | "InvalidSyntax" | "MSINotEnabled" | "VaultNotFound" | "SecretNotFound" | "SecretVersionNotFound" | "AccessToKeyVaultDenied" | "OtherReasons" | "FetchTimedOut" | "UnauthorizedClient";
|
|
3478
|
+
vaultName?: string;
|
|
3479
|
+
secretName?: string;
|
|
3480
|
+
secretVersion?: string;
|
|
3481
|
+
/** Managed service identity. */
|
|
3482
|
+
identityType?: ManagedServiceIdentity;
|
|
3483
|
+
details?: string;
|
|
3484
|
+
source?: "KeyVault";
|
|
3485
|
+
activeVersion?: string;
|
|
3486
|
+
}
|
|
3487
|
+
/** String dictionary resource. */
|
|
3488
|
+
export interface ConnectionStringDictionary extends ProxyOnlyResource {
|
|
3489
|
+
/** Connection strings. */
|
|
3490
|
+
properties?: Record<string, ConnStringValueTypePair>;
|
|
3491
|
+
}
|
|
3492
|
+
/** Database connection string value to type pair. */
|
|
3493
|
+
export interface ConnStringValueTypePair {
|
|
3494
|
+
/** Value of pair. */
|
|
3495
|
+
value: string;
|
|
3496
|
+
/** Type of database. */
|
|
3497
|
+
type: "MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL";
|
|
3498
|
+
}
|
|
3499
|
+
/** Configuration of App Service site logs. */
|
|
3500
|
+
export interface SiteLogsConfig extends ProxyOnlyResource {
|
|
3501
|
+
/** SiteLogsConfig resource specific properties */
|
|
3502
|
+
properties?: SiteLogsConfigProperties;
|
|
3503
|
+
}
|
|
3504
|
+
/** SiteLogsConfig resource specific properties */
|
|
3505
|
+
export interface SiteLogsConfigProperties {
|
|
3506
|
+
/** Application logs configuration. */
|
|
3507
|
+
applicationLogs?: ApplicationLogsConfig;
|
|
3508
|
+
/** HTTP logs configuration. */
|
|
3509
|
+
httpLogs?: HttpLogsConfig;
|
|
3510
|
+
/** Failed requests tracing configuration. */
|
|
3511
|
+
failedRequestsTracing?: EnabledConfig;
|
|
3512
|
+
/** Detailed error messages configuration. */
|
|
3513
|
+
detailedErrorMessages?: EnabledConfig;
|
|
3514
|
+
}
|
|
3515
|
+
/** Application logs configuration. */
|
|
3516
|
+
export interface ApplicationLogsConfig {
|
|
3517
|
+
/** Application logs to file system configuration. */
|
|
3518
|
+
fileSystem?: FileSystemApplicationLogsConfig;
|
|
3519
|
+
/** Application logs to azure table storage configuration. */
|
|
3520
|
+
azureTableStorage?: AzureTableStorageApplicationLogsConfig;
|
|
3521
|
+
/** Application logs to blob storage configuration. */
|
|
3522
|
+
azureBlobStorage?: AzureBlobStorageApplicationLogsConfig;
|
|
3523
|
+
}
|
|
3524
|
+
/** Application logs to file system configuration. */
|
|
3525
|
+
export interface FileSystemApplicationLogsConfig {
|
|
3526
|
+
/** Log level. */
|
|
3527
|
+
level?: "Off" | "Verbose" | "Information" | "Warning" | "Error";
|
|
3528
|
+
}
|
|
3529
|
+
/** Application logs to Azure table storage configuration. */
|
|
3530
|
+
export interface AzureTableStorageApplicationLogsConfig {
|
|
3531
|
+
/** Log level. */
|
|
3532
|
+
level?: "Off" | "Verbose" | "Information" | "Warning" | "Error";
|
|
3533
|
+
/** SAS URL to an Azure table with add/query/delete permissions. */
|
|
3534
|
+
sasUrl: string;
|
|
3535
|
+
}
|
|
3536
|
+
/** Application logs azure blob storage configuration. */
|
|
3537
|
+
export interface AzureBlobStorageApplicationLogsConfig {
|
|
3538
|
+
/** Log level. */
|
|
3539
|
+
level?: "Off" | "Verbose" | "Information" | "Warning" | "Error";
|
|
3540
|
+
/** SAS url to a azure blob container with read/write/list/delete permissions. */
|
|
3541
|
+
sasUrl?: string;
|
|
3542
|
+
/**
|
|
3543
|
+
* Retention in days.
|
|
3544
|
+
* Remove blobs older than X days.
|
|
3545
|
+
* 0 or lower means no retention.
|
|
3546
|
+
*/
|
|
3547
|
+
retentionInDays?: number;
|
|
3548
|
+
}
|
|
3549
|
+
/** Http logs configuration. */
|
|
3550
|
+
export interface HttpLogsConfig {
|
|
3551
|
+
/** Http logs to file system configuration. */
|
|
3552
|
+
fileSystem?: FileSystemHttpLogsConfig;
|
|
3553
|
+
/** Http logs to azure blob storage configuration. */
|
|
3554
|
+
azureBlobStorage?: AzureBlobStorageHttpLogsConfig;
|
|
3555
|
+
}
|
|
3556
|
+
/** Http logs to file system configuration. */
|
|
3557
|
+
export interface FileSystemHttpLogsConfig {
|
|
3558
|
+
/**
|
|
3559
|
+
* Maximum size in megabytes that http log files can use.
|
|
3560
|
+
* When reached old log files will be removed to make space for new ones.
|
|
3561
|
+
* Value can range between 25 and 100.
|
|
3562
|
+
*/
|
|
3563
|
+
retentionInMb?: number;
|
|
3564
|
+
/**
|
|
3565
|
+
* Retention in days.
|
|
3566
|
+
* Remove files older than X days.
|
|
3567
|
+
* 0 or lower means no retention.
|
|
3568
|
+
*/
|
|
3569
|
+
retentionInDays?: number;
|
|
3570
|
+
/** True if configuration is enabled, false if it is disabled and null if configuration is not set. */
|
|
3571
|
+
enabled?: boolean;
|
|
3572
|
+
}
|
|
3573
|
+
/** Http logs to azure blob storage configuration. */
|
|
3574
|
+
export interface AzureBlobStorageHttpLogsConfig {
|
|
3575
|
+
/** SAS url to a azure blob container with read/write/list/delete permissions. */
|
|
3576
|
+
sasUrl?: string;
|
|
3577
|
+
/**
|
|
3578
|
+
* Retention in days.
|
|
3579
|
+
* Remove blobs older than X days.
|
|
3580
|
+
* 0 or lower means no retention.
|
|
3581
|
+
*/
|
|
3582
|
+
retentionInDays?: number;
|
|
3583
|
+
/** True if configuration is enabled, false if it is disabled and null if configuration is not set. */
|
|
3584
|
+
enabled?: boolean;
|
|
3585
|
+
}
|
|
3586
|
+
/** Enabled configuration. */
|
|
3587
|
+
export interface EnabledConfig {
|
|
3588
|
+
/** True if configuration is enabled, false if it is disabled and null if configuration is not set. */
|
|
3589
|
+
enabled?: boolean;
|
|
3590
|
+
}
|
|
3591
|
+
/** Slot Config names azure resource. */
|
|
3592
|
+
export interface SlotConfigNamesResource extends ProxyOnlyResource {
|
|
3593
|
+
/** Core resource properties */
|
|
3594
|
+
properties?: SlotConfigNames;
|
|
3595
|
+
}
|
|
3596
|
+
/**
|
|
3597
|
+
* Names for connection strings, application settings, and external Azure storage account configuration
|
|
3598
|
+
* identifiers to be marked as sticky to the deployment slot and not moved during a swap operation.
|
|
3599
|
+
* This is valid for all deployment slots in an app.
|
|
3600
|
+
*/
|
|
3601
|
+
export interface SlotConfigNames {
|
|
3602
|
+
/** List of connection string names. */
|
|
3603
|
+
connectionStringNames?: Array<string>;
|
|
3604
|
+
/** List of application settings names. */
|
|
3605
|
+
appSettingNames?: Array<string>;
|
|
3606
|
+
/** List of external Azure storage account identifiers. */
|
|
3607
|
+
azureStorageConfigNames?: Array<string>;
|
|
3608
|
+
}
|
|
3609
|
+
/** A snapshot of a web app configuration. */
|
|
3610
|
+
export interface SiteConfigurationSnapshotInfo extends ProxyOnlyResource {
|
|
3611
|
+
/** SiteConfigurationSnapshotInfo resource specific properties */
|
|
3612
|
+
properties?: SiteConfigurationSnapshotInfoProperties;
|
|
3613
|
+
}
|
|
3614
|
+
/** SiteConfigurationSnapshotInfo resource specific properties */
|
|
3615
|
+
export interface SiteConfigurationSnapshotInfoProperties {
|
|
3616
|
+
}
|
|
3617
|
+
/** Continuous Web Job Information. */
|
|
3618
|
+
export interface ContinuousWebJob extends ProxyOnlyResource {
|
|
3619
|
+
/** ContinuousWebJob resource specific properties */
|
|
3620
|
+
properties?: ContinuousWebJobProperties;
|
|
3621
|
+
}
|
|
3622
|
+
/** ContinuousWebJob resource specific properties */
|
|
3623
|
+
export interface ContinuousWebJobProperties {
|
|
3624
|
+
/** Job status. */
|
|
3625
|
+
status?: "Initializing" | "Starting" | "Running" | "PendingRestart" | "Stopped";
|
|
3626
|
+
/** Detailed status. */
|
|
3627
|
+
detailed_status?: string;
|
|
3628
|
+
/** Log URL. */
|
|
3629
|
+
log_url?: string;
|
|
3630
|
+
/** Run command. */
|
|
3631
|
+
run_command?: string;
|
|
3632
|
+
/** Job URL. */
|
|
3633
|
+
url?: string;
|
|
3634
|
+
/** Extra Info URL. */
|
|
3635
|
+
extra_info_url?: string;
|
|
3636
|
+
/** Job type. */
|
|
3637
|
+
web_job_type?: "Continuous" | "Triggered";
|
|
3638
|
+
/** Error information. */
|
|
3639
|
+
error?: string;
|
|
3640
|
+
/** Using SDK? */
|
|
3641
|
+
using_sdk?: boolean;
|
|
3642
|
+
/** Job settings. */
|
|
3643
|
+
settings?: Record<string, Record<string, unknown>>;
|
|
3644
|
+
}
|
|
3645
|
+
/** User credentials used for publishing activity. */
|
|
3646
|
+
export interface Deployment extends ProxyOnlyResource {
|
|
3647
|
+
/** Deployment resource specific properties */
|
|
3648
|
+
properties?: DeploymentProperties;
|
|
3649
|
+
}
|
|
3650
|
+
/** Deployment resource specific properties */
|
|
3651
|
+
export interface DeploymentProperties {
|
|
3652
|
+
/** Deployment status. */
|
|
3653
|
+
status?: number;
|
|
3654
|
+
/** Details about deployment status. */
|
|
3655
|
+
message?: string;
|
|
3656
|
+
/** Who authored the deployment. */
|
|
3657
|
+
author?: string;
|
|
3658
|
+
/** Who performed the deployment. */
|
|
3659
|
+
deployer?: string;
|
|
3660
|
+
/** Author email. */
|
|
3661
|
+
author_email?: string;
|
|
3662
|
+
/** Start time. */
|
|
3663
|
+
start_time?: Date | string;
|
|
3664
|
+
/** End time. */
|
|
3665
|
+
end_time?: Date | string;
|
|
3666
|
+
/** True if deployment is currently active, false if completed and null if not started. */
|
|
3667
|
+
active?: boolean;
|
|
3668
|
+
/** Details on deployment. */
|
|
3669
|
+
details?: string;
|
|
3670
|
+
}
|
|
3671
|
+
/** MSDeploy ARM response */
|
|
3672
|
+
export interface MSDeployStatus extends ProxyOnlyResource {
|
|
3673
|
+
/** MSDeployStatus resource specific properties */
|
|
3674
|
+
properties?: MSDeployStatusProperties;
|
|
3675
|
+
}
|
|
3676
|
+
/** MSDeployStatus resource specific properties */
|
|
3677
|
+
export interface MSDeployStatusProperties {
|
|
3678
|
+
}
|
|
3679
|
+
/** MSDeploy ARM PUT information */
|
|
3680
|
+
export interface MSDeploy extends ProxyOnlyResource {
|
|
3681
|
+
/** Core resource properties */
|
|
3682
|
+
properties?: MSDeployCore;
|
|
3683
|
+
}
|
|
3684
|
+
/** MSDeploy ARM PUT core information */
|
|
3685
|
+
export interface MSDeployCore {
|
|
3686
|
+
/** Package URI */
|
|
3687
|
+
packageUri?: string;
|
|
3688
|
+
/** SQL Connection String */
|
|
3689
|
+
connectionString?: string;
|
|
3690
|
+
/** Database Type */
|
|
3691
|
+
dbType?: string;
|
|
3692
|
+
/** URI of MSDeploy Parameters file. Must not be set if SetParameters is used. */
|
|
3693
|
+
setParametersXmlFileUri?: string;
|
|
3694
|
+
/** MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. */
|
|
3695
|
+
setParameters?: Record<string, string>;
|
|
3696
|
+
/**
|
|
3697
|
+
* Controls whether the MSDeploy operation skips the App_Data directory.
|
|
3698
|
+
* If set to <code>true</code>, the existing App_Data directory on the destination
|
|
3699
|
+
* will not be deleted, and any App_Data directory in the source will be ignored.
|
|
3700
|
+
* Setting is <code>false</code> by default.
|
|
3701
|
+
*/
|
|
3702
|
+
skipAppData?: boolean;
|
|
3703
|
+
/**
|
|
3704
|
+
* Sets the AppOffline rule while the MSDeploy operation executes.
|
|
3705
|
+
* Setting is <code>false</code> by default.
|
|
3706
|
+
*/
|
|
3707
|
+
appOffline?: boolean;
|
|
3708
|
+
}
|
|
3709
|
+
/** MSDeploy log */
|
|
3710
|
+
export interface MSDeployLog extends ProxyOnlyResource {
|
|
3711
|
+
/** MSDeployLog resource specific properties */
|
|
3712
|
+
properties?: MSDeployLogProperties;
|
|
3713
|
+
}
|
|
3714
|
+
/** MSDeployLog resource specific properties */
|
|
3715
|
+
export interface MSDeployLogProperties {
|
|
3716
|
+
}
|
|
3717
|
+
/** MSDeploy log entry */
|
|
3718
|
+
export interface MSDeployLogEntry {
|
|
3719
|
+
}
|
|
3720
|
+
/** Function information. */
|
|
3721
|
+
export interface FunctionEnvelope extends ProxyOnlyResource {
|
|
3722
|
+
/** FunctionEnvelope resource specific properties */
|
|
3723
|
+
properties?: FunctionEnvelopeProperties;
|
|
3724
|
+
}
|
|
3725
|
+
/** FunctionEnvelope resource specific properties */
|
|
3726
|
+
export interface FunctionEnvelopeProperties {
|
|
3727
|
+
/** Function App ID. */
|
|
3728
|
+
function_app_id?: string;
|
|
3729
|
+
/** Script root path URI. */
|
|
3730
|
+
script_root_path_href?: string;
|
|
3731
|
+
/** Script URI. */
|
|
3732
|
+
script_href?: string;
|
|
3733
|
+
/** Config URI. */
|
|
3734
|
+
config_href?: string;
|
|
3735
|
+
/** Test data URI. */
|
|
3736
|
+
test_data_href?: string;
|
|
3737
|
+
/** Secrets file URI. */
|
|
3738
|
+
secrets_file_href?: string;
|
|
3739
|
+
/** Function URI. */
|
|
3740
|
+
href?: string;
|
|
3741
|
+
/** Config information. */
|
|
3742
|
+
config?: Record<string, unknown>;
|
|
3743
|
+
/** File list. */
|
|
3744
|
+
files?: Record<string, string>;
|
|
3745
|
+
/** Test data used when testing via the Azure Portal. */
|
|
3746
|
+
test_data?: string;
|
|
3747
|
+
/** The invocation URL */
|
|
3748
|
+
invoke_url_template?: string;
|
|
3749
|
+
/** The function language */
|
|
3750
|
+
language?: string;
|
|
3751
|
+
/** Gets or sets a value indicating whether the function is disabled */
|
|
3752
|
+
isDisabled?: boolean;
|
|
3753
|
+
}
|
|
3754
|
+
/** Function key info. */
|
|
3755
|
+
export interface KeyInfo {
|
|
3756
|
+
/** Key name */
|
|
3757
|
+
name?: string;
|
|
3758
|
+
/** Key value */
|
|
3759
|
+
value?: string;
|
|
3760
|
+
}
|
|
3761
|
+
/** A hostname binding object. */
|
|
3762
|
+
export interface HostNameBinding extends ProxyOnlyResource {
|
|
3763
|
+
/** HostNameBinding resource specific properties */
|
|
3764
|
+
properties?: HostNameBindingProperties;
|
|
3765
|
+
}
|
|
3766
|
+
/** HostNameBinding resource specific properties */
|
|
3767
|
+
export interface HostNameBindingProperties {
|
|
3768
|
+
/** App Service app name. */
|
|
3769
|
+
siteName?: string;
|
|
3770
|
+
/** Fully qualified ARM domain resource URI. */
|
|
3771
|
+
domainId?: string;
|
|
3772
|
+
/** Azure resource name. */
|
|
3773
|
+
azureResourceName?: string;
|
|
3774
|
+
/** Azure resource type. */
|
|
3775
|
+
azureResourceType?: "Website" | "TrafficManager";
|
|
3776
|
+
/** Custom DNS record type. */
|
|
3777
|
+
customHostNameDnsRecordType?: "CName" | "A";
|
|
3778
|
+
/** Hostname type. */
|
|
3779
|
+
hostNameType?: "Verified" | "Managed";
|
|
3780
|
+
/** SSL type */
|
|
3781
|
+
sslState?: "Disabled" | "SniEnabled" | "IpBasedEnabled";
|
|
3782
|
+
/** SSL certificate thumbprint */
|
|
3783
|
+
thumbprint?: string;
|
|
3784
|
+
}
|
|
3785
|
+
/** Hybrid Connection for an App Service app. */
|
|
3786
|
+
export interface RelayServiceConnectionEntity extends ProxyOnlyResource {
|
|
3787
|
+
/** RelayServiceConnectionEntity resource specific properties */
|
|
3788
|
+
properties?: RelayServiceConnectionEntityProperties;
|
|
3789
|
+
}
|
|
3790
|
+
/** RelayServiceConnectionEntity resource specific properties */
|
|
3791
|
+
export interface RelayServiceConnectionEntityProperties {
|
|
3792
|
+
entityName?: string;
|
|
3793
|
+
entityConnectionString?: string;
|
|
3794
|
+
resourceType?: string;
|
|
3795
|
+
resourceConnectionString?: string;
|
|
3796
|
+
hostname?: string;
|
|
3797
|
+
port?: number;
|
|
3798
|
+
biztalkUri?: string;
|
|
3799
|
+
}
|
|
3800
|
+
export interface WebSiteInstanceStatus extends ProxyOnlyResource {
|
|
3801
|
+
/** WebSiteInstanceStatus resource specific properties */
|
|
3802
|
+
properties?: WebSiteInstanceStatusProperties;
|
|
3803
|
+
}
|
|
3804
|
+
/** WebSiteInstanceStatus resource specific properties */
|
|
3805
|
+
export interface WebSiteInstanceStatusProperties {
|
|
3806
|
+
state?: "READY" | "STOPPED" | "UNKNOWN";
|
|
3807
|
+
/** Link to the GetStatusApi in Kudu */
|
|
3808
|
+
statusUrl?: string;
|
|
3809
|
+
/** Link to the Diagnose and Solve Portal */
|
|
3810
|
+
detectorUrl?: string;
|
|
3811
|
+
/** Link to the console to web app instance */
|
|
3812
|
+
consoleUrl?: string;
|
|
3813
|
+
/** Link to the console to web app instance */
|
|
3814
|
+
healthCheckUrl?: string;
|
|
3815
|
+
/** Dictionary of <ContainerInfo> */
|
|
3816
|
+
containers?: Record<string, ContainerInfo>;
|
|
3817
|
+
}
|
|
3818
|
+
export interface ContainerInfo {
|
|
3819
|
+
currentTimeStamp?: Date | string;
|
|
3820
|
+
previousTimeStamp?: Date | string;
|
|
3821
|
+
currentCpuStats?: ContainerCpuStatistics;
|
|
3822
|
+
previousCpuStats?: ContainerCpuStatistics;
|
|
3823
|
+
memoryStats?: ContainerMemoryStatistics;
|
|
3824
|
+
name?: string;
|
|
3825
|
+
id?: string;
|
|
3826
|
+
eth0?: ContainerNetworkInterfaceStatistics;
|
|
3827
|
+
}
|
|
3828
|
+
export interface ContainerCpuStatistics {
|
|
3829
|
+
cpuUsage?: ContainerCpuUsage;
|
|
3830
|
+
systemCpuUsage?: number;
|
|
3831
|
+
onlineCpuCount?: number;
|
|
3832
|
+
throttlingData?: ContainerThrottlingData;
|
|
3833
|
+
}
|
|
3834
|
+
export interface ContainerCpuUsage {
|
|
3835
|
+
totalUsage?: number;
|
|
3836
|
+
perCpuUsage?: Array<number>;
|
|
3837
|
+
kernelModeUsage?: number;
|
|
3838
|
+
userModeUsage?: number;
|
|
3839
|
+
}
|
|
3840
|
+
export interface ContainerThrottlingData {
|
|
3841
|
+
periods?: number;
|
|
3842
|
+
throttledPeriods?: number;
|
|
3843
|
+
throttledTime?: number;
|
|
3844
|
+
}
|
|
3845
|
+
export interface ContainerMemoryStatistics {
|
|
3846
|
+
usage?: number;
|
|
3847
|
+
maxUsage?: number;
|
|
3848
|
+
limit?: number;
|
|
3849
|
+
}
|
|
3850
|
+
export interface ContainerNetworkInterfaceStatistics {
|
|
3851
|
+
rxBytes?: number;
|
|
3852
|
+
rxPackets?: number;
|
|
3853
|
+
rxErrors?: number;
|
|
3854
|
+
rxDropped?: number;
|
|
3855
|
+
txBytes?: number;
|
|
3856
|
+
txPackets?: number;
|
|
3857
|
+
txErrors?: number;
|
|
3858
|
+
txDropped?: number;
|
|
3859
|
+
}
|
|
3860
|
+
/** Process Information. */
|
|
3861
|
+
export interface ProcessInfo extends ProxyOnlyResource {
|
|
3862
|
+
/** ProcessInfo resource specific properties */
|
|
3863
|
+
properties?: ProcessInfoProperties;
|
|
3864
|
+
}
|
|
3865
|
+
/** ProcessInfo resource specific properties */
|
|
3866
|
+
export interface ProcessInfoProperties {
|
|
3867
|
+
/** Deployment name. */
|
|
3868
|
+
deployment_name?: string;
|
|
3869
|
+
/** HRef URI. */
|
|
3870
|
+
href?: string;
|
|
3871
|
+
/** Minidump URI. */
|
|
3872
|
+
minidump?: string;
|
|
3873
|
+
/** Is profile running? */
|
|
3874
|
+
is_profile_running?: boolean;
|
|
3875
|
+
/** Is the IIS Profile running? */
|
|
3876
|
+
is_iis_profile_running?: boolean;
|
|
3877
|
+
/** IIS Profile timeout (seconds). */
|
|
3878
|
+
iis_profile_timeout_in_seconds?: number;
|
|
3879
|
+
/** Parent process. */
|
|
3880
|
+
parent?: string;
|
|
3881
|
+
/** Child process list. */
|
|
3882
|
+
children?: Array<string>;
|
|
3883
|
+
/** Thread list. */
|
|
3884
|
+
threads?: Array<ProcessThreadInfo>;
|
|
3885
|
+
/** List of open files. */
|
|
3886
|
+
open_file_handles?: Array<string>;
|
|
3887
|
+
/** List of modules. */
|
|
3888
|
+
modules?: Array<ProcessModuleInfo>;
|
|
3889
|
+
/** File name of this process. */
|
|
3890
|
+
file_name?: string;
|
|
3891
|
+
/** Command line. */
|
|
3892
|
+
command_line?: string;
|
|
3893
|
+
/** User name. */
|
|
3894
|
+
user_name?: string;
|
|
3895
|
+
/** Handle count. */
|
|
3896
|
+
handle_count?: number;
|
|
3897
|
+
/** Module count. */
|
|
3898
|
+
module_count?: number;
|
|
3899
|
+
/** Thread count. */
|
|
3900
|
+
thread_count?: number;
|
|
3901
|
+
/** Start time. */
|
|
3902
|
+
start_time?: Date | string;
|
|
3903
|
+
/** Total CPU time. */
|
|
3904
|
+
total_cpu_time?: string;
|
|
3905
|
+
/** User CPU time. */
|
|
3906
|
+
user_cpu_time?: string;
|
|
3907
|
+
/** Privileged CPU time. */
|
|
3908
|
+
privileged_cpu_time?: string;
|
|
3909
|
+
/** Working set. */
|
|
3910
|
+
working_set?: number;
|
|
3911
|
+
/** Peak working set. */
|
|
3912
|
+
peak_working_set?: number;
|
|
3913
|
+
/** Private memory size. */
|
|
3914
|
+
private_memory?: number;
|
|
3915
|
+
/** Virtual memory size. */
|
|
3916
|
+
virtual_memory?: number;
|
|
3917
|
+
/** Peak virtual memory usage. */
|
|
3918
|
+
peak_virtual_memory?: number;
|
|
3919
|
+
/** Paged system memory. */
|
|
3920
|
+
paged_system_memory?: number;
|
|
3921
|
+
/** Non-paged system memory. */
|
|
3922
|
+
non_paged_system_memory?: number;
|
|
3923
|
+
/** Paged memory. */
|
|
3924
|
+
paged_memory?: number;
|
|
3925
|
+
/** Peak paged memory. */
|
|
3926
|
+
peak_paged_memory?: number;
|
|
3927
|
+
/** Time stamp. */
|
|
3928
|
+
time_stamp?: Date | string;
|
|
3929
|
+
/** List of environment variables. */
|
|
3930
|
+
environment_variables?: Record<string, string>;
|
|
3931
|
+
/** Is this the SCM site? */
|
|
3932
|
+
is_scm_site?: boolean;
|
|
3933
|
+
/** Is this a Web Job? */
|
|
3934
|
+
is_webjob?: boolean;
|
|
3935
|
+
/** Description of process. */
|
|
3936
|
+
description?: string;
|
|
3937
|
+
}
|
|
3938
|
+
/** Process Thread Information. */
|
|
3939
|
+
export interface ProcessThreadInfo extends ProxyOnlyResource {
|
|
3940
|
+
/** ProcessThreadInfo resource specific properties */
|
|
3941
|
+
properties?: ProcessThreadInfoProperties;
|
|
3942
|
+
}
|
|
3943
|
+
/** ProcessThreadInfo resource specific properties */
|
|
3944
|
+
export interface ProcessThreadInfoProperties {
|
|
3945
|
+
/** HRef URI. */
|
|
3946
|
+
href?: string;
|
|
3947
|
+
/** Process URI. */
|
|
3948
|
+
process?: string;
|
|
3949
|
+
/** Start address. */
|
|
3950
|
+
start_address?: string;
|
|
3951
|
+
/** Current thread priority. */
|
|
3952
|
+
current_priority?: number;
|
|
3953
|
+
/** Thread priority level. */
|
|
3954
|
+
priority_level?: string;
|
|
3955
|
+
/** Base priority. */
|
|
3956
|
+
base_priority?: number;
|
|
3957
|
+
/** Start time. */
|
|
3958
|
+
start_time?: Date | string;
|
|
3959
|
+
/** Total processor time. */
|
|
3960
|
+
total_processor_time?: string;
|
|
3961
|
+
/** User processor time. */
|
|
3962
|
+
user_processor_time?: string;
|
|
3963
|
+
/** Thread state. */
|
|
3964
|
+
state?: string;
|
|
3965
|
+
/** Wait reason. */
|
|
3966
|
+
wait_reason?: string;
|
|
3967
|
+
}
|
|
3968
|
+
/** Process Module Information. */
|
|
3969
|
+
export interface ProcessModuleInfo extends ProxyOnlyResource {
|
|
3970
|
+
/** ProcessModuleInfo resource specific properties */
|
|
3971
|
+
properties?: ProcessModuleInfoProperties;
|
|
3972
|
+
}
|
|
3973
|
+
/** ProcessModuleInfo resource specific properties */
|
|
3974
|
+
export interface ProcessModuleInfoProperties {
|
|
3975
|
+
/** Base address. Used as module identifier in ARM resource URI. */
|
|
3976
|
+
base_address?: string;
|
|
3977
|
+
/** File name. */
|
|
3978
|
+
file_name?: string;
|
|
3979
|
+
/** HRef URI. */
|
|
3980
|
+
href?: string;
|
|
3981
|
+
/** File path. */
|
|
3982
|
+
file_path?: string;
|
|
3983
|
+
/** Module memory size. */
|
|
3984
|
+
module_memory_size?: number;
|
|
3985
|
+
/** File version. */
|
|
3986
|
+
file_version?: string;
|
|
3987
|
+
/** File description. */
|
|
3988
|
+
file_description?: string;
|
|
3989
|
+
/** Product name. */
|
|
3990
|
+
product?: string;
|
|
3991
|
+
/** Product version. */
|
|
3992
|
+
product_version?: string;
|
|
3993
|
+
/** Is debug? */
|
|
3994
|
+
is_debug?: boolean;
|
|
3995
|
+
/** Module language (locale). */
|
|
3996
|
+
language?: string;
|
|
3997
|
+
}
|
|
3998
|
+
/** Options for app content migration. */
|
|
3999
|
+
export interface StorageMigrationOptions extends ProxyOnlyResource {
|
|
4000
|
+
/** StorageMigrationOptions resource specific properties */
|
|
4001
|
+
properties?: StorageMigrationOptionsProperties;
|
|
4002
|
+
}
|
|
4003
|
+
/** StorageMigrationOptions resource specific properties */
|
|
4004
|
+
export interface StorageMigrationOptionsProperties {
|
|
4005
|
+
/** AzureFiles connection string. */
|
|
4006
|
+
azurefilesConnectionString: string;
|
|
4007
|
+
/** AzureFiles share. */
|
|
4008
|
+
azurefilesShare: string;
|
|
4009
|
+
/** <code>true</code>if the app should be switched over; otherwise, <code>false</code>. */
|
|
4010
|
+
switchSiteAfterMigration?: boolean;
|
|
4011
|
+
/** <code>true</code> if the app should be read only during copy operation; otherwise, <code>false</code>. */
|
|
4012
|
+
blockWriteAccessToSite?: boolean;
|
|
4013
|
+
}
|
|
4014
|
+
/** Response for a migration of app content request. */
|
|
4015
|
+
export interface StorageMigrationResponse extends ProxyOnlyResource {
|
|
4016
|
+
/** StorageMigrationResponse resource specific properties */
|
|
4017
|
+
properties?: StorageMigrationResponseProperties;
|
|
4018
|
+
}
|
|
4019
|
+
/** StorageMigrationResponse resource specific properties */
|
|
4020
|
+
export interface StorageMigrationResponseProperties {
|
|
4021
|
+
}
|
|
4022
|
+
/** MySQL migration request. */
|
|
4023
|
+
export interface MigrateMySqlRequest extends ProxyOnlyResource {
|
|
4024
|
+
/** MigrateMySqlRequest resource specific properties */
|
|
4025
|
+
properties?: MigrateMySqlRequestProperties;
|
|
4026
|
+
}
|
|
4027
|
+
/** MigrateMySqlRequest resource specific properties */
|
|
4028
|
+
export interface MigrateMySqlRequestProperties {
|
|
4029
|
+
/** Connection string to the remote MySQL database. */
|
|
4030
|
+
connectionString: string;
|
|
4031
|
+
/** The type of migration operation to be done */
|
|
4032
|
+
migrationType: "LocalToRemote" | "RemoteToLocal";
|
|
4033
|
+
}
|
|
4034
|
+
/** MySQL migration status. */
|
|
4035
|
+
export interface MigrateMySqlStatus extends ProxyOnlyResource {
|
|
4036
|
+
/** MigrateMySqlStatus resource specific properties */
|
|
4037
|
+
properties?: MigrateMySqlStatusProperties;
|
|
4038
|
+
}
|
|
4039
|
+
/** MigrateMySqlStatus resource specific properties */
|
|
4040
|
+
export interface MigrateMySqlStatusProperties {
|
|
4041
|
+
}
|
|
4042
|
+
/** Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration. */
|
|
4043
|
+
export interface SwiftVirtualNetwork extends ProxyOnlyResource {
|
|
4044
|
+
/** SwiftVirtualNetwork resource specific properties */
|
|
4045
|
+
properties?: SwiftVirtualNetworkProperties;
|
|
4046
|
+
}
|
|
4047
|
+
/** SwiftVirtualNetwork resource specific properties */
|
|
4048
|
+
export interface SwiftVirtualNetworkProperties {
|
|
4049
|
+
/** The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. */
|
|
4050
|
+
subnetResourceId?: string;
|
|
4051
|
+
/** A flag that specifies if the scale unit this Web App is on supports Swift integration. */
|
|
4052
|
+
swiftSupported?: boolean;
|
|
4053
|
+
}
|
|
4054
|
+
/** Full view of network features for an app (presently VNET integration and Hybrid Connections). */
|
|
4055
|
+
export interface NetworkFeatures extends ProxyOnlyResource {
|
|
4056
|
+
/** NetworkFeatures resource specific properties */
|
|
4057
|
+
properties?: NetworkFeaturesProperties;
|
|
4058
|
+
}
|
|
4059
|
+
/** NetworkFeatures resource specific properties */
|
|
4060
|
+
export interface NetworkFeaturesProperties {
|
|
4061
|
+
}
|
|
4062
|
+
/** Used for getting PHP error logging flag. */
|
|
4063
|
+
export interface SitePhpErrorLogFlag extends ProxyOnlyResource {
|
|
4064
|
+
/** SitePhpErrorLogFlag resource specific properties */
|
|
4065
|
+
properties?: SitePhpErrorLogFlagProperties;
|
|
4066
|
+
}
|
|
4067
|
+
/** SitePhpErrorLogFlag resource specific properties */
|
|
4068
|
+
export interface SitePhpErrorLogFlagProperties {
|
|
4069
|
+
/** Local log_errors setting. */
|
|
4070
|
+
localLogErrors?: string;
|
|
4071
|
+
/** Master log_errors setting. */
|
|
4072
|
+
masterLogErrors?: string;
|
|
4073
|
+
/** Local log_errors_max_len setting. */
|
|
4074
|
+
localLogErrorsMaxLength?: string;
|
|
4075
|
+
/** Master log_errors_max_len setting. */
|
|
4076
|
+
masterLogErrorsMaxLength?: string;
|
|
4077
|
+
}
|
|
4078
|
+
/** Premier add-on. */
|
|
4079
|
+
export interface PremierAddOn extends Resource {
|
|
4080
|
+
/** PremierAddOn resource specific properties */
|
|
4081
|
+
properties?: PremierAddOnProperties;
|
|
4082
|
+
}
|
|
4083
|
+
/** PremierAddOn resource specific properties */
|
|
4084
|
+
export interface PremierAddOnProperties {
|
|
4085
|
+
/** Premier add on SKU. */
|
|
4086
|
+
sku?: string;
|
|
4087
|
+
/** Premier add on Product. */
|
|
4088
|
+
product?: string;
|
|
4089
|
+
/** Premier add on Vendor. */
|
|
4090
|
+
vendor?: string;
|
|
4091
|
+
/** Premier add on Marketplace publisher. */
|
|
4092
|
+
marketplacePublisher?: string;
|
|
4093
|
+
/** Premier add on Marketplace offer. */
|
|
4094
|
+
marketplaceOffer?: string;
|
|
4095
|
+
}
|
|
4096
|
+
/** ARM resource for a PremierAddOn. */
|
|
4097
|
+
export interface PremierAddOnPatchResource extends ProxyOnlyResource {
|
|
4098
|
+
/** PremierAddOnPatchResource resource specific properties */
|
|
4099
|
+
properties?: PremierAddOnPatchResourceProperties;
|
|
4100
|
+
}
|
|
4101
|
+
/** PremierAddOnPatchResource resource specific properties */
|
|
4102
|
+
export interface PremierAddOnPatchResourceProperties {
|
|
4103
|
+
/** Premier add on SKU. */
|
|
4104
|
+
sku?: string;
|
|
4105
|
+
/** Premier add on Product. */
|
|
4106
|
+
product?: string;
|
|
4107
|
+
/** Premier add on Vendor. */
|
|
4108
|
+
vendor?: string;
|
|
4109
|
+
/** Premier add on Marketplace publisher. */
|
|
4110
|
+
marketplacePublisher?: string;
|
|
4111
|
+
/** Premier add on Marketplace offer. */
|
|
4112
|
+
marketplaceOffer?: string;
|
|
4113
|
+
}
|
|
4114
|
+
/** Description of the parameters of Private Access for a Web Site. */
|
|
4115
|
+
export interface PrivateAccess extends ProxyOnlyResource {
|
|
4116
|
+
/** PrivateAccess resource specific properties */
|
|
4117
|
+
properties?: PrivateAccessProperties;
|
|
4118
|
+
}
|
|
4119
|
+
/** PrivateAccess resource specific properties */
|
|
4120
|
+
export interface PrivateAccessProperties {
|
|
4121
|
+
/** Whether private access is enabled or not. */
|
|
4122
|
+
enabled?: boolean;
|
|
4123
|
+
/** The Virtual Networks (and subnets) allowed to access the site privately. */
|
|
4124
|
+
virtualNetworks?: Array<PrivateAccessVirtualNetwork>;
|
|
4125
|
+
}
|
|
4126
|
+
/** Description of a Virtual Network that is useable for private site access. */
|
|
4127
|
+
export interface PrivateAccessVirtualNetwork {
|
|
4128
|
+
/** The name of the Virtual Network. */
|
|
4129
|
+
name?: string;
|
|
4130
|
+
/** The key (ID) of the Virtual Network. */
|
|
4131
|
+
key?: number;
|
|
4132
|
+
/** The ARM uri of the Virtual Network */
|
|
4133
|
+
resourceId?: string;
|
|
4134
|
+
/** A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. */
|
|
4135
|
+
subnets?: Array<PrivateAccessSubnet>;
|
|
4136
|
+
}
|
|
4137
|
+
/** Description of a Virtual Network subnet that is useable for private site access. */
|
|
4138
|
+
export interface PrivateAccessSubnet {
|
|
4139
|
+
/** The name of the subnet. */
|
|
4140
|
+
name?: string;
|
|
4141
|
+
/** The key (ID) of the subnet. */
|
|
4142
|
+
key?: number;
|
|
4143
|
+
}
|
|
4144
|
+
/** Public certificate object */
|
|
4145
|
+
export interface PublicCertificate extends ProxyOnlyResource {
|
|
4146
|
+
/** PublicCertificate resource specific properties */
|
|
4147
|
+
properties?: PublicCertificateProperties;
|
|
4148
|
+
}
|
|
4149
|
+
/** PublicCertificate resource specific properties */
|
|
4150
|
+
export interface PublicCertificateProperties {
|
|
4151
|
+
/**
|
|
4152
|
+
* Public Certificate byte array
|
|
4153
|
+
*
|
|
4154
|
+
* Value may contain base64 encoded characters
|
|
4155
|
+
*/
|
|
4156
|
+
blob?: string;
|
|
4157
|
+
/** Public Certificate Location */
|
|
4158
|
+
publicCertificateLocation?: "CurrentUserMy" | "LocalMachineMy" | "Unknown";
|
|
4159
|
+
}
|
|
4160
|
+
/** Publishing options for requested profile. */
|
|
4161
|
+
export interface CsmPublishingProfileOptions {
|
|
4162
|
+
/**
|
|
4163
|
+
* Name of the format. Valid values are:
|
|
4164
|
+
* FileZilla3
|
|
4165
|
+
* WebDeploy -- default
|
|
4166
|
+
* Ftp
|
|
4167
|
+
*/
|
|
4168
|
+
format?: "FileZilla3" | "WebDeploy" | "Ftp";
|
|
4169
|
+
/** Include the DisasterRecover endpoint if true */
|
|
4170
|
+
includeDisasterRecoveryEndpoints?: boolean;
|
|
4171
|
+
}
|
|
4172
|
+
/** Details about restoring a deleted app. */
|
|
4173
|
+
export interface DeletedAppRestoreRequest extends ProxyOnlyResource {
|
|
4174
|
+
/** DeletedAppRestoreRequest resource specific properties */
|
|
4175
|
+
properties?: DeletedAppRestoreRequestProperties;
|
|
4176
|
+
}
|
|
4177
|
+
/** DeletedAppRestoreRequest resource specific properties */
|
|
4178
|
+
export interface DeletedAppRestoreRequestProperties {
|
|
4179
|
+
/**
|
|
4180
|
+
* ARM resource ID of the deleted app. Example:
|
|
4181
|
+
* /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}
|
|
4182
|
+
*/
|
|
4183
|
+
deletedSiteId?: string;
|
|
4184
|
+
/** If true, deleted site configuration, in addition to content, will be restored. */
|
|
4185
|
+
recoverConfiguration?: boolean;
|
|
4186
|
+
/**
|
|
4187
|
+
* Point in time to restore the deleted app from, formatted as a DateTime string.
|
|
4188
|
+
* If unspecified, default value is the time that the app was deleted.
|
|
4189
|
+
*/
|
|
4190
|
+
snapshotTime?: string;
|
|
4191
|
+
/** If true, the snapshot is retrieved from DRSecondary endpoint. */
|
|
4192
|
+
useDRSecondary?: boolean;
|
|
4193
|
+
}
|
|
4194
|
+
/** Details about app recovery operation. */
|
|
4195
|
+
export interface SnapshotRestoreRequest extends ProxyOnlyResource {
|
|
4196
|
+
/** SnapshotRestoreRequest resource specific properties */
|
|
4197
|
+
properties?: SnapshotRestoreRequestProperties;
|
|
4198
|
+
}
|
|
4199
|
+
/** SnapshotRestoreRequest resource specific properties */
|
|
4200
|
+
export interface SnapshotRestoreRequestProperties {
|
|
4201
|
+
/** Point in time in which the app restore should be done, formatted as a DateTime string. */
|
|
4202
|
+
snapshotTime?: string;
|
|
4203
|
+
/**
|
|
4204
|
+
* Optional. Specifies the web app that snapshot contents will be retrieved from.
|
|
4205
|
+
* If empty, the targeted web app will be used as the source.
|
|
4206
|
+
*/
|
|
4207
|
+
recoverySource?: SnapshotRecoverySource;
|
|
4208
|
+
/** If <code>true</code> the restore operation can overwrite source app; otherwise, <code>false</code>. */
|
|
4209
|
+
overwrite: boolean;
|
|
4210
|
+
/** If true, site configuration, in addition to content, will be reverted. */
|
|
4211
|
+
recoverConfiguration?: boolean;
|
|
4212
|
+
/**
|
|
4213
|
+
* If true, custom hostname conflicts will be ignored when recovering to a target web app.
|
|
4214
|
+
* This setting is only necessary when RecoverConfiguration is enabled.
|
|
4215
|
+
*/
|
|
4216
|
+
ignoreConflictingHostNames?: boolean;
|
|
4217
|
+
/** If true, the snapshot is retrieved from DRSecondary endpoint. */
|
|
4218
|
+
useDRSecondary?: boolean;
|
|
4219
|
+
}
|
|
4220
|
+
/** Specifies the web app that snapshot contents will be retrieved from. */
|
|
4221
|
+
export interface SnapshotRecoverySource {
|
|
4222
|
+
/** Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS */
|
|
4223
|
+
location?: string;
|
|
4224
|
+
/**
|
|
4225
|
+
* ARM resource ID of the source app.
|
|
4226
|
+
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and
|
|
4227
|
+
* /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.
|
|
4228
|
+
*/
|
|
4229
|
+
id?: string;
|
|
4230
|
+
}
|
|
4231
|
+
/** Site Extension Information. */
|
|
4232
|
+
export interface SiteExtensionInfo extends ProxyOnlyResource {
|
|
4233
|
+
/** SiteExtensionInfo resource specific properties */
|
|
4234
|
+
properties?: SiteExtensionInfoProperties;
|
|
4235
|
+
}
|
|
4236
|
+
/** SiteExtensionInfo resource specific properties */
|
|
4237
|
+
export interface SiteExtensionInfoProperties {
|
|
4238
|
+
/** Site extension ID. */
|
|
4239
|
+
extension_id?: string;
|
|
4240
|
+
title?: string;
|
|
4241
|
+
/** Site extension type. */
|
|
4242
|
+
extension_type?: "Gallery" | "WebRoot";
|
|
4243
|
+
/** Summary description. */
|
|
4244
|
+
summary?: string;
|
|
4245
|
+
/** Detailed description. */
|
|
4246
|
+
description?: string;
|
|
4247
|
+
/** Version information. */
|
|
4248
|
+
version?: string;
|
|
4249
|
+
/** Extension URL. */
|
|
4250
|
+
extension_url?: string;
|
|
4251
|
+
/** Project URL. */
|
|
4252
|
+
project_url?: string;
|
|
4253
|
+
/** Icon URL. */
|
|
4254
|
+
icon_url?: string;
|
|
4255
|
+
/** License URL. */
|
|
4256
|
+
license_url?: string;
|
|
4257
|
+
/** Feed URL. */
|
|
4258
|
+
feed_url?: string;
|
|
4259
|
+
/** List of authors. */
|
|
4260
|
+
authors?: Array<string>;
|
|
4261
|
+
/** Installer command line parameters. */
|
|
4262
|
+
installer_command_line_params?: string;
|
|
4263
|
+
/** Published timestamp. */
|
|
4264
|
+
published_date_time?: Date | string;
|
|
4265
|
+
/** Count of downloads. */
|
|
4266
|
+
download_count?: number;
|
|
4267
|
+
/** <code>true</code> if the local version is the latest version; <code>false</code> otherwise. */
|
|
4268
|
+
local_is_latest_version?: boolean;
|
|
4269
|
+
/** Local path. */
|
|
4270
|
+
local_path?: string;
|
|
4271
|
+
/** Installed timestamp. */
|
|
4272
|
+
installed_date_time?: Date | string;
|
|
4273
|
+
/** Provisioning state. */
|
|
4274
|
+
provisioningState?: string;
|
|
4275
|
+
/** Site Extension comment. */
|
|
4276
|
+
comment?: string;
|
|
4277
|
+
}
|
|
4278
|
+
/** A setting difference between two deployment slots of an app. */
|
|
4279
|
+
export interface SlotDifference extends ProxyOnlyResource {
|
|
4280
|
+
/** SlotDifference resource specific properties */
|
|
4281
|
+
properties?: SlotDifferenceProperties;
|
|
4282
|
+
}
|
|
4283
|
+
/** SlotDifference resource specific properties */
|
|
4284
|
+
export interface SlotDifferenceProperties {
|
|
4285
|
+
}
|
|
4286
|
+
/** Source control configuration for an app. */
|
|
4287
|
+
export interface SiteSourceControl extends ProxyOnlyResource {
|
|
4288
|
+
/** SiteSourceControl resource specific properties */
|
|
4289
|
+
properties?: SiteSourceControlProperties;
|
|
4290
|
+
}
|
|
4291
|
+
/** SiteSourceControl resource specific properties */
|
|
4292
|
+
export interface SiteSourceControlProperties {
|
|
4293
|
+
/** Repository or source control URL. */
|
|
4294
|
+
repoUrl?: string;
|
|
4295
|
+
/** Name of branch to use for deployment. */
|
|
4296
|
+
branch?: string;
|
|
4297
|
+
/** <code>true</code> to limit to manual integration; <code>false</code> to enable continuous integration (which configures webhooks into online repos like GitHub). */
|
|
4298
|
+
isManualIntegration?: boolean;
|
|
4299
|
+
/** <code>true</code> if this is deployed via GitHub action. */
|
|
4300
|
+
isGitHubAction?: boolean;
|
|
4301
|
+
/** <code>true</code> to enable deployment rollback; otherwise, <code>false</code>. */
|
|
4302
|
+
deploymentRollbackEnabled?: boolean;
|
|
4303
|
+
/** <code>true</code> for a Mercurial repository; <code>false</code> for a Git repository. */
|
|
4304
|
+
isMercurial?: boolean;
|
|
4305
|
+
/** If GitHub Action is selected, than the associated configuration. */
|
|
4306
|
+
gitHubActionConfiguration?: GitHubActionConfiguration;
|
|
4307
|
+
}
|
|
4308
|
+
/** The GitHub action configuration. */
|
|
4309
|
+
export interface GitHubActionConfiguration {
|
|
4310
|
+
/** GitHub Action code configuration. */
|
|
4311
|
+
codeConfiguration?: GitHubActionCodeConfiguration;
|
|
4312
|
+
/** GitHub Action container configuration. */
|
|
4313
|
+
containerConfiguration?: GitHubActionContainerConfiguration;
|
|
4314
|
+
/** This will help determine the workflow configuration to select. */
|
|
4315
|
+
isLinux?: boolean;
|
|
4316
|
+
/** Workflow option to determine whether the workflow file should be generated and written to the repository. */
|
|
4317
|
+
generateWorkflowFile?: boolean;
|
|
4318
|
+
}
|
|
4319
|
+
/** The GitHub action code configuration. */
|
|
4320
|
+
export interface GitHubActionCodeConfiguration {
|
|
4321
|
+
/** Runtime stack is used to determine the workflow file content for code base apps. */
|
|
4322
|
+
runtimeStack?: string;
|
|
4323
|
+
/** Runtime version is used to determine what build version to set in the workflow file. */
|
|
4324
|
+
runtimeVersion?: string;
|
|
4325
|
+
}
|
|
4326
|
+
/** The GitHub action container configuration. */
|
|
4327
|
+
export interface GitHubActionContainerConfiguration {
|
|
4328
|
+
/** The server URL for the container registry where the build will be hosted. */
|
|
4329
|
+
serverUrl?: string;
|
|
4330
|
+
/** The image name for the build. */
|
|
4331
|
+
imageName?: string;
|
|
4332
|
+
/** The username used to upload the image to the container registry. */
|
|
4333
|
+
username?: string;
|
|
4334
|
+
/** The password used to upload the image to the container registry. */
|
|
4335
|
+
password?: string;
|
|
4336
|
+
}
|
|
4337
|
+
/** Triggered Web Job Information. */
|
|
4338
|
+
export interface TriggeredWebJob extends ProxyOnlyResource {
|
|
4339
|
+
/** TriggeredWebJob resource specific properties */
|
|
4340
|
+
properties?: TriggeredWebJobProperties;
|
|
4341
|
+
}
|
|
4342
|
+
/** TriggeredWebJob resource specific properties */
|
|
4343
|
+
export interface TriggeredWebJobProperties {
|
|
4344
|
+
/** Latest job run information. */
|
|
4345
|
+
latest_run?: TriggeredJobRun;
|
|
4346
|
+
/** History URL. */
|
|
4347
|
+
history_url?: string;
|
|
4348
|
+
/** Scheduler Logs URL. */
|
|
4349
|
+
scheduler_logs_url?: string;
|
|
4350
|
+
/** Run command. */
|
|
4351
|
+
run_command?: string;
|
|
4352
|
+
/** Job URL. */
|
|
4353
|
+
url?: string;
|
|
4354
|
+
/** Extra Info URL. */
|
|
4355
|
+
extra_info_url?: string;
|
|
4356
|
+
/** Job type. */
|
|
4357
|
+
web_job_type?: "Continuous" | "Triggered";
|
|
4358
|
+
/** Error information. */
|
|
4359
|
+
error?: string;
|
|
4360
|
+
/** Using SDK? */
|
|
4361
|
+
using_sdk?: boolean;
|
|
4362
|
+
/** Job settings. */
|
|
4363
|
+
settings?: Record<string, Record<string, unknown>>;
|
|
4364
|
+
}
|
|
4365
|
+
/** Triggered Web Job Run Information. */
|
|
4366
|
+
export interface TriggeredJobRun {
|
|
4367
|
+
/** Job ID. */
|
|
4368
|
+
web_job_id?: string;
|
|
4369
|
+
/** Job name. */
|
|
4370
|
+
web_job_name?: string;
|
|
4371
|
+
/** Job status. */
|
|
4372
|
+
status?: "Success" | "Failed" | "Error";
|
|
4373
|
+
/** Start time. */
|
|
4374
|
+
start_time?: Date | string;
|
|
4375
|
+
/** End time. */
|
|
4376
|
+
end_time?: Date | string;
|
|
4377
|
+
/** Job duration. */
|
|
4378
|
+
duration?: string;
|
|
4379
|
+
/** Output URL. */
|
|
4380
|
+
output_url?: string;
|
|
4381
|
+
/** Error URL. */
|
|
4382
|
+
error_url?: string;
|
|
4383
|
+
/** Job URL. */
|
|
4384
|
+
url?: string;
|
|
4385
|
+
/** Job name. */
|
|
4386
|
+
job_name?: string;
|
|
4387
|
+
/** Job trigger. */
|
|
4388
|
+
trigger?: string;
|
|
4389
|
+
}
|
|
4390
|
+
/** Triggered Web Job History. List of Triggered Web Job Run Information elements. */
|
|
4391
|
+
export interface TriggeredJobHistory extends ProxyOnlyResource {
|
|
4392
|
+
/** TriggeredJobHistory resource specific properties */
|
|
4393
|
+
properties?: TriggeredJobHistoryProperties;
|
|
4394
|
+
}
|
|
4395
|
+
/** TriggeredJobHistory resource specific properties */
|
|
4396
|
+
export interface TriggeredJobHistoryProperties {
|
|
4397
|
+
/** List of triggered web job runs. */
|
|
4398
|
+
runs?: Array<TriggeredJobRun>;
|
|
4399
|
+
}
|
|
4400
|
+
/** Web Job Information. */
|
|
4401
|
+
export interface WebJob extends ProxyOnlyResource {
|
|
4402
|
+
/** WebJob resource specific properties */
|
|
4403
|
+
properties?: WebJobProperties;
|
|
4404
|
+
}
|
|
4405
|
+
/** WebJob resource specific properties */
|
|
4406
|
+
export interface WebJobProperties {
|
|
4407
|
+
/** Run command. */
|
|
4408
|
+
run_command?: string;
|
|
4409
|
+
/** Job URL. */
|
|
4410
|
+
url?: string;
|
|
4411
|
+
/** Extra Info URL. */
|
|
4412
|
+
extra_info_url?: string;
|
|
4413
|
+
/** Job type. */
|
|
4414
|
+
web_job_type?: "Continuous" | "Triggered";
|
|
4415
|
+
/** Error information. */
|
|
4416
|
+
error?: string;
|
|
4417
|
+
/** Using SDK? */
|
|
4418
|
+
using_sdk?: boolean;
|
|
4419
|
+
/** Job settings. */
|
|
4420
|
+
settings?: Record<string, Record<string, unknown>>;
|
|
4421
|
+
}
|
|
4422
|
+
//# sourceMappingURL=models.d.ts.map
|