diff --git a/sdk/appservice/arm-appservice/src/models/appServiceCertificateOrdersMappers.ts b/sdk/appservice/arm-appservice/src/models/appServiceCertificateOrdersMappers.ts
index 29020bf9e1c4..b21066089a2c 100644
--- a/sdk/appservice/arm-appservice/src/models/appServiceCertificateOrdersMappers.ts
+++ b/sdk/appservice/arm-appservice/src/models/appServiceCertificateOrdersMappers.ts
@@ -22,6 +22,7 @@ export {
ApplicationLogsConfig,
ApplicationStack,
ApplicationStackResource,
+ AppLogsConfiguration,
AppRegistration,
AppServiceCertificate,
AppServiceCertificateCollection,
@@ -34,6 +35,7 @@ export {
AppServiceEnvironmentResource,
AppServicePlan,
AppServicePlanPatchResource,
+ ArcConfiguration,
ArmIdWrapper,
ArmPlan,
AseV3NetworkingConfiguration,
@@ -113,11 +115,13 @@ export {
EnabledConfig,
ErrorEntity,
Experiments,
+ ExtendedLocation,
Facebook,
FileSystemApplicationLogsConfig,
FileSystemHttpLogsConfig,
FileSystemTokenStore,
ForwardProxy,
+ FrontEndConfiguration,
FunctionAppMajorVersion,
FunctionAppMinorVersion,
FunctionAppRuntimes,
@@ -148,9 +152,12 @@ export {
IpSecurityRestriction,
JwtClaimChecks,
KeyValuePairStringObject,
+ KubeEnvironment,
+ KubeEnvironmentPatchResource,
KubeEnvironmentProfile,
LegacyMicrosoftAccount,
LinuxJavaContainerSettings,
+ LogAnalyticsConfiguration,
Login,
LoginRoutes,
LoginScopes,
diff --git a/sdk/appservice/arm-appservice/src/models/appServiceEnvironmentsMappers.ts b/sdk/appservice/arm-appservice/src/models/appServiceEnvironmentsMappers.ts
index 5bbdb779268f..dee1aaa88c9b 100644
--- a/sdk/appservice/arm-appservice/src/models/appServiceEnvironmentsMappers.ts
+++ b/sdk/appservice/arm-appservice/src/models/appServiceEnvironmentsMappers.ts
@@ -22,6 +22,7 @@ export {
ApplicationLogsConfig,
ApplicationStack,
ApplicationStackResource,
+ AppLogsConfiguration,
AppRegistration,
AppServiceCertificate,
AppServiceCertificateOrder,
@@ -34,6 +35,7 @@ export {
AppServicePlan,
AppServicePlanCollection,
AppServicePlanPatchResource,
+ ArcConfiguration,
ArmIdWrapper,
ArmPlan,
AseV3NetworkingConfiguration,
@@ -117,11 +119,13 @@ export {
EndpointDetail,
ErrorEntity,
Experiments,
+ ExtendedLocation,
Facebook,
FileSystemApplicationLogsConfig,
FileSystemHttpLogsConfig,
FileSystemTokenStore,
ForwardProxy,
+ FrontEndConfiguration,
FunctionAppMajorVersion,
FunctionAppMinorVersion,
FunctionAppRuntimes,
@@ -155,10 +159,13 @@ export {
IpSecurityRestriction,
JwtClaimChecks,
KeyValuePairStringObject,
+ KubeEnvironment,
+ KubeEnvironmentPatchResource,
KubeEnvironmentProfile,
LegacyMicrosoftAccount,
LinuxJavaContainerSettings,
LocalizableString,
+ LogAnalyticsConfiguration,
Login,
LoginRoutes,
LoginScopes,
diff --git a/sdk/appservice/arm-appservice/src/models/appServicePlansMappers.ts b/sdk/appservice/arm-appservice/src/models/appServicePlansMappers.ts
index ca6d6d0f7094..523d7ca048f3 100644
--- a/sdk/appservice/arm-appservice/src/models/appServicePlansMappers.ts
+++ b/sdk/appservice/arm-appservice/src/models/appServicePlansMappers.ts
@@ -22,6 +22,7 @@ export {
ApplicationLogsConfig,
ApplicationStack,
ApplicationStackResource,
+ AppLogsConfiguration,
AppRegistration,
AppServiceCertificate,
AppServiceCertificateOrder,
@@ -33,6 +34,7 @@ export {
AppServicePlan,
AppServicePlanCollection,
AppServicePlanPatchResource,
+ ArcConfiguration,
ArmIdWrapper,
ArmPlan,
AseV3NetworkingConfiguration,
@@ -114,11 +116,13 @@ export {
EnabledConfig,
ErrorEntity,
Experiments,
+ ExtendedLocation,
Facebook,
FileSystemApplicationLogsConfig,
FileSystemHttpLogsConfig,
FileSystemTokenStore,
ForwardProxy,
+ FrontEndConfiguration,
FunctionAppMajorVersion,
FunctionAppMinorVersion,
FunctionAppRuntimes,
@@ -150,10 +154,13 @@ export {
IpSecurityRestriction,
JwtClaimChecks,
KeyValuePairStringObject,
+ KubeEnvironment,
+ KubeEnvironmentPatchResource,
KubeEnvironmentProfile,
LegacyMicrosoftAccount,
LinuxJavaContainerSettings,
LocalizableString,
+ LogAnalyticsConfiguration,
Login,
LoginRoutes,
LoginScopes,
diff --git a/sdk/appservice/arm-appservice/src/models/certificateOrdersDiagnosticsMappers.ts b/sdk/appservice/arm-appservice/src/models/certificateOrdersDiagnosticsMappers.ts
index fe063a06ddb0..af4a57b7b505 100644
--- a/sdk/appservice/arm-appservice/src/models/certificateOrdersDiagnosticsMappers.ts
+++ b/sdk/appservice/arm-appservice/src/models/certificateOrdersDiagnosticsMappers.ts
@@ -22,6 +22,7 @@ export {
ApplicationLogsConfig,
ApplicationStack,
ApplicationStackResource,
+ AppLogsConfiguration,
AppRegistration,
AppServiceCertificate,
AppServiceCertificateOrder,
@@ -32,6 +33,7 @@ export {
AppServiceEnvironmentResource,
AppServicePlan,
AppServicePlanPatchResource,
+ ArcConfiguration,
ArmIdWrapper,
ArmPlan,
AseV3NetworkingConfiguration,
@@ -112,11 +114,13 @@ export {
EnabledConfig,
ErrorEntity,
Experiments,
+ ExtendedLocation,
Facebook,
FileSystemApplicationLogsConfig,
FileSystemHttpLogsConfig,
FileSystemTokenStore,
ForwardProxy,
+ FrontEndConfiguration,
FunctionAppMajorVersion,
FunctionAppMinorVersion,
FunctionAppRuntimes,
@@ -147,9 +151,12 @@ export {
IpSecurityRestriction,
JwtClaimChecks,
KeyValuePairStringObject,
+ KubeEnvironment,
+ KubeEnvironmentPatchResource,
KubeEnvironmentProfile,
LegacyMicrosoftAccount,
LinuxJavaContainerSettings,
+ LogAnalyticsConfiguration,
Login,
LoginRoutes,
LoginScopes,
diff --git a/sdk/appservice/arm-appservice/src/models/certificatesMappers.ts b/sdk/appservice/arm-appservice/src/models/certificatesMappers.ts
index df688decc05f..5237c4061659 100644
--- a/sdk/appservice/arm-appservice/src/models/certificatesMappers.ts
+++ b/sdk/appservice/arm-appservice/src/models/certificatesMappers.ts
@@ -22,6 +22,7 @@ export {
ApplicationLogsConfig,
ApplicationStack,
ApplicationStackResource,
+ AppLogsConfiguration,
AppRegistration,
AppServiceCertificate,
AppServiceCertificateOrder,
@@ -32,6 +33,7 @@ export {
AppServiceEnvironmentResource,
AppServicePlan,
AppServicePlanPatchResource,
+ ArcConfiguration,
ArmIdWrapper,
ArmPlan,
AseV3NetworkingConfiguration,
@@ -112,11 +114,13 @@ export {
EnabledConfig,
ErrorEntity,
Experiments,
+ ExtendedLocation,
Facebook,
FileSystemApplicationLogsConfig,
FileSystemHttpLogsConfig,
FileSystemTokenStore,
ForwardProxy,
+ FrontEndConfiguration,
FunctionAppMajorVersion,
FunctionAppMinorVersion,
FunctionAppRuntimes,
@@ -147,9 +151,12 @@ export {
IpSecurityRestriction,
JwtClaimChecks,
KeyValuePairStringObject,
+ KubeEnvironment,
+ KubeEnvironmentPatchResource,
KubeEnvironmentProfile,
LegacyMicrosoftAccount,
LinuxJavaContainerSettings,
+ LogAnalyticsConfiguration,
Login,
LoginRoutes,
LoginScopes,
diff --git a/sdk/appservice/arm-appservice/src/models/deletedWebAppsMappers.ts b/sdk/appservice/arm-appservice/src/models/deletedWebAppsMappers.ts
index 8924c4c0b6d6..eb8c03733747 100644
--- a/sdk/appservice/arm-appservice/src/models/deletedWebAppsMappers.ts
+++ b/sdk/appservice/arm-appservice/src/models/deletedWebAppsMappers.ts
@@ -22,6 +22,7 @@ export {
ApplicationLogsConfig,
ApplicationStack,
ApplicationStackResource,
+ AppLogsConfiguration,
AppRegistration,
AppServiceCertificate,
AppServiceCertificateOrder,
@@ -32,6 +33,7 @@ export {
AppServiceEnvironmentResource,
AppServicePlan,
AppServicePlanPatchResource,
+ ArcConfiguration,
ArmIdWrapper,
ArmPlan,
AseV3NetworkingConfiguration,
@@ -112,11 +114,13 @@ export {
EnabledConfig,
ErrorEntity,
Experiments,
+ ExtendedLocation,
Facebook,
FileSystemApplicationLogsConfig,
FileSystemHttpLogsConfig,
FileSystemTokenStore,
ForwardProxy,
+ FrontEndConfiguration,
FunctionAppMajorVersion,
FunctionAppMinorVersion,
FunctionAppRuntimes,
@@ -147,9 +151,12 @@ export {
IpSecurityRestriction,
JwtClaimChecks,
KeyValuePairStringObject,
+ KubeEnvironment,
+ KubeEnvironmentPatchResource,
KubeEnvironmentProfile,
LegacyMicrosoftAccount,
LinuxJavaContainerSettings,
+ LogAnalyticsConfiguration,
Login,
LoginRoutes,
LoginScopes,
diff --git a/sdk/appservice/arm-appservice/src/models/diagnosticsMappers.ts b/sdk/appservice/arm-appservice/src/models/diagnosticsMappers.ts
index fcb6f6246f15..90c19d1ed889 100644
--- a/sdk/appservice/arm-appservice/src/models/diagnosticsMappers.ts
+++ b/sdk/appservice/arm-appservice/src/models/diagnosticsMappers.ts
@@ -22,6 +22,7 @@ export {
ApplicationLogsConfig,
ApplicationStack,
ApplicationStackResource,
+ AppLogsConfiguration,
AppRegistration,
AppServiceCertificate,
AppServiceCertificateOrder,
@@ -32,6 +33,7 @@ export {
AppServiceEnvironmentResource,
AppServicePlan,
AppServicePlanPatchResource,
+ ArcConfiguration,
ArmIdWrapper,
ArmPlan,
AseV3NetworkingConfiguration,
@@ -115,11 +117,13 @@ export {
EnabledConfig,
ErrorEntity,
Experiments,
+ ExtendedLocation,
Facebook,
FileSystemApplicationLogsConfig,
FileSystemHttpLogsConfig,
FileSystemTokenStore,
ForwardProxy,
+ FrontEndConfiguration,
FunctionAppMajorVersion,
FunctionAppMinorVersion,
FunctionAppRuntimes,
@@ -150,9 +154,12 @@ export {
IpSecurityRestriction,
JwtClaimChecks,
KeyValuePairStringObject,
+ KubeEnvironment,
+ KubeEnvironmentPatchResource,
KubeEnvironmentProfile,
LegacyMicrosoftAccount,
LinuxJavaContainerSettings,
+ LogAnalyticsConfiguration,
Login,
LoginRoutes,
LoginScopes,
diff --git a/sdk/appservice/arm-appservice/src/models/domainsMappers.ts b/sdk/appservice/arm-appservice/src/models/domainsMappers.ts
index 7b9da321b0eb..09cd310a8da5 100644
--- a/sdk/appservice/arm-appservice/src/models/domainsMappers.ts
+++ b/sdk/appservice/arm-appservice/src/models/domainsMappers.ts
@@ -22,6 +22,7 @@ export {
ApplicationLogsConfig,
ApplicationStack,
ApplicationStackResource,
+ AppLogsConfiguration,
AppRegistration,
AppServiceCertificate,
AppServiceCertificateOrder,
@@ -32,6 +33,7 @@ export {
AppServiceEnvironmentResource,
AppServicePlan,
AppServicePlanPatchResource,
+ ArcConfiguration,
ArmIdWrapper,
ArmPlan,
AseV3NetworkingConfiguration,
@@ -116,11 +118,13 @@ export {
EnabledConfig,
ErrorEntity,
Experiments,
+ ExtendedLocation,
Facebook,
FileSystemApplicationLogsConfig,
FileSystemHttpLogsConfig,
FileSystemTokenStore,
ForwardProxy,
+ FrontEndConfiguration,
FunctionAppMajorVersion,
FunctionAppMinorVersion,
FunctionAppRuntimes,
@@ -151,9 +155,12 @@ export {
IpSecurityRestriction,
JwtClaimChecks,
KeyValuePairStringObject,
+ KubeEnvironment,
+ KubeEnvironmentPatchResource,
KubeEnvironmentProfile,
LegacyMicrosoftAccount,
LinuxJavaContainerSettings,
+ LogAnalyticsConfiguration,
Login,
LoginRoutes,
LoginScopes,
diff --git a/sdk/appservice/arm-appservice/src/models/globalMappers.ts b/sdk/appservice/arm-appservice/src/models/globalMappers.ts
index dfd70683e8aa..06c12eb4faea 100644
--- a/sdk/appservice/arm-appservice/src/models/globalMappers.ts
+++ b/sdk/appservice/arm-appservice/src/models/globalMappers.ts
@@ -22,6 +22,7 @@ export {
ApplicationLogsConfig,
ApplicationStack,
ApplicationStackResource,
+ AppLogsConfiguration,
AppRegistration,
AppServiceCertificate,
AppServiceCertificateOrder,
@@ -32,6 +33,7 @@ export {
AppServiceEnvironmentResource,
AppServicePlan,
AppServicePlanPatchResource,
+ ArcConfiguration,
ArmIdWrapper,
ArmPlan,
AseV3NetworkingConfiguration,
@@ -111,11 +113,13 @@ export {
EnabledConfig,
ErrorEntity,
Experiments,
+ ExtendedLocation,
Facebook,
FileSystemApplicationLogsConfig,
FileSystemHttpLogsConfig,
FileSystemTokenStore,
ForwardProxy,
+ FrontEndConfiguration,
FunctionAppMajorVersion,
FunctionAppMinorVersion,
FunctionAppRuntimes,
@@ -146,9 +150,12 @@ export {
IpSecurityRestriction,
JwtClaimChecks,
KeyValuePairStringObject,
+ KubeEnvironment,
+ KubeEnvironmentPatchResource,
KubeEnvironmentProfile,
LegacyMicrosoftAccount,
LinuxJavaContainerSettings,
+ LogAnalyticsConfiguration,
Login,
LoginRoutes,
LoginScopes,
diff --git a/sdk/appservice/arm-appservice/src/models/index.ts b/sdk/appservice/arm-appservice/src/models/index.ts
index f926c99e1f32..7dddde4ccf3e 100644
--- a/sdk/appservice/arm-appservice/src/models/index.ts
+++ b/sdk/appservice/arm-appservice/src/models/index.ts
@@ -1065,6 +1065,21 @@ export interface DeletedSite extends ProxyOnlyResource {
readonly geoRegionName?: string;
}
+/**
+ * Extended Location.
+ */
+export interface ExtendedLocation {
+ /**
+ * Name of extended location.
+ */
+ name?: string;
+ /**
+ * Type of extended location.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly type?: string;
+}
+
/**
* An interface representing ManagedServiceIdentityUserAssignedIdentitiesValue.
*/
@@ -1105,9 +1120,7 @@ export interface ManagedServiceIdentity {
* dictionary key references will be ARM resource ids in the form:
* '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}
*/
- userAssignedIdentities?: {
- [propertyName: string]: ManagedServiceIdentityUserAssignedIdentitiesValue;
- };
+ userAssignedIdentities?: { [propertyName: string]: ManagedServiceIdentityUserAssignedIdentitiesValue };
}
/**
@@ -1765,6 +1778,14 @@ export interface SiteConfig {
* true if HTTP logging is enabled; otherwise, false.
*/
httpLoggingEnabled?: boolean;
+ /**
+ * Flag to use Managed Identity Creds for ACR pull
+ */
+ acrUseManagedIdentityCreds?: boolean;
+ /**
+ * If using user managed identity, the user managed identity ClientId
+ */
+ acrUserManagedIdentityID?: string;
/**
* HTTP logs directory size limit.
*/
@@ -2233,6 +2254,7 @@ export interface Site extends Resource {
*/
virtualNetworkSubnetId?: string;
identity?: ManagedServiceIdentity;
+ extendedLocation?: ExtendedLocation;
}
/**
@@ -2435,6 +2457,7 @@ export interface AppServicePlan extends Resource {
*/
kubeEnvironmentProfile?: KubeEnvironmentProfile;
sku?: SkuDescription;
+ extendedLocation?: ExtendedLocation;
}
/**
@@ -2588,6 +2611,7 @@ export interface CsmOperationDisplay {
*/
export interface CsmOperationDescription {
name?: string;
+ isDataAction?: boolean;
display?: CsmOperationDisplay;
origin?: string;
properties?: CsmOperationDescriptionProperties;
@@ -3038,219 +3062,52 @@ export interface TopLevelDomainAgreementOption {
}
/**
- * SSL certificate for an app.
+ * Virtual IP mapping.
*/
-export interface Certificate extends Resource {
- /**
- * Certificate password.
- */
- password?: string;
- /**
- * Friendly name of the certificate.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly friendlyName?: string;
- /**
- * Subject name of the certificate.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly subjectName?: string;
- /**
- * Host names the certificate applies to.
- */
- hostNames?: string[];
- /**
- * Pfx blob.
- */
- pfxBlob?: Uint8Array;
- /**
- * App name.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly siteName?: string;
- /**
- * Self link.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly selfLink?: string;
- /**
- * Certificate issuer.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly issuer?: string;
- /**
- * Certificate issue Date.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly issueDate?: Date;
- /**
- * Certificate expiration date.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly expirationDate?: Date;
- /**
- * Certificate thumbprint.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly thumbprint?: string;
- /**
- * Is the certificate valid?.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly valid?: boolean;
- /**
- * Raw bytes of .cer file
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly cerBlob?: Uint8Array;
- /**
- * Public key hash.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly publicKeyHash?: string;
- /**
- * Specification for the App Service Environment to use for the certificate.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly hostingEnvironmentProfile?: HostingEnvironmentProfile;
- /**
- * Key Vault Csm resource Id.
- */
- keyVaultId?: string;
+export interface VirtualIPMapping {
/**
- * Key Vault secret name.
+ * Virtual IP address.
*/
- keyVaultSecretName?: string;
+ virtualIP?: string;
/**
- * Status of the Key Vault secret. Possible values include: 'Initialized',
- * 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed',
- * 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault',
- * 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
- * 'Unknown'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Internal HTTP port.
*/
- readonly keyVaultSecretStatus?: KeyVaultSecretStatus;
+ internalHttpPort?: number;
/**
- * Resource ID of the associated App Service plan, formatted as:
- * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
+ * Internal HTTPS port.
*/
- serverFarmId?: string;
+ internalHttpsPort?: number;
/**
- * CNAME of the certificate to be issued via free certificate
+ * Is virtual IP mapping in use.
*/
- canonicalName?: string;
+ inUse?: boolean;
/**
- * Method of domain validation for free cert
+ * name of the service that virtual IP is assigned to
*/
- domainValidationMethod?: string;
+ serviceName?: string;
}
/**
- * ARM resource for a certificate.
+ * Describes main public IP address and any extra virtual IPs.
*/
-export interface CertificatePatchResource extends ProxyOnlyResource {
- /**
- * Certificate password.
- */
- password?: string;
- /**
- * Friendly name of the certificate.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly friendlyName?: string;
- /**
- * Subject name of the certificate.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly subjectName?: string;
- /**
- * Host names the certificate applies to.
- */
- hostNames?: string[];
- /**
- * Pfx blob.
- */
- pfxBlob?: Uint8Array;
- /**
- * App name.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly siteName?: string;
- /**
- * Self link.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly selfLink?: string;
- /**
- * Certificate issuer.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly issuer?: string;
- /**
- * Certificate issue Date.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly issueDate?: Date;
- /**
- * Certificate expiration date.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly expirationDate?: Date;
- /**
- * Certificate thumbprint.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly thumbprint?: string;
- /**
- * Is the certificate valid?.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly valid?: boolean;
- /**
- * Raw bytes of .cer file
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly cerBlob?: Uint8Array;
- /**
- * Public key hash.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly publicKeyHash?: string;
- /**
- * Specification for the App Service Environment to use for the certificate.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly hostingEnvironmentProfile?: HostingEnvironmentProfile;
- /**
- * Key Vault Csm resource Id.
- */
- keyVaultId?: string;
- /**
- * Key Vault secret name.
- */
- keyVaultSecretName?: string;
+export interface AddressResponse extends ProxyOnlyResource {
/**
- * Status of the Key Vault secret. Possible values include: 'Initialized',
- * 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed',
- * 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault',
- * 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
- * 'Unknown'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Main public virtual IP.
*/
- readonly keyVaultSecretStatus?: KeyVaultSecretStatus;
+ serviceIpAddress?: string;
/**
- * Resource ID of the associated App Service plan, formatted as:
- * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
+ * Virtual Network internal IP address of the App Service Environment if it is in internal
+ * load-balancing mode.
*/
- serverFarmId?: string;
+ internalIpAddress?: string;
/**
- * CNAME of the certificate to be issued via free certificate
+ * IP addresses appearing on outbound connections.
*/
- canonicalName?: string;
+ outboundIpAddresses?: string[];
/**
- * Method of domain validation for free cert
+ * Additional virtual IPs.
*/
- domainValidationMethod?: string;
+ vipMappings?: VirtualIPMapping[];
}
/**
@@ -3356,6559 +3213,7034 @@ export interface AppServiceEnvironment {
}
/**
- * Localizable string object containing the name and a localized value.
+ * App Service Environment ARM resource.
*/
-export interface LocalizableString {
+export interface AppServiceEnvironmentResource extends Resource {
/**
- * Non-localized name.
+ * Provisioning state of the App Service Environment. Possible values include: 'Succeeded',
+ * 'Failed', 'Canceled', 'InProgress', 'Deleting'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- value?: string;
+ readonly provisioningState?: ProvisioningState;
/**
- * Localized name.
+ * Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready',
+ * 'Scaling', 'Deleting'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- localizedValue?: string;
-}
-
-/**
- * Usage of the quota resource.
- */
-export interface CsmUsageQuota {
+ readonly status?: HostingEnvironmentStatus;
/**
- * Units of measurement for the quota resource.
+ * Description of the Virtual Network.
*/
- unit?: string;
+ virtualNetwork: VirtualNetworkProfile;
/**
- * Next reset time for the resource counter.
- */
- nextResetTime?: Date;
+ * Specifies which endpoints to serve internally in the Virtual Network for the App Service
+ * Environment. Possible values include: 'None', 'Web', 'Publishing', 'Web, Publishing'
+ */
+ internalLoadBalancingMode?: LoadBalancingMode;
/**
- * The current value of the resource counter.
+ * Front-end VM size, e.g. "Medium", "Large".
*/
- currentValue?: number;
+ multiSize?: string;
/**
- * The resource limit.
+ * Number of front-end instances.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- limit?: number;
+ readonly multiRoleCount?: number;
/**
- * Quota name.
+ * Number of IP SSL addresses reserved for the App Service Environment.
*/
- name?: LocalizableString;
-}
-
-/**
- * Body of the error response returned from the API.
- */
-export interface ErrorEntity {
+ ipsslAddressCount?: number;
/**
- * Type of error.
+ * DNS suffix of the App Service Environment.
*/
- extendedCode?: string;
+ dnsSuffix?: string;
/**
- * Message template.
+ * Maximum number of VMs in the App Service Environment.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- messageTemplate?: string;
+ readonly maximumNumberOfMachines?: number;
/**
- * Parameters for the template.
+ * Scale factor for front-ends.
*/
- parameters?: string[];
+ frontEndScaleFactor?: number;
/**
- * Inner errors.
+ * true if the App Service Environment is suspended; otherwise, false.
+ * The environment can be suspended, e.g. when the management endpoint is no longer available
+ * (most likely because NSG blocked the incoming traffic).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- innerErrors?: ErrorEntity[];
+ readonly suspended?: boolean;
/**
- * Basic error code.
+ * Custom settings for changing the behavior of the App Service Environment.
*/
- code?: string;
+ clusterSettings?: NameValuePair[];
/**
- * Any details of the error.
+ * User added ip ranges to whitelist on ASE db
*/
- message?: string;
+ userWhitelistedIpRanges?: string[];
+ /**
+ * Flag that displays whether an ASE has linux workers or not
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly hasLinuxWorkers?: boolean;
+ /**
+ * Dedicated Host Count
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly dedicatedHostCount?: number;
}
/**
- * An operation on a resource.
+ * ARM resource for a app service environment.
*/
-export interface Operation {
+export interface AppServiceEnvironmentPatchResource extends ProxyOnlyResource {
/**
- * Operation ID.
+ * Provisioning state of the App Service Environment. Possible values include: 'Succeeded',
+ * 'Failed', 'Canceled', 'InProgress', 'Deleting'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- id?: string;
+ readonly provisioningState?: ProvisioningState;
/**
- * Operation name.
+ * Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready',
+ * 'Scaling', 'Deleting'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- name?: string;
+ readonly status?: HostingEnvironmentStatus;
/**
- * The current status of the operation. Possible values include: 'InProgress', 'Failed',
- * 'Succeeded', 'TimedOut', 'Created'
+ * Description of the Virtual Network.
*/
- status?: OperationStatus;
+ virtualNetwork: VirtualNetworkProfile;
/**
- * Any errors associate with the operation.
+ * Specifies which endpoints to serve internally in the Virtual Network for the App Service
+ * Environment. Possible values include: 'None', 'Web', 'Publishing', 'Web, Publishing'
*/
- errors?: ErrorEntity[];
+ internalLoadBalancingMode?: LoadBalancingMode;
/**
- * Time when operation has started.
+ * Front-end VM size, e.g. "Medium", "Large".
*/
- createdTime?: Date;
+ multiSize?: string;
/**
- * Time when operation has been updated.
+ * Number of front-end instances.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- modifiedTime?: Date;
+ readonly multiRoleCount?: number;
/**
- * Time when operation will expire.
+ * Number of IP SSL addresses reserved for the App Service Environment.
*/
- expirationTime?: Date;
+ ipsslAddressCount?: number;
/**
- * Applicable only for stamp operation ids.
+ * DNS suffix of the App Service Environment.
*/
- geoMasterOperationId?: string;
-}
-
-/**
- * Properties of a private link resource
- */
-export interface PrivateLinkResourceProperties {
+ dnsSuffix?: string;
/**
- * GroupId of a private link resource
+ * Maximum number of VMs in the App Service Environment.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly groupId?: string;
+ readonly maximumNumberOfMachines?: number;
/**
- * RequiredMembers of a private link resource
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Scale factor for front-ends.
*/
- readonly requiredMembers?: string[];
+ frontEndScaleFactor?: number;
/**
- * RequiredZoneNames of a private link resource
+ * true if the App Service Environment is suspended; otherwise, false.
+ * The environment can be suspended, e.g. when the management endpoint is no longer available
+ * (most likely because NSG blocked the incoming traffic).
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly requiredZoneNames?: string[];
-}
-
-/**
- * A private link resource
- */
-export interface PrivateLinkResource {
- id: string;
+ readonly suspended?: boolean;
/**
- * Name of a private link resource
+ * Custom settings for changing the behavior of the App Service Environment.
*/
- name: string;
- type: string;
+ clusterSettings?: NameValuePair[];
/**
- * Properties of a private link resource
+ * User added ip ranges to whitelist on ASE db
*/
- properties: PrivateLinkResourceProperties;
-}
-
-/**
- * Wrapper for a collection of private link resources
- */
-export interface PrivateLinkResourcesWrapper {
- value: PrivateLinkResource[];
+ userWhitelistedIpRanges?: string[];
+ /**
+ * Flag that displays whether an ASE has linux workers or not
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly hasLinuxWorkers?: boolean;
+ /**
+ * Dedicated Host Count
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly dedicatedHostCount?: number;
}
/**
- * Class Representing Solution for problems detected.
+ * Full view of networking configuration for an ASE.
*/
-export interface Solution {
+export interface AseV3NetworkingConfiguration extends ProxyOnlyResource {
/**
- * Solution Id.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- id?: number;
+ readonly windowsOutboundIpAddresses?: string[];
/**
- * Display Name of the solution
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- displayName?: string;
+ readonly linuxOutboundIpAddresses?: string[];
/**
- * Order of the solution.
+ * Property to enable and disable new private endpoint connection creation on ASE
*/
- order?: number;
+ allowNewPrivateEndpointConnections?: boolean;
+}
+
+/**
+ * Current TCP connectivity information from the App Service Environment to a single endpoint.
+ */
+export interface EndpointDetail {
/**
- * Description of the solution
+ * An IP Address that Domain Name currently resolves to.
*/
- description?: string;
+ ipAddress?: string;
/**
- * Type of Solution. Possible values include: 'QuickSolution', 'DeepInvestigation',
- * 'BestPractices'
+ * The port an endpoint is connected to.
*/
- type?: SolutionType;
+ port?: number;
/**
- * Solution Data.
+ * The time in milliseconds it takes for a TCP connection to be created from the App Service
+ * Environment to this IpAddress at this Port.
*/
- data?: NameValuePair[][];
+ latency?: number;
/**
- * Solution Metadata.
+ * Whether it is possible to create a TCP connection from the App Service Environment to this
+ * IpAddress at this Port.
*/
- metadata?: NameValuePair[][];
+ isAccessible?: boolean;
}
/**
- * Class representing Abnormal Time Period detected.
+ * A domain name that a service is reached at, including details of the current connection status.
*/
-export interface DetectorAbnormalTimePeriod {
- /**
- * Start time of the correlated event
- */
- startTime?: Date;
+export interface EndpointDependency {
/**
- * End time of the correlated event
+ * The domain name of the dependency.
*/
- endTime?: Date;
+ domainName?: string;
/**
- * Message describing the event
+ * The IP Addresses and Ports used when connecting to DomainName.
*/
- message?: string;
+ endpointDetails?: EndpointDetail[];
+}
+
+/**
+ * Diagnostics for an App Service Environment.
+ */
+export interface HostingEnvironmentDiagnostics {
/**
- * Represents the name of the Detector
+ * Name/identifier of the diagnostics.
*/
- source?: string;
+ name?: string;
/**
- * Represents the rank of the Detector
+ * Diagnostics output.
*/
- priority?: number;
+ diagnosticsOutput?: string;
+}
+
+/**
+ * The IP Addresses and Ports that require inbound network access to and within the subnet of the
+ * App Service Environment.
+ */
+export interface InboundEnvironmentEndpoint {
/**
- * Downtime metadata
+ * Short text describing the purpose of the network traffic.
*/
- metaData?: NameValuePair[][];
+ description?: string;
/**
- * Represents the type of the Detector. Possible values include: 'ServiceIncident',
- * 'AppDeployment', 'AppCrash', 'RuntimeIssueDetected', 'AseDeployment', 'UserIssue',
- * 'PlatformIssue', 'Other'
+ * The IP addresses that network traffic will originate from in cidr notation.
*/
- type?: IssueType;
+ endpoints?: string[];
/**
- * List of proposed solutions
+ * The ports that network traffic will arrive to the App Service Environment at.
*/
- solutions?: Solution[];
+ ports?: string[];
}
/**
- * Class representing Abnormal Time Period identified in diagnosis
+ * Endpoints accessed for a common purpose that the App Service Environment requires outbound
+ * network access to.
*/
-export interface AbnormalTimePeriod {
+export interface OutboundEnvironmentEndpoint {
/**
- * Start time of the downtime
+ * The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL
+ * Database, and Azure Active Directory.
*/
- startTime?: Date;
+ category?: string;
/**
- * End time of the downtime
+ * The endpoints that the App Service Environment reaches the service at.
*/
- endTime?: Date;
+ endpoints?: EndpointDependency[];
+}
+
+/**
+ * Metrics availability and retention.
+ */
+export interface ResourceMetricAvailability {
/**
- * List of Possible Cause of downtime
+ * Time grain .
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- events?: DetectorAbnormalTimePeriod[];
+ readonly timeGrain?: string;
/**
- * List of proposed solutions
+ * Retention period for the current time grain.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- solutions?: Solution[];
+ readonly retention?: string;
}
/**
- * Class representing detector definition
+ * Metadata for the metrics.
*/
-export interface DetectorDefinition extends ProxyOnlyResource {
+export interface ResourceMetricDefinition extends ProxyOnlyResource {
/**
- * Display name of the detector
+ * Unit of the metric.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly displayName?: string;
+ readonly unit?: string;
/**
- * Description of the detector
+ * Primary aggregation type.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly description?: string;
+ readonly primaryAggregationType?: string;
/**
- * Detector Rank
+ * List of time grains supported for the metric together with retention period.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly rank?: number;
+ readonly metricAvailabilities?: ResourceMetricAvailability[];
/**
- * Flag representing whether detector is enabled or not.
+ * Resource URI.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isEnabled?: boolean;
+ readonly resourceUri?: string;
+ /**
+ * Resource metric definition properties.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly properties?: { [propertyName: string]: string };
}
/**
- * Class representing Diagnostic Metric
+ * SKU discovery information.
*/
-export interface DiagnosticMetricSample {
- /**
- * Time at which metric is measured
- */
- timestamp?: Date;
- /**
- * Role Instance. Null if this counter is not per instance
- * This is returned and should be whichever instance name we desire to be returned
- * i.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0)
- * where RDWORKERNAME is Machine name below and RoleInstance name in parenthesis
- */
- roleInstance?: string;
- /**
- * Total value of the metric. If multiple measurements are made this will have sum of all.
- */
- total?: number;
+export interface SkuInfo {
/**
- * Maximum of the metric sampled during the time period
+ * Resource type that this SKU applies to.
*/
- maximum?: number;
+ resourceType?: string;
/**
- * Minimum of the metric sampled during the time period
+ * Name and tier of the SKU.
*/
- minimum?: number;
+ sku?: SkuDescription;
/**
- * Whether the values are aggregates across all workers or not
+ * Min, max, and default scale values of the SKU.
*/
- isAggregated?: boolean;
+ capacity?: SkuCapacity;
}
/**
- * Class representing Diagnostic Metric information
+ * Stamp capacity information.
*/
-export interface DiagnosticMetricSet {
+export interface StampCapacity {
/**
- * Name of the metric
+ * Name of the stamp.
*/
name?: string;
/**
- * Metric's unit
+ * Available capacity (# of machines, bytes of storage etc...).
+ */
+ availableCapacity?: number;
+ /**
+ * Total capacity (# of machines, bytes of storage etc...).
+ */
+ totalCapacity?: number;
+ /**
+ * Name of the unit.
*/
unit?: string;
/**
- * Start time of the period
+ * Shared/dedicated workers. Possible values include: 'Shared', 'Dedicated', 'Dynamic'
*/
- startTime?: Date;
+ computeMode?: ComputeModeOptions;
/**
- * End time of the period
+ * Size of the machines. Possible values include: 'Small', 'Medium', 'Large', 'D1', 'D2', 'D3',
+ * 'SmallV3', 'MediumV3', 'LargeV3', 'NestedSmall', 'NestedSmallLinux', 'Default'
*/
- endTime?: Date;
+ workerSize?: WorkerSizeOptions;
/**
- * Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D
+ * Size ID of machines:
+ * 0 - Small
+ * 1 - Medium
+ * 2 - Large
*/
- timeGrain?: string;
+ workerSizeId?: number;
/**
- * Collection of metric values for the selected period based on the
- * {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}
+ * If true, it includes basic apps.
+ * Basic apps are not used for capacity allocation.
*/
- values?: DiagnosticMetricSample[];
-}
-
-/**
- * Class representing data source used by the detectors
- */
-export interface DataSource {
+ excludeFromCapacityAllocation?: boolean;
/**
- * Instructions if any for the data source
+ * true if capacity is applicable for all apps; otherwise, false.
*/
- instructions?: string[];
+ isApplicableForAllComputeModes?: boolean;
/**
- * Datasource Uri Links
+ * Shared or Dedicated.
*/
- dataSourceUri?: NameValuePair[];
-}
-
-/**
- * An interface representing ResponseMetaData.
- */
-export interface ResponseMetaData {
+ siteMode?: string;
/**
- * Source of the Data
+ * Is this a linux stamp capacity
*/
- dataSource?: DataSource;
+ isLinux?: boolean;
}
/**
- * Class Representing Detector Evidence used for analysis
+ * Usage of the quota resource.
*/
-export interface AnalysisData {
+export interface Usage extends ProxyOnlyResource {
/**
- * Name of the Detector
+ * Friendly name shown in the UI.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- source?: string;
+ readonly displayName?: string;
/**
- * Detector Definition
+ * Name of the quota resource.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- detectorDefinition?: DetectorDefinition;
+ readonly resourceName?: string;
/**
- * Source Metrics
+ * Units of measurement for the quota resource.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- metrics?: DiagnosticMetricSet[];
+ readonly unit?: string;
/**
- * Additional Source Data
+ * The current value of the resource counter.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- data?: NameValuePair[][];
+ readonly currentValue?: number;
/**
- * Detector Meta Data
+ * The resource limit.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- detectorMetaData?: ResponseMetaData;
-}
-
-/**
- * Definition of Analysis
- */
-export interface AnalysisDefinition extends ProxyOnlyResource {
+ readonly limit?: number;
/**
- * Description of the Analysis
+ * Next reset time for the resource counter.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly description?: string;
+ readonly nextResetTime?: Date;
+ /**
+ * Compute mode used for this usage. Possible values include: 'Shared', 'Dedicated', 'Dynamic'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly computeMode?: ComputeModeOptions;
+ /**
+ * Site mode used for this usage.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly siteMode?: string;
}
/**
- * Class representing a diagnostic analysis done on an application
+ * Worker pool of an App Service Environment ARM resource.
*/
-export interface DiagnosticAnalysis extends ProxyOnlyResource {
+export interface WorkerPoolResource extends ProxyOnlyResource {
/**
- * Start time of the period
+ * Worker size ID for referencing this worker pool.
*/
- startTime?: Date;
+ workerSizeId?: number;
/**
- * End time of the period
+ * Shared or dedicated app hosting. Possible values include: 'Shared', 'Dedicated', 'Dynamic'
*/
- endTime?: Date;
+ computeMode?: ComputeModeOptions;
/**
- * List of time periods.
+ * VM size of the worker pool instances.
*/
- abnormalTimePeriods?: AbnormalTimePeriod[];
+ workerSize?: string;
/**
- * Data by each detector
+ * Number of instances in the worker pool.
*/
- payload?: AnalysisData[];
+ workerCount?: number;
/**
- * Data by each detector for detectors that did not corelate
+ * Names of all instances in the worker pool (read only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- nonCorrelatedDetectors?: DetectorDefinition[];
+ readonly instanceNames?: string[];
+ sku?: SkuDescription;
}
/**
- * Class representing detector definition
+ * Localizable string object containing the name and a localized value.
*/
-export interface DiagnosticCategory extends ProxyOnlyResource {
+export interface LocalizableString {
/**
- * Description of the diagnostic category
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Non-localized name.
*/
- readonly description?: string;
+ value?: string;
+ /**
+ * Localized name.
+ */
+ localizedValue?: string;
}
/**
- * Class representing Response from Diagnostic Detectors
+ * Usage of the quota resource.
*/
-export interface DiagnosticDetectorResponse extends ProxyOnlyResource {
+export interface CsmUsageQuota {
/**
- * Start time of the period
+ * Units of measurement for the quota resource.
*/
- startTime?: Date;
+ unit?: string;
/**
- * End time of the period
+ * Next reset time for the resource counter.
*/
- endTime?: Date;
+ nextResetTime?: Date;
/**
- * Flag representing Issue was detected.
+ * The current value of the resource counter.
*/
- issueDetected?: boolean;
+ currentValue?: number;
/**
- * Detector's definition
+ * The resource limit.
*/
- detectorDefinition?: DetectorDefinition;
+ limit?: number;
/**
- * Metrics provided by the detector
+ * Quota name.
*/
- metrics?: DiagnosticMetricSet[];
- /**
- * List of Correlated events found by the detector
- */
- abnormalTimePeriods?: DetectorAbnormalTimePeriod[];
- /**
- * Additional Data that detector wants to send.
- */
- data?: NameValuePair[][];
- /**
- * Meta Data
- */
- responseMetaData?: ResponseMetaData;
+ name?: LocalizableString;
}
/**
- * App Insights Web App stack settings.
+ * Properties of a private link resource
*/
-export interface AppInsightsWebAppStackSettings {
+export interface PrivateLinkResourceProperties {
/**
- * true if remote Application Insights is supported for the stack; otherwise,
- * false.
+ * GroupId of a private link resource
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isSupported?: boolean;
+ readonly groupId?: string;
/**
- * true if Application Insights is disabled by default for the stack; otherwise,
- * false.
+ * RequiredMembers of a private link resource
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isDefaultOff?: boolean;
+ readonly requiredMembers?: string[];
+ /**
+ * RequiredZoneNames of a private link resource
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly requiredZoneNames?: string[];
}
/**
- * Application stack minor version.
+ * A private link resource
*/
-export interface StackMinorVersion {
- /**
- * Application stack minor version (display only).
- */
- displayVersion?: string;
- /**
- * Application stack minor version (runtime only).
- */
- runtimeVersion?: string;
+export interface PrivateLinkResource {
+ id: string;
/**
- * true if this is the default minor version; otherwise, false.
+ * Name of a private link resource
*/
- isDefault?: boolean;
+ name: string;
+ type: string;
/**
- * true if this supports Remote Debugging, otherwise false.
+ * Properties of a private link resource
*/
- isRemoteDebuggingEnabled?: boolean;
+ properties: PrivateLinkResourceProperties;
}
/**
- * Application stack major version.
+ * Wrapper for a collection of private link resources
*/
-export interface StackMajorVersion {
- /**
- * Application stack major version (display only).
- */
- displayVersion?: string;
- /**
- * Application stack major version (runtime only).
- */
- runtimeVersion?: string;
- /**
- * true if this is the default major version; otherwise, false.
- */
- isDefault?: boolean;
- /**
- * Minor versions associated with the major version.
- */
- minorVersions?: StackMinorVersion[];
- /**
- * true if this supports Application Insights; otherwise, false.
- */
- applicationInsights?: boolean;
- /**
- * true if this stack is in Preview, otherwise false.
- */
- isPreview?: boolean;
- /**
- * true if this stack has been deprecated, otherwise false.
- */
- isDeprecated?: boolean;
- /**
- * true if this stack should be hidden for new customers on portal, otherwise
- * false.
- */
- isHidden?: boolean;
- /**
- *
- *
- *
- * Example: All the function apps need AppSetting: "FUNCTIONS_WORKER_RUNTIME" to be set stack
- * name
- */
- appSettingsDictionary?: { [propertyName: string]: any };
- /**
- *
- *
- *
- * Example: All Linux Function Apps, need Use32BitWorkerProcess to be set to 0
- */
- siteConfigPropertiesDictionary?: { [propertyName: string]: any };
+export interface PrivateLinkResourcesWrapper {
+ value: PrivateLinkResource[];
}
/**
- * Application stack.
+ * Body of the error response returned from the API.
*/
-export interface ApplicationStack {
+export interface ErrorEntity {
/**
- * Application stack name.
+ * Type of error.
*/
- name?: string;
+ extendedCode?: string;
/**
- * Application stack display name.
+ * Message template.
*/
- display?: string;
+ messageTemplate?: string;
/**
- * Application stack dependency.
+ * Parameters for the template.
*/
- dependency?: string;
+ parameters?: string[];
/**
- * List of major versions available.
+ * Inner errors.
*/
- majorVersions?: StackMajorVersion[];
+ innerErrors?: ErrorEntity[];
/**
- * List of frameworks associated with application stack.
+ * Basic error code.
*/
- frameworks?: ApplicationStack[];
+ code?: string;
/**
- * true if this is the stack is deprecated; otherwise, false.
+ * Any details of the error.
*/
- isDeprecated?: ApplicationStack[];
+ message?: string;
}
/**
- * ARM resource for a ApplicationStack.
+ * An operation on a resource.
*/
-export interface ApplicationStackResource extends ProxyOnlyResource {
+export interface Operation {
/**
- * Application stack name.
+ * Operation ID.
*/
- applicationStackResourceName?: string;
+ id?: string;
/**
- * Application stack display name.
+ * Operation name.
*/
- display?: string;
+ name?: string;
/**
- * Application stack dependency.
+ * The current status of the operation. Possible values include: 'InProgress', 'Failed',
+ * 'Succeeded', 'TimedOut', 'Created'
*/
- dependency?: string;
+ status?: OperationStatus;
/**
- * List of major versions available.
+ * Any errors associate with the operation.
*/
- majorVersions?: StackMajorVersion[];
+ errors?: ErrorEntity[];
/**
- * List of frameworks associated with application stack.
+ * Time when operation has started.
*/
- frameworks?: ApplicationStack[];
+ createdTime?: Date;
/**
- * true if this is the stack is deprecated; otherwise, false.
+ * Time when operation has been updated.
*/
- isDeprecated?: ApplicationStack[];
-}
-
-/**
- * GitHub Actions Web App stack settings.
- */
-export interface GitHubActionWebAppStackSettings {
+ modifiedTime?: Date;
/**
- * true if GitHub Actions is supported for the stack; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Time when operation will expire.
*/
- readonly isSupported?: boolean;
+ expirationTime?: Date;
/**
- * The minor version that is supported for GitHub Actions.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Applicable only for stamp operation ids.
*/
- readonly supportedVersion?: string;
+ geoMasterOperationId?: string;
}
/**
- * Site config properties dictionary.
+ * ARM resource for a app service plan.
*/
-export interface SiteConfigPropertiesDictionary {
+export interface AppServicePlanPatchResource extends ProxyOnlyResource {
/**
- * true if use32BitWorkerProcess should be set to true for the stack; otherwise,
- * false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Target worker tier assigned to the App Service plan.
*/
- readonly use32BitWorkerProcess?: boolean;
+ workerTierName?: string;
/**
- * LinuxFxVersion configuration setting.
+ * App Service plan status. Possible values include: 'Ready', 'Pending', 'Creating'
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly linuxFxVersion?: string;
+ readonly status?: StatusOptions;
/**
- * JavaVersion configuration setting.
+ * App Service plan subscription.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly javaVersion?: string;
+ readonly subscription?: string;
/**
- * PowerShellVersion configuration setting.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Specification for the App Service Environment to use for the App Service plan.
*/
- readonly powerShellVersion?: string;
-}
-
-/**
- * Function App runtime settings.
- */
-export interface FunctionAppRuntimeSettings {
+ hostingEnvironmentProfile?: HostingEnvironmentProfile;
/**
- * Function App stack minor version (runtime only).
+ * Maximum number of instances that can be assigned to this App Service plan.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly runtimeVersion?: string;
+ readonly maximumNumberOfWorkers?: number;
/**
- * true if remote debugging is supported for the stack; otherwise,
- * false.
+ * Geographical location for the App Service plan.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly remoteDebuggingSupported?: boolean;
+ readonly geoRegion?: string;
/**
- * Application Insights settings associated with the minor version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * If true, apps assigned to this App Service plan can be scaled independently.
+ * If false, apps assigned to this App Service plan will scale to all instances of
+ * the plan. Default value: false.
*/
- readonly appInsightsSettings?: AppInsightsWebAppStackSettings;
+ perSiteScaling?: boolean;
/**
- * GitHub Actions settings associated with the minor version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was
+ * ElasticPremium sku
*/
- readonly gitHubActionSettings?: GitHubActionWebAppStackSettings;
+ elasticScaleEnabled?: boolean;
/**
- * Application settings associated with the minor version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
*/
- readonly appSettingsDictionary?: { [propertyName: string]: string };
+ maximumElasticWorkerCount?: number;
/**
- * Configuration settings associated with the minor version.
+ * Number of apps assigned to this App Service plan.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly siteConfigPropertiesDictionary?: SiteConfigPropertiesDictionary;
+ readonly numberOfSites?: number;
/**
- * List of supported Functions extension versions.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * If true, this App Service Plan owns spot instances.
*/
- readonly supportedFunctionsExtensionVersions?: string[];
+ isSpot?: boolean;
/**
- * true if the stack is in preview; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The time when the server farm expires. Valid only if it is a spot server farm.
*/
- readonly isPreview?: boolean;
+ spotExpirationTime?: Date;
/**
- * true if the stack is deprecated; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The time when the server farm free offer expires.
*/
- readonly isDeprecated?: boolean;
+ freeOfferExpirationTime?: Date;
/**
- * true if the stack should be hidden; otherwise, false.
+ * Resource group of the App Service plan.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isHidden?: boolean;
+ readonly resourceGroup?: string;
/**
- * End-of-life date for the minor version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * If Linux app service plan true, false otherwise. Default value:
+ * false.
*/
- readonly endOfLifeDate?: Date;
+ reserved?: boolean;
/**
- * true if the stack version is auto-updated; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Obsolete: If Hyper-V container app service plan true, false
+ * otherwise. Default value: false.
*/
- readonly isAutoUpdate?: boolean;
+ isXenon?: boolean;
/**
- * true if the minor version is early-access; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * If Hyper-V container app service plan true, false otherwise. Default
+ * value: false.
*/
- readonly isEarlyAccess?: boolean;
+ hyperV?: boolean;
/**
- * true if the minor version the default; otherwise, false.
+ * Scaling worker count.
+ */
+ targetWorkerCount?: number;
+ /**
+ * Scaling worker size ID.
+ */
+ targetWorkerSizeId?: number;
+ /**
+ * Provisioning state of the App Service Plan. Possible values include: 'Succeeded', 'Failed',
+ * 'Canceled', 'InProgress', 'Deleting'
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isDefault?: boolean;
+ readonly provisioningState?: ProvisioningState;
+ /**
+ * Specification for the Kubernetes Environment to use for the App Service plan.
+ */
+ kubeEnvironmentProfile?: KubeEnvironmentProfile;
}
/**
- * Function App stack runtimes.
+ * Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.
*/
-export interface FunctionAppRuntimes {
+export interface HybridConnectionKey extends ProxyOnlyResource {
/**
- * Linux-specific settings associated with the minor version.
+ * The name of the send key.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly linuxRuntimeSettings?: FunctionAppRuntimeSettings;
+ readonly sendKeyName?: string;
/**
- * Windows-specific settings associated with the minor version.
+ * The value of the send key.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly windowsRuntimeSettings?: FunctionAppRuntimeSettings;
+ readonly sendKeyValue?: string;
}
/**
- * Function App stack minor version.
+ * Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.
*/
-export interface FunctionAppMinorVersion {
- /**
- * Function App stack (display only).
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly displayText?: string;
+export interface HybridConnectionLimits extends ProxyOnlyResource {
/**
- * Function App stack name.
+ * The current number of Hybrid Connections.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly value?: string;
+ readonly current?: number;
/**
- * Settings associated with the minor version.
+ * The maximum number of Hybrid Connections allowed.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly stackSettings?: FunctionAppRuntimes;
+ readonly maximum?: number;
}
/**
- * Function App stack major version.
+ * SSL certificate for an app.
*/
-export interface FunctionAppMajorVersion {
+export interface Certificate extends Resource {
/**
- * Function App stack major version (display only).
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Certificate password.
*/
- readonly displayText?: string;
+ password?: string;
/**
- * Function App stack major version name.
+ * Friendly name of the certificate.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly value?: string;
+ readonly friendlyName?: string;
/**
- * Minor versions associated with the major version.
+ * Subject name of the certificate.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly minorVersions?: FunctionAppMinorVersion[];
-}
-
-/**
- * Function App Stack.
- */
-export interface FunctionAppStack extends ProxyOnlyResource {
+ readonly subjectName?: string;
/**
- * Function App stack location.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Host names the certificate applies to.
*/
- readonly location?: string;
+ hostNames?: string[];
/**
- * Function App stack (display only).
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Pfx blob.
*/
- readonly displayText?: string;
+ pfxBlob?: Uint8Array;
/**
- * Function App stack name.
+ * App name.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly value?: string;
+ readonly siteName?: string;
/**
- * List of major versions available.
+ * Self link.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly majorVersions?: FunctionAppMajorVersion[];
+ readonly selfLink?: string;
/**
- * Function App stack preferred OS. Possible values include: 'Windows', 'Linux'
+ * Certificate issuer.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly preferredOs?: StackPreferredOs;
-}
-
-/**
- * Linux Java Container settings.
- */
-export interface LinuxJavaContainerSettings {
+ readonly issuer?: string;
/**
- * Java 11 version (runtime only).
+ * Certificate issue Date.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly java11Runtime?: string;
+ readonly issueDate?: Date;
/**
- * Java 8 version (runtime only).
+ * Certificate expiration date.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly java8Runtime?: string;
+ readonly expirationDate?: Date;
/**
- * true if the stack is in preview; otherwise, false.
+ * Certificate thumbprint.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isPreview?: boolean;
+ readonly thumbprint?: string;
/**
- * true if the stack is deprecated; otherwise, false.
+ * Is the certificate valid?.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isDeprecated?: boolean;
+ readonly valid?: boolean;
/**
- * true if the stack should be hidden; otherwise, false.
+ * Raw bytes of .cer file
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isHidden?: boolean;
+ readonly cerBlob?: Uint8Array;
/**
- * End-of-life date for the minor version.
+ * Public key hash.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly endOfLifeDate?: Date;
+ readonly publicKeyHash?: string;
/**
- * true if the stack version is auto-updated; otherwise, false.
+ * Specification for the App Service Environment to use for the certificate.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isAutoUpdate?: boolean;
+ readonly hostingEnvironmentProfile?: HostingEnvironmentProfile;
/**
- * true if the minor version is early-access; otherwise, false.
+ * Key Vault Csm resource Id.
+ */
+ keyVaultId?: string;
+ /**
+ * Key Vault secret name.
+ */
+ keyVaultSecretName?: string;
+ /**
+ * Status of the Key Vault secret. Possible values include: 'Initialized',
+ * 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed',
+ * 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault',
+ * 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
+ * 'Unknown'
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isEarlyAccess?: boolean;
+ readonly keyVaultSecretStatus?: KeyVaultSecretStatus;
+ /**
+ * Resource ID of the associated App Service plan, formatted as:
+ * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
+ */
+ serverFarmId?: string;
+ /**
+ * CNAME of the certificate to be issued via free certificate
+ */
+ canonicalName?: string;
+ /**
+ * Method of domain validation for free cert
+ */
+ domainValidationMethod?: string;
}
/**
- * Web App runtime settings.
+ * ARM resource for a certificate.
*/
-export interface WebAppRuntimeSettings {
+export interface CertificatePatchResource extends ProxyOnlyResource {
/**
- * Web App stack minor version (runtime only).
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Certificate password.
*/
- readonly runtimeVersion?: string;
+ password?: string;
/**
- * true if remote debugging is supported for the stack; otherwise,
- * false.
+ * Friendly name of the certificate.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly remoteDebuggingSupported?: boolean;
+ readonly friendlyName?: string;
/**
- * Application Insights settings associated with the minor version.
+ * Subject name of the certificate.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly appInsightsSettings?: AppInsightsWebAppStackSettings;
+ readonly subjectName?: string;
/**
- * GitHub Actions settings associated with the minor version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Host names the certificate applies to.
*/
- readonly gitHubActionSettings?: GitHubActionWebAppStackSettings;
+ hostNames?: string[];
/**
- * true if the stack is in preview; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Pfx blob.
*/
- readonly isPreview?: boolean;
+ pfxBlob?: Uint8Array;
/**
- * true if the stack is deprecated; otherwise, false.
+ * App name.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isDeprecated?: boolean;
+ readonly siteName?: string;
/**
- * true if the stack should be hidden; otherwise, false.
+ * Self link.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isHidden?: boolean;
+ readonly selfLink?: string;
/**
- * End-of-life date for the minor version.
+ * Certificate issuer.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly endOfLifeDate?: Date;
+ readonly issuer?: string;
/**
- * true if the stack version is auto-updated; otherwise, false.
+ * Certificate issue Date.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isAutoUpdate?: boolean;
+ readonly issueDate?: Date;
/**
- * true if the minor version is early-access; otherwise, false.
+ * Certificate expiration date.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isEarlyAccess?: boolean;
-}
-
-/**
- * Windows Java Container settings.
- */
-export interface WindowsJavaContainerSettings {
+ readonly expirationDate?: Date;
/**
- * Java container (runtime only).
+ * Certificate thumbprint.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly javaContainer?: string;
+ readonly thumbprint?: string;
/**
- * Java container version (runtime only).
+ * Is the certificate valid?.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly javaContainerVersion?: string;
+ readonly valid?: boolean;
/**
- * true if the stack is in preview; otherwise, false.
+ * Raw bytes of .cer file
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isPreview?: boolean;
+ readonly cerBlob?: Uint8Array;
/**
- * true if the stack is deprecated; otherwise, false.
+ * Public key hash.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isDeprecated?: boolean;
+ readonly publicKeyHash?: string;
/**
- * true if the stack should be hidden; otherwise, false.
+ * Specification for the App Service Environment to use for the certificate.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly isHidden?: boolean;
+ readonly hostingEnvironmentProfile?: HostingEnvironmentProfile;
/**
- * End-of-life date for the minor version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Key Vault Csm resource Id.
*/
- readonly endOfLifeDate?: Date;
+ keyVaultId?: string;
/**
- * true if the stack version is auto-updated; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Key Vault secret name.
*/
- readonly isAutoUpdate?: boolean;
+ keyVaultSecretName?: string;
/**
- * true if the minor version is early-access; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly isEarlyAccess?: boolean;
-}
-
-/**
- * Web App stack runtimes.
- */
-export interface WebAppRuntimes {
- /**
- * Linux-specific settings associated with the minor version.
+ * Status of the Key Vault secret. Possible values include: 'Initialized',
+ * 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed',
+ * 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault',
+ * 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey',
+ * 'Unknown'
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly linuxRuntimeSettings?: WebAppRuntimeSettings;
+ readonly keyVaultSecretStatus?: KeyVaultSecretStatus;
/**
- * Windows-specific settings associated with the minor version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Resource ID of the associated App Service plan, formatted as:
+ * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
*/
- readonly windowsRuntimeSettings?: WebAppRuntimeSettings;
+ serverFarmId?: string;
/**
- * Linux-specific settings associated with the Java container minor version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * CNAME of the certificate to be issued via free certificate
*/
- readonly linuxContainerSettings?: LinuxJavaContainerSettings;
+ canonicalName?: string;
/**
- * Windows-specific settings associated with the Java container minor version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Method of domain validation for free cert
*/
- readonly windowsContainerSettings?: WindowsJavaContainerSettings;
+ domainValidationMethod?: string;
}
/**
- * Web App stack minor version.
+ * Class Representing Solution for problems detected.
*/
-export interface WebAppMinorVersion {
+export interface Solution {
/**
- * Web App stack minor version (display only).
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Solution Id.
*/
- readonly displayText?: string;
+ id?: number;
/**
- * Web App stack major version name.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Display Name of the solution
*/
- readonly value?: string;
+ displayName?: string;
/**
- * Settings associated with the minor version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Order of the solution.
*/
- readonly stackSettings?: WebAppRuntimes;
-}
-
-/**
- * Web App stack major version.
- */
-export interface WebAppMajorVersion {
+ order?: number;
/**
- * Web App stack major version (display only).
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Description of the solution
*/
- readonly displayText?: string;
+ description?: string;
/**
- * Web App stack major version name.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Type of Solution. Possible values include: 'QuickSolution', 'DeepInvestigation',
+ * 'BestPractices'
*/
- readonly value?: string;
+ type?: SolutionType;
/**
- * Minor versions associated with the major version.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Solution Data.
*/
- readonly minorVersions?: WebAppMinorVersion[];
+ data?: NameValuePair[][];
+ /**
+ * Solution Metadata.
+ */
+ metadata?: NameValuePair[][];
}
/**
- * Web App stack.
+ * Class representing Abnormal Time Period detected.
*/
-export interface WebAppStack extends ProxyOnlyResource {
+export interface DetectorAbnormalTimePeriod {
/**
- * Web App stack location.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Start time of the correlated event
*/
- readonly location?: string;
+ startTime?: Date;
/**
- * Web App stack (display only).
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * End time of the correlated event
*/
- readonly displayText?: string;
+ endTime?: Date;
/**
- * Web App stack name.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Message describing the event
*/
- readonly value?: string;
+ message?: string;
/**
- * List of major versions available.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Represents the name of the Detector
*/
- readonly majorVersions?: WebAppMajorVersion[];
+ source?: string;
/**
- * Web App stack preferred OS. Possible values include: 'Windows', 'Linux'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Represents the rank of the Detector
*/
- readonly preferredOs?: StackPreferredOs;
-}
-
-/**
- * Represents a recommendation result generated by the recommendation engine.
- */
-export interface Recommendation extends ProxyOnlyResource {
+ priority?: number;
/**
- * Timestamp when this instance was created.
+ * Downtime metadata
*/
- creationTime?: Date;
+ metaData?: NameValuePair[][];
/**
- * A GUID value that each recommendation object is associated with.
+ * Represents the type of the Detector. Possible values include: 'ServiceIncident',
+ * 'AppDeployment', 'AppCrash', 'RuntimeIssueDetected', 'AseDeployment', 'UserIssue',
+ * 'PlatformIssue', 'Other'
*/
- recommendationId?: string;
+ type?: IssueType;
/**
- * Full ARM resource ID string that this recommendation object is associated with.
+ * List of proposed solutions
*/
- resourceId?: string;
+ solutions?: Solution[];
+}
+
+/**
+ * Class representing Abnormal Time Period identified in diagnosis
+ */
+export interface AbnormalTimePeriod {
/**
- * Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.
- * Possible values include: 'ServerFarm', 'Subscription', 'WebSite'
+ * Start time of the downtime
*/
- resourceScope?: ResourceScopeType;
+ startTime?: Date;
/**
- * Unique name of the rule.
+ * End time of the downtime
*/
- ruleName?: string;
+ endTime?: Date;
/**
- * UI friendly name of the rule (may not be unique).
+ * List of Possible Cause of downtime
*/
- displayName?: string;
+ events?: DetectorAbnormalTimePeriod[];
/**
- * Recommendation text.
+ * List of proposed solutions
*/
- message?: string;
+ solutions?: Solution[];
+}
+
+/**
+ * Class representing detector definition
+ */
+export interface DetectorDefinition extends ProxyOnlyResource {
/**
- * Level indicating how critical this recommendation can impact. Possible values include:
- * 'Critical', 'Warning', 'Information', 'NonUrgentSuggestion'
+ * Display name of the detector
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- level?: NotificationLevel;
+ readonly displayName?: string;
/**
- * List of channels that this recommendation can apply. Possible values include: 'Notification',
- * 'Api', 'Email', 'Webhook', 'All'
+ * Description of the detector
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- channels?: Channels;
+ readonly description?: string;
/**
- * The list of category tags that this recommendation belongs to.
+ * Detector Rank
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly categoryTags?: string[];
+ readonly rank?: number;
/**
- * Name of action recommended by this object.
+ * Flag representing whether detector is enabled or not.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- actionName?: string;
+ readonly isEnabled?: boolean;
+}
+
+/**
+ * Class representing Diagnostic Metric
+ */
+export interface DiagnosticMetricSample {
/**
- * True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.
+ * Time at which metric is measured
*/
- enabled?: number;
+ timestamp?: Date;
/**
- * The list of states of this recommendation. If it's null then it should be considered "Active".
+ * Role Instance. Null if this counter is not per instance
+ * This is returned and should be whichever instance name we desire to be returned
+ * i.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0)
+ * where RDWORKERNAME is Machine name below and RoleInstance name in parenthesis
*/
- states?: string[];
+ roleInstance?: string;
/**
- * The beginning time in UTC of a range that the recommendation refers to.
+ * Total value of the metric. If multiple measurements are made this will have sum of all.
*/
- startTime?: Date;
+ total?: number;
/**
- * The end time in UTC of a range that the recommendation refers to.
+ * Maximum of the metric sampled during the time period
*/
- endTime?: Date;
+ maximum?: number;
/**
- * When to notify this recommendation next in UTC. Null means that this will never be notified
- * anymore.
+ * Minimum of the metric sampled during the time period
*/
- nextNotificationTime?: Date;
+ minimum?: number;
/**
- * Date and time in UTC when this notification expires.
+ * Whether the values are aggregates across all workers or not
*/
- notificationExpirationTime?: Date;
+ isAggregated?: boolean;
+}
+
+/**
+ * Class representing Diagnostic Metric information
+ */
+export interface DiagnosticMetricSet {
/**
- * Last timestamp in UTC this instance was actually notified. Null means that this recommendation
- * hasn't been notified yet.
+ * Name of the metric
*/
- notifiedTime?: Date;
+ name?: string;
/**
- * A metric value measured by the rule.
+ * Metric's unit
*/
- score?: number;
+ unit?: string;
/**
- * True if this is associated with a dynamically added rule
+ * Start time of the period
*/
- isDynamic?: boolean;
+ startTime?: Date;
/**
- * Extension name of the portal if exists.
+ * End time of the period
*/
- extensionName?: string;
+ endTime?: Date;
/**
- * Deep link to a blade on the portal.
+ * Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D
*/
- bladeName?: string;
+ timeGrain?: string;
/**
- * Forward link to an external document associated with the rule.
+ * Collection of metric values for the selected period based on the
+ * {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}
*/
- forwardLink?: string;
+ values?: DiagnosticMetricSample[];
}
/**
- * Represents a recommendation rule that the recommendation engine can perform.
+ * Class representing data source used by the detectors
*/
-export interface RecommendationRule extends ProxyOnlyResource {
+export interface DataSource {
/**
- * Unique name of the rule.
+ * Instructions if any for the data source
*/
- recommendationName?: string;
+ instructions?: string[];
/**
- * UI friendly name of the rule.
+ * Datasource Uri Links
*/
- displayName?: string;
- /**
- * Localized name of the rule (Good for UI).
- */
- message?: string;
- /**
- * Recommendation ID of an associated recommendation object tied to the rule, if exists.
- * If such an object doesn't exist, it is set to null.
- */
- recommendationId?: string;
- /**
- * Localized detailed description of the rule.
- */
- description?: string;
- /**
- * Name of action that is recommended by this rule in string.
- */
- actionName?: string;
+ dataSourceUri?: NameValuePair[];
+}
+
+/**
+ * An interface representing ResponseMetaData.
+ */
+export interface ResponseMetaData {
/**
- * Level of impact indicating how critical this rule is. Possible values include: 'Critical',
- * 'Warning', 'Information', 'NonUrgentSuggestion'
+ * Source of the Data
*/
- level?: NotificationLevel;
+ dataSource?: DataSource;
+}
+
+/**
+ * Class Representing Detector Evidence used for analysis
+ */
+export interface AnalysisData {
/**
- * List of available channels that this rule applies. Possible values include: 'Notification',
- * 'Api', 'Email', 'Webhook', 'All'
+ * Name of the Detector
*/
- channels?: Channels;
+ source?: string;
/**
- * The list of category tags that this recommendation rule belongs to.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Detector Definition
*/
- readonly categoryTags?: string[];
+ detectorDefinition?: DetectorDefinition;
/**
- * True if this is associated with a dynamically added rule
+ * Source Metrics
*/
- isDynamic?: boolean;
+ metrics?: DiagnosticMetricSet[];
/**
- * Extension name of the portal if exists. Applicable to dynamic rule only.
+ * Additional Source Data
*/
- extensionName?: string;
+ data?: NameValuePair[][];
/**
- * Deep link to a blade on the portal. Applicable to dynamic rule only.
+ * Detector Meta Data
*/
- bladeName?: string;
+ detectorMetaData?: ResponseMetaData;
+}
+
+/**
+ * Definition of Analysis
+ */
+export interface AnalysisDefinition extends ProxyOnlyResource {
/**
- * Forward link to an external document associated with the rule. Applicable to dynamic rule
- * only.
+ * Description of the Analysis
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- forwardLink?: string;
+ readonly description?: string;
}
/**
- * Github access token for Appservice CLI github integration.
+ * Class representing a diagnostic analysis done on an application
*/
-export interface AppserviceGithubToken {
+export interface DiagnosticAnalysis extends ProxyOnlyResource {
/**
- * Github access token for Appservice CLI github integration
+ * Start time of the period
*/
- accessToken?: string;
+ startTime?: Date;
/**
- * Scope of the github access token
+ * End time of the period
*/
- scope?: string;
+ endTime?: Date;
/**
- * token type
+ * List of time periods.
*/
- tokenType?: string;
+ abnormalTimePeriods?: AbnormalTimePeriod[];
/**
- * True if valid github token received, False otherwise
+ * Data by each detector
*/
- gotToken?: boolean;
+ payload?: AnalysisData[];
/**
- * Error message if unable to get token
+ * Data by each detector for detectors that did not corelate
*/
- errorMessage?: string;
+ nonCorrelatedDetectors?: DetectorDefinition[];
}
/**
- * Appservice Github token request content.
+ * Class representing detector definition
*/
-export interface AppserviceGithubTokenRequest {
- /**
- * Code string to exchange for Github Access token
- */
- code: string;
+export interface DiagnosticCategory extends ProxyOnlyResource {
/**
- * State string used for verification.
+ * Description of the diagnostic category
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- state: string;
+ readonly description?: string;
}
/**
- * App Service billing entity that contains information about meter which the Azure billing system
- * utilizes to charge users for services.
+ * Class representing Response from Diagnostic Detectors
*/
-export interface BillingMeter extends ProxyOnlyResource {
+export interface DiagnosticDetectorResponse extends ProxyOnlyResource {
/**
- * Meter GUID onboarded in Commerce
+ * Start time of the period
*/
- meterId?: string;
+ startTime?: Date;
/**
- * Azure Location of billable resource
+ * End time of the period
*/
- billingLocation?: string;
+ endTime?: Date;
/**
- * Short Name from App Service Azure pricing Page
+ * Flag representing Issue was detected.
*/
- shortName?: string;
+ issueDetected?: boolean;
/**
- * Friendly name of the meter
+ * Detector's definition
*/
- friendlyName?: string;
+ detectorDefinition?: DetectorDefinition;
/**
- * App Service ResourceType meter used for
+ * Metrics provided by the detector
*/
- resourceType?: string;
+ metrics?: DiagnosticMetricSet[];
/**
- * App Service OS type meter used for
+ * List of Correlated events found by the detector
*/
- osType?: string;
+ abnormalTimePeriods?: DetectorAbnormalTimePeriod[];
/**
- * Meter Multiplier
+ * Additional Data that detector wants to send.
*/
- multiplier?: number;
-}
-
-/**
- * Object with a list of the resources that need to be moved and the resource group they should be
- * moved to.
- */
-export interface CsmMoveResourceEnvelope {
- targetResourceGroup?: string;
- resources?: string[];
+ data?: NameValuePair[][];
+ /**
+ * Meta Data
+ */
+ responseMetaData?: ResponseMetaData;
}
/**
- * Geographical region.
+ * App Insights Web App stack settings.
*/
-export interface GeoRegion extends ProxyOnlyResource {
- /**
- * Region description.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly description?: string;
+export interface AppInsightsWebAppStackSettings {
/**
- * Display name for region.
+ * true if remote Application Insights is supported for the stack; otherwise,
+ * false.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly displayName?: string;
+ readonly isSupported?: boolean;
/**
- * Display name for region.
+ * true if Application Insights is disabled by default for the stack; otherwise,
+ * false.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly orgDomain?: string;
+ readonly isDefaultOff?: boolean;
}
/**
- * Information needed to create resources on an App Service Environment.
+ * Application stack minor version.
*/
-export interface HostingEnvironmentDeploymentInfo {
+export interface StackMinorVersion {
/**
- * Name of the App Service Environment.
+ * Application stack minor version (display only).
*/
- name?: string;
+ displayVersion?: string;
/**
- * Location of the App Service Environment.
+ * Application stack minor version (runtime only).
*/
- location?: string;
+ runtimeVersion?: string;
+ /**
+ * true if this is the default minor version; otherwise, false.
+ */
+ isDefault?: boolean;
+ /**
+ * true if this supports Remote Debugging, otherwise false.
+ */
+ isRemoteDebuggingEnabled?: boolean;
}
/**
- * List of available locations (regions or App Service Environments) for
- * deployment of App Service resources.
+ * Application stack major version.
*/
-export interface DeploymentLocations {
+export interface StackMajorVersion {
/**
- * Available regions.
+ * Application stack major version (display only).
*/
- locations?: GeoRegion[];
+ displayVersion?: string;
/**
- * Available App Service Environments with full descriptions of the environments.
+ * Application stack major version (runtime only).
*/
- hostingEnvironments?: AppServiceEnvironment[];
+ runtimeVersion?: string;
/**
- * Available App Service Environments with basic information.
+ * true if this is the default major version; otherwise, false.
*/
- hostingEnvironmentDeploymentInfos?: HostingEnvironmentDeploymentInfo[];
-}
-
-/**
- * A Global SKU Description.
- */
-export interface GlobalCsmSkuDescription {
+ isDefault?: boolean;
/**
- * Name of the resource SKU.
+ * Minor versions associated with the major version.
*/
- name?: string;
+ minorVersions?: StackMinorVersion[];
/**
- * Service Tier of the resource SKU.
+ * true if this supports Application Insights; otherwise, false.
*/
- tier?: string;
+ applicationInsights?: boolean;
/**
- * Size specifier of the resource SKU.
+ * true if this stack is in Preview, otherwise false.
*/
- size?: string;
+ isPreview?: boolean;
/**
- * Family code of the resource SKU.
+ * true if this stack has been deprecated, otherwise false.
*/
- family?: string;
+ isDeprecated?: boolean;
/**
- * Min, max, and default scale values of the SKU.
+ * true if this stack should be hidden for new customers on portal, otherwise
+ * false.
*/
- capacity?: SkuCapacity;
+ isHidden?: boolean;
/**
- * Locations of the SKU.
+ *
+ *
+ *
+ * Example: All the function apps need AppSetting: "FUNCTIONS_WORKER_RUNTIME" to be set stack
+ * name
*/
- locations?: string[];
+ appSettingsDictionary?: { [propertyName: string]: any };
/**
- * Capabilities of the SKU, e.g., is traffic manager enabled?
+ *
+ *
+ *
+ * Example: All Linux Function Apps, need Use32BitWorkerProcess to be set to 0
*/
- capabilities?: Capability[];
+ siteConfigPropertiesDictionary?: { [propertyName: string]: any };
}
/**
- * Premier add-on offer.
+ * Application stack.
*/
-export interface PremierAddOnOffer extends ProxyOnlyResource {
+export interface ApplicationStack {
/**
- * Premier add on SKU.
+ * Application stack name.
*/
- sku?: string;
+ name?: string;
/**
- * Premier add on offer Product.
- */
- product?: string;
- /**
- * Premier add on offer Vendor.
- */
- vendor?: string;
- /**
- * true if promotion code is required; otherwise, false.
- */
- promoCodeRequired?: boolean;
- /**
- * Premier add on offer Quota.
- */
- quota?: number;
- /**
- * App Service plans this offer is restricted to. Possible values include: 'None', 'Free',
- * 'Shared', 'Basic', 'Standard', 'Premium'
+ * Application stack display name.
*/
- webHostingPlanRestrictions?: AppServicePlanRestrictions;
+ display?: string;
/**
- * Privacy policy URL.
+ * Application stack dependency.
*/
- privacyPolicyUrl?: string;
+ dependency?: string;
/**
- * Legal terms URL.
+ * List of major versions available.
*/
- legalTermsUrl?: string;
+ majorVersions?: StackMajorVersion[];
/**
- * Marketplace publisher.
+ * List of frameworks associated with application stack.
*/
- marketplacePublisher?: string;
+ frameworks?: ApplicationStack[];
/**
- * Marketplace offer.
+ * true if this is the stack is deprecated; otherwise, false.
*/
- marketplaceOffer?: string;
+ isDeprecated?: ApplicationStack[];
}
/**
- * Information regarding availability of a resource name.
+ * ARM resource for a ApplicationStack.
*/
-export interface ResourceNameAvailability {
+export interface ApplicationStackResource extends ProxyOnlyResource {
/**
- * true indicates name is valid and available. false indicates the name
- * is invalid, unavailable, or both.
+ * Application stack name.
*/
- nameAvailable?: boolean;
+ applicationStackResourceName?: string;
/**
- * Invalid indicates the name provided does not match Azure App Service naming
- * requirements. AlreadyExists indicates that the name is already in use and is
- * therefore unavailable. Possible values include: 'Invalid', 'AlreadyExists'
+ * Application stack display name.
*/
- reason?: InAvailabilityReasonType;
+ display?: string;
/**
- * If reason == invalid, provide the user with the reason why the given name is invalid, and
- * provide the resource naming requirements so that the user can select a valid name. If reason
- * == AlreadyExists, explain that resource name is already in use, and direct them to select a
- * different name.
+ * Application stack dependency.
*/
- message?: string;
-}
-
-/**
- * Resource name availability request content.
- */
-export interface ResourceNameAvailabilityRequest {
+ dependency?: string;
/**
- * Resource name to verify.
+ * List of major versions available.
*/
- name: string;
+ majorVersions?: StackMajorVersion[];
/**
- * Resource type used for verification. Possible values include: 'Site', 'Slot',
- * 'HostingEnvironment', 'PublishingUser', 'Microsoft.Web/sites', 'Microsoft.Web/sites/slots',
- * 'Microsoft.Web/hostingEnvironments', 'Microsoft.Web/publishingUsers'
+ * List of frameworks associated with application stack.
*/
- type: CheckNameResourceTypes;
+ frameworks?: ApplicationStack[];
/**
- * Is fully qualified domain name.
+ * true if this is the stack is deprecated; otherwise, false.
*/
- isFqdn?: boolean;
+ isDeprecated?: ApplicationStack[];
}
/**
- * Collection of SKU information.
+ * GitHub Actions Web App stack settings.
*/
-export interface SkuInfos {
+export interface GitHubActionWebAppStackSettings {
/**
- * Resource type that this SKU applies to.
+ * true if GitHub Actions is supported for the stack; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- resourceType?: string;
+ readonly isSupported?: boolean;
/**
- * List of SKUs the subscription is able to use.
+ * The minor version that is supported for GitHub Actions.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- skus?: GlobalCsmSkuDescription[];
+ readonly supportedVersion?: string;
}
/**
- * The source control OAuth token.
+ * Site config properties dictionary.
*/
-export interface SourceControl extends ProxyOnlyResource {
+export interface SiteConfigPropertiesDictionary {
/**
- * OAuth access token.
+ * true if use32BitWorkerProcess should be set to true for the stack; otherwise,
+ * false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- token?: string;
+ readonly use32BitWorkerProcess?: boolean;
/**
- * OAuth access token secret.
+ * LinuxFxVersion configuration setting.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- tokenSecret?: string;
+ readonly linuxFxVersion?: string;
/**
- * OAuth refresh token.
+ * JavaVersion configuration setting.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- refreshToken?: string;
+ readonly javaVersion?: string;
/**
- * OAuth token expiration.
+ * PowerShellVersion configuration setting.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- expirationTime?: Date;
+ readonly powerShellVersion?: string;
}
/**
- * Resource validation request content.
+ * Function App runtime settings.
*/
-export interface ValidateRequest {
- /**
- * Resource name to verify.
- */
- name: string;
- /**
- * Resource type used for verification. Possible values include: 'ServerFarm', 'Site',
- * 'Microsoft.Web/hostingEnvironments'
- */
- type: ValidateResourceTypes;
- /**
- * Expected location of the resource.
- */
- location: string;
+export interface FunctionAppRuntimeSettings {
/**
- * ARM resource ID of an App Service plan that would host the app.
+ * Function App stack minor version (runtime only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- serverFarmId?: string;
+ readonly runtimeVersion?: string;
/**
- * Name of the target SKU for the App Service plan.
+ * true if remote debugging is supported for the stack; otherwise,
+ * false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- skuName?: string;
+ readonly remoteDebuggingSupported?: boolean;
/**
- * true if App Service plan is for Linux workers; otherwise, false.
+ * Application Insights settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- needLinuxWorkers?: boolean;
+ readonly appInsightsSettings?: AppInsightsWebAppStackSettings;
/**
- * true if App Service plan is for Spot instances; otherwise, false.
+ * GitHub Actions settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- isSpot?: boolean;
+ readonly gitHubActionSettings?: GitHubActionWebAppStackSettings;
/**
- * Target capacity of the App Service plan (number of VMs).
+ * Application settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- capacity?: number;
+ readonly appSettingsDictionary?: { [propertyName: string]: string };
/**
- * Name of App Service Environment where app or App Service plan should be created.
+ * Configuration settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- hostingEnvironment?: string;
+ readonly siteConfigPropertiesDictionary?: SiteConfigPropertiesDictionary;
/**
- * true if App Service plan is running as a windows container
+ * List of supported Functions extension versions.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- isXenon?: boolean;
+ readonly supportedFunctionsExtensionVersions?: string[];
/**
- * Base URL of the container registry
+ * true if the stack is in preview; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- containerRegistryBaseUrl?: string;
+ readonly isPreview?: boolean;
/**
- * Username for to access the container registry
+ * true if the stack is deprecated; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- containerRegistryUsername?: string;
+ readonly isDeprecated?: boolean;
/**
- * Password for to access the container registry
+ * true if the stack should be hidden; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- containerRegistryPassword?: string;
+ readonly isHidden?: boolean;
/**
- * Repository name (image name)
+ * End-of-life date for the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- containerImageRepository?: string;
+ readonly endOfLifeDate?: Date;
/**
- * Image tag
+ * true if the stack version is auto-updated; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- containerImageTag?: string;
+ readonly isAutoUpdate?: boolean;
/**
- * Platform (windows or linux)
+ * true if the minor version is early-access; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- containerImagePlatform?: string;
+ readonly isEarlyAccess?: boolean;
/**
- * App Service Environment Properties
+ * true if the minor version the default; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- appServiceEnvironment?: AppServiceEnvironment;
+ readonly isDefault?: boolean;
}
/**
- * Error details for when validation fails.
+ * Function App stack runtimes.
*/
-export interface ValidateResponseError {
+export interface FunctionAppRuntimes {
/**
- * Validation error code.
+ * Linux-specific settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- code?: string;
+ readonly linuxRuntimeSettings?: FunctionAppRuntimeSettings;
/**
- * Validation error message.
+ * Windows-specific settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- message?: string;
+ readonly windowsRuntimeSettings?: FunctionAppRuntimeSettings;
}
/**
- * Describes the result of resource validation.
+ * Function App stack minor version.
*/
-export interface ValidateResponse {
+export interface FunctionAppMinorVersion {
/**
- * Result of validation.
+ * Function App stack (display only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- status?: string;
+ readonly displayText?: string;
/**
- * Error details for the case when validation fails.
+ * Function App stack name.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- error?: ValidateResponseError;
+ readonly value?: string;
+ /**
+ * Settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly stackSettings?: FunctionAppRuntimes;
}
/**
- * The required set of inputs to validate a VNET
+ * Function App stack major version.
*/
-export interface VnetParameters extends ProxyOnlyResource {
+export interface FunctionAppMajorVersion {
/**
- * The Resource Group of the VNET to be validated
+ * Function App stack major version (display only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- vnetResourceGroup?: string;
+ readonly displayText?: string;
/**
- * The name of the VNET to be validated
+ * Function App stack major version name.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- vnetName?: string;
+ readonly value?: string;
/**
- * The subnet name to be validated
+ * Minor versions associated with the major version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- vnetSubnetName?: string;
- /**
- * The ARM Resource ID of the subnet to validate
- */
- subnetResourceId?: string;
+ readonly minorVersions?: FunctionAppMinorVersion[];
}
/**
- * A class that describes a test that failed during NSG and UDR validation.
+ * Function App Stack.
*/
-export interface VnetValidationTestFailure extends ProxyOnlyResource {
+export interface FunctionAppStack extends ProxyOnlyResource {
/**
- * The name of the test that failed.
+ * Function App stack location.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- testName?: string;
+ readonly location?: string;
/**
- * The details of what caused the failure, e.g. the blocking rule name, etc.
+ * Function App stack (display only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- details?: string;
+ readonly displayText?: string;
+ /**
+ * Function App stack name.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly value?: string;
+ /**
+ * List of major versions available.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly majorVersions?: FunctionAppMajorVersion[];
+ /**
+ * Function App stack preferred OS. Possible values include: 'Windows', 'Linux'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly preferredOs?: StackPreferredOs;
}
/**
- * A class that describes the reason for a validation failure.
+ * Linux Java Container settings.
*/
-export interface VnetValidationFailureDetails extends ProxyOnlyResource {
+export interface LinuxJavaContainerSettings {
/**
- * Text describing the validation outcome.
+ * Java 11 version (runtime only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- message?: string;
+ readonly java11Runtime?: string;
/**
- * A flag describing whether or not validation failed.
+ * Java 8 version (runtime only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- failed?: boolean;
+ readonly java8Runtime?: string;
/**
- * A list of tests that failed in the validation.
+ * true if the stack is in preview; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- failedTests?: VnetValidationTestFailure[];
+ readonly isPreview?: boolean;
/**
- * A list of warnings generated during validation.
+ * true if the stack is deprecated; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- warnings?: VnetValidationTestFailure[];
-}
-
-/**
- * An interface representing AllowedAudiencesValidation.
- */
-export interface AllowedAudiencesValidation extends ProxyOnlyResource {
- allowedAudiences?: string[];
-}
-
-/**
- * Description of site key vault references.
- */
-export interface ApiKVReference extends ProxyOnlyResource {
- reference?: string;
+ readonly isDeprecated?: boolean;
/**
- * Possible values include: 'Initialized', 'Resolved', 'InvalidSyntax', 'MSINotEnabled',
- * 'VaultNotFound', 'SecretNotFound', 'SecretVersionNotFound', 'AccessToKeyVaultDenied',
- * 'OtherReasons', 'FetchTimedOut', 'UnauthorizedClient'
+ * true if the stack should be hidden; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- status?: ResolveStatus;
- vaultName?: string;
- secretName?: string;
- secretVersion?: string;
- identityType?: ManagedServiceIdentity;
- details?: string;
+ readonly isHidden?: boolean;
/**
- * Possible values include: 'KeyVault'
+ * End-of-life date for the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- source?: ConfigReferenceSource;
- activeVersion?: string;
-}
-
-/**
- * The configuration settings of the app registration for providers that have app ids and app
- * secrets
- */
-export interface AppRegistration extends ProxyOnlyResource {
+ readonly endOfLifeDate?: Date;
/**
- * The App ID of the app used for login.
+ * true if the stack version is auto-updated; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- appId?: string;
+ readonly isAutoUpdate?: boolean;
/**
- * The app setting name that contains the app secret.
+ * true if the minor version is early-access; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- appSecretSettingName?: string;
+ readonly isEarlyAccess?: boolean;
}
/**
- * The configuration settings of the registration for the Apple provider
+ * Web App runtime settings.
*/
-export interface AppleRegistration extends ProxyOnlyResource {
+export interface WebAppRuntimeSettings {
/**
- * The Client ID of the app used for login.
+ * Web App stack minor version (runtime only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- clientId?: string;
+ readonly runtimeVersion?: string;
/**
- * The app setting name that contains the client secret.
+ * true if remote debugging is supported for the stack; otherwise,
+ * false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- clientSecretSettingName?: string;
-}
-
-/**
- * The configuration settings of the login flow, including the scopes that should be requested.
- */
-export interface LoginScopes extends ProxyOnlyResource {
+ readonly remoteDebuggingSupported?: boolean;
/**
- * A list of the scopes that should be requested while authenticating.
+ * Application Insights settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- scopes?: string[];
-}
-
-/**
- * The configuration settings of the Apple provider.
- */
-export interface Apple extends ProxyOnlyResource {
+ readonly appInsightsSettings?: AppInsightsWebAppStackSettings;
/**
- * false if the Apple provider should not be enabled despite the set registration;
- * otherwise, true.
+ * GitHub Actions settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- enabled?: boolean;
+ readonly gitHubActionSettings?: GitHubActionWebAppStackSettings;
/**
- * The configuration settings of the Apple registration.
+ * true if the stack is in preview; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- registration?: AppleRegistration;
+ readonly isPreview?: boolean;
/**
- * The configuration settings of the login flow.
+ * true if the stack is deprecated; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- login?: LoginScopes;
-}
-
-/**
- * Application logs to file system configuration.
- */
-export interface FileSystemApplicationLogsConfig {
+ readonly isDeprecated?: boolean;
/**
- * Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'.
- * Default value: 'Off'.
+ * true if the stack should be hidden; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- level?: LogLevel;
-}
-
-/**
- * Application logs to Azure table storage configuration.
- */
-export interface AzureTableStorageApplicationLogsConfig {
+ readonly isHidden?: boolean;
/**
- * Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
+ * End-of-life date for the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- level?: LogLevel;
+ readonly endOfLifeDate?: Date;
/**
- * SAS URL to an Azure table with add/query/delete permissions.
+ * true if the stack version is auto-updated; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- sasUrl: string;
+ readonly isAutoUpdate?: boolean;
+ /**
+ * true if the minor version is early-access; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly isEarlyAccess?: boolean;
}
/**
- * Application logs azure blob storage configuration.
+ * Windows Java Container settings.
*/
-export interface AzureBlobStorageApplicationLogsConfig {
+export interface WindowsJavaContainerSettings {
/**
- * Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
+ * Java container (runtime only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- level?: LogLevel;
+ readonly javaContainer?: string;
/**
- * SAS url to a azure blob container with read/write/list/delete permissions.
+ * Java container version (runtime only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- sasUrl?: string;
+ readonly javaContainerVersion?: string;
/**
- * Retention in days.
- * Remove blobs older than X days.
- * 0 or lower means no retention.
+ * true if the stack is in preview; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- retentionInDays?: number;
-}
-
-/**
- * Application logs configuration.
- */
-export interface ApplicationLogsConfig {
+ readonly isPreview?: boolean;
/**
- * Application logs to file system configuration.
+ * true if the stack is deprecated; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- fileSystem?: FileSystemApplicationLogsConfig;
+ readonly isDeprecated?: boolean;
/**
- * Application logs to azure table storage configuration.
+ * true if the stack should be hidden; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- azureTableStorage?: AzureTableStorageApplicationLogsConfig;
+ readonly isHidden?: boolean;
/**
- * Application logs to blob storage configuration.
+ * End-of-life date for the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- azureBlobStorage?: AzureBlobStorageApplicationLogsConfig;
+ readonly endOfLifeDate?: Date;
+ /**
+ * true if the stack version is auto-updated; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly isAutoUpdate?: boolean;
+ /**
+ * true if the minor version is early-access; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly isEarlyAccess?: boolean;
}
/**
- * The configuration settings of the platform of App Service Authentication/Authorization.
+ * Web App stack runtimes.
*/
-export interface AuthPlatform extends ProxyOnlyResource {
+export interface WebAppRuntimes {
/**
- * true if the Authentication / Authorization feature is enabled for the current
- * app; otherwise, false.
+ * Linux-specific settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- enabled?: boolean;
+ readonly linuxRuntimeSettings?: WebAppRuntimeSettings;
/**
- * The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
- * The setting in this value can control the behavior of certain features in the Authentication /
- * Authorization module.
+ * Windows-specific settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- runtimeVersion?: string;
- /**
- * The path of the config file containing auth settings if they come from a file.
- * If the path is relative, base will the site's root directory.
- */
- configFilePath?: string;
-}
-
-/**
- * The configuration settings of the Azure Active Directory app registration.
- */
-export interface AzureActiveDirectoryRegistration extends ProxyOnlyResource {
- /**
- * The OpenID Connect Issuer URI that represents the entity which issues access tokens for this
- * application.
- * When using Azure Active Directory, this value is the URI of the directory tenant, e.g.
- * https://login.microsoftonline.com/v2.0/{tenant-guid}/.
- * This URI is a case-sensitive identifier for the token issuer.
- * More information on OpenID Connect Discovery:
- * http://openid.net/specs/openid-connect-discovery-1_0.html
- */
- openIdIssuer?: string;
- /**
- * The Client ID of this relying party application, known as the client_id.
- * This setting is required for enabling OpenID Connection authentication with Azure Active
- * Directory or
- * other 3rd party OpenID Connect providers.
- * More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
- */
- clientId?: string;
+ readonly windowsRuntimeSettings?: WebAppRuntimeSettings;
/**
- * The app setting name that contains the client secret of the relying party application.
+ * Linux-specific settings associated with the Java container minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- clientSecretSettingName?: string;
+ readonly linuxContainerSettings?: LinuxJavaContainerSettings;
/**
- * An alternative to the client secret, that is the thumbprint of a certificate used for signing
- * purposes. This property acts as
- * a replacement for the Client Secret. It is also optional.
+ * Windows-specific settings associated with the Java container minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- clientSecretCertificateThumbprint?: string;
+ readonly windowsContainerSettings?: WindowsJavaContainerSettings;
}
/**
- * The configuration settings of the Azure Active Directory login flow.
+ * Web App stack minor version.
*/
-export interface AzureActiveDirectoryLogin extends ProxyOnlyResource {
- disableWWWAuthenticate?: boolean;
+export interface WebAppMinorVersion {
/**
- * Login parameters to send to the OpenID Connect authorization endpoint when
- * a user logs in. Each parameter must be in the form "key=value".
+ * Web App stack minor version (display only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- loginParameters?: string[];
-}
-
-/**
- * The configuration settings of the checks that should be made while validating the JWT Claims.
- */
-export interface JwtClaimChecks extends ProxyOnlyResource {
+ readonly displayText?: string;
/**
- * The list of the allowed groups.
+ * Web App stack major version name.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- allowedGroups?: string[];
+ readonly value?: string;
/**
- * The list of the allowed client applications.
+ * Settings associated with the minor version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- allowedClientApplications?: string[];
+ readonly stackSettings?: WebAppRuntimes;
}
/**
- * The configuration settings of the Azure Active Directory token validation flow.
+ * Web App stack major version.
*/
-export interface AzureActiveDirectoryValidation extends ProxyOnlyResource {
+export interface WebAppMajorVersion {
/**
- * The configuration settings of the checks that should be made while validating the JWT Claims.
+ * Web App stack major version (display only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- jwtClaimChecks?: JwtClaimChecks;
+ readonly displayText?: string;
/**
- * The list of audiences that can make successful authentication/authorization requests.
+ * Web App stack major version name.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- allowedAudiences?: string[];
+ readonly value?: string;
+ /**
+ * Minor versions associated with the major version.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly minorVersions?: WebAppMinorVersion[];
}
/**
- * The configuration settings of the Azure Active directory provider.
+ * Web App stack.
*/
-export interface AzureActiveDirectory extends ProxyOnlyResource {
+export interface WebAppStack extends ProxyOnlyResource {
/**
- * false if the Azure Active Directory provider should not be enabled despite the
- * set registration; otherwise, true.
+ * Web App stack location.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- enabled?: boolean;
+ readonly location?: string;
/**
- * The configuration settings of the Azure Active Directory app registration.
+ * Web App stack (display only).
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- registration?: AzureActiveDirectoryRegistration;
+ readonly displayText?: string;
/**
- * The configuration settings of the Azure Active Directory login flow.
+ * Web App stack name.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- login?: AzureActiveDirectoryLogin;
+ readonly value?: string;
/**
- * The configuration settings of the Azure Active Directory token validation flow.
+ * List of major versions available.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- validation?: AzureActiveDirectoryValidation;
+ readonly majorVersions?: WebAppMajorVersion[];
/**
- * Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st
- * party tooling.
- * This is an internal flag primarily intended to support the Azure Management Portal. Users
- * should not
- * read or write to this property.
+ * Web App stack preferred OS. Possible values include: 'Windows', 'Linux'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- isAutoProvisioned?: boolean;
+ readonly preferredOs?: StackPreferredOs;
}
/**
- * Http logs to azure blob storage configuration.
+ * Represents a recommendation result generated by the recommendation engine.
*/
-export interface AzureBlobStorageHttpLogsConfig {
- /**
- * SAS url to a azure blob container with read/write/list/delete permissions.
- */
- sasUrl?: string;
+export interface Recommendation extends ProxyOnlyResource {
/**
- * Retention in days.
- * Remove blobs older than X days.
- * 0 or lower means no retention.
+ * Timestamp when this instance was created.
*/
- retentionInDays?: number;
+ creationTime?: Date;
/**
- * True if configuration is enabled, false if it is disabled and null if configuration is not
- * set.
+ * A GUID value that each recommendation object is associated with.
*/
- enabled?: boolean;
-}
-
-/**
- * The configuration settings of the registration for the Azure Static Web Apps provider
- */
-export interface AzureStaticWebAppsRegistration extends ProxyOnlyResource {
+ recommendationId?: string;
/**
- * The Client ID of the app used for login.
+ * Full ARM resource ID string that this recommendation object is associated with.
*/
- clientId?: string;
-}
-
-/**
- * The configuration settings of the Azure Static Web Apps provider.
- */
-export interface AzureStaticWebApps extends ProxyOnlyResource {
+ resourceId?: string;
/**
- * false if the Azure Static Web Apps provider should not be enabled despite the set
- * registration; otherwise, true.
+ * Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.
+ * Possible values include: 'ServerFarm', 'Subscription', 'WebSite'
*/
- enabled?: boolean;
+ resourceScope?: ResourceScopeType;
/**
- * The configuration settings of the Azure Static Web Apps registration.
+ * Unique name of the rule.
*/
- registration?: AzureStaticWebAppsRegistration;
-}
-
-/**
- * AzureStorageInfo dictionary resource.
- */
-export interface AzureStoragePropertyDictionaryResource extends ProxyOnlyResource {
+ ruleName?: string;
/**
- * Azure storage accounts.
+ * UI friendly name of the rule (may not be unique).
*/
- properties?: { [propertyName: string]: AzureStorageInfoValue };
-}
-
-/**
- * Database backup settings.
- */
-export interface DatabaseBackupSetting {
+ displayName?: string;
/**
- * Database type (e.g. SqlAzure / MySql). Possible values include: 'SqlAzure', 'MySql',
- * 'LocalMySql', 'PostgreSql'
+ * Recommendation text.
*/
- databaseType: DatabaseType;
- name?: string;
+ message?: string;
/**
- * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.
- * This is used during restore with overwrite connection strings options.
+ * Level indicating how critical this recommendation can impact. Possible values include:
+ * 'Critical', 'Warning', 'Information', 'NonUrgentSuggestion'
*/
- connectionStringName?: string;
+ level?: NotificationLevel;
/**
- * 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.
+ * List of channels that this recommendation can apply. Possible values include: 'Notification',
+ * 'Api', 'Email', 'Webhook', 'All'
*/
- connectionString?: string;
-}
-
-/**
- * Backup description.
- */
-export interface BackupItem extends ProxyOnlyResource {
+ channels?: Channels;
/**
- * Id of the backup.
+ * The list of category tags that this recommendation belongs to.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly backupId?: number;
+ readonly categoryTags?: string[];
/**
- * SAS URL for the storage account container which contains this backup.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Name of action recommended by this object.
*/
- readonly storageAccountUrl?: string;
+ actionName?: string;
/**
- * Name of the blob which contains data for this backup.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.
*/
- readonly blobName?: string;
+ enabled?: number;
/**
- * Name of this backup.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The list of states of this recommendation. If it's null then it should be considered "Active".
*/
- readonly backupItemName?: string;
+ states?: string[];
/**
- * Backup status. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut',
- * 'Created', 'Skipped', 'PartiallySucceeded', 'DeleteInProgress', 'DeleteFailed', 'Deleted'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The beginning time in UTC of a range that the recommendation refers to.
*/
- readonly status?: BackupItemStatus;
+ startTime?: Date;
/**
- * Size of the backup in bytes.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The end time in UTC of a range that the recommendation refers to.
*/
- readonly sizeInBytes?: number;
+ endTime?: Date;
/**
- * Timestamp of the backup creation.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * When to notify this recommendation next in UTC. Null means that this will never be notified
+ * anymore.
*/
- readonly created?: Date;
+ nextNotificationTime?: Date;
/**
- * Details regarding this backup. Might contain an error message.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Date and time in UTC when this notification expires.
*/
- readonly log?: string;
+ notificationExpirationTime?: Date;
/**
- * List of databases included in the backup.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Last timestamp in UTC this instance was actually notified. Null means that this recommendation
+ * hasn't been notified yet.
*/
- readonly databases?: DatabaseBackupSetting[];
+ notifiedTime?: Date;
/**
- * True if this backup has been created due to a schedule being triggered.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * A metric value measured by the rule.
*/
- readonly scheduled?: boolean;
+ score?: number;
/**
- * Timestamp of a last restore operation which used this backup.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * True if this is associated with a dynamically added rule
*/
- readonly lastRestoreTimeStamp?: Date;
+ isDynamic?: boolean;
/**
- * Timestamp when this backup finished.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Extension name of the portal if exists.
*/
- readonly finishedTimeStamp?: Date;
+ extensionName?: string;
/**
- * Unique correlation identifier. Please use this along with the timestamp while communicating
- * with Azure support.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Deep link to a blade on the portal.
*/
- readonly correlationId?: string;
+ bladeName?: string;
/**
- * Size of the original web app which has been backed up.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Forward link to an external document associated with the rule.
*/
- readonly websiteSizeInBytes?: number;
+ forwardLink?: string;
}
/**
- * Description of a backup schedule. Describes how often should be the backup performed and what
- * should be the retention policy.
+ * Represents a recommendation rule that the recommendation engine can perform.
*/
-export interface BackupSchedule {
+export interface RecommendationRule extends ProxyOnlyResource {
/**
- * 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). Default value: 7.
+ * Unique name of the rule.
*/
- frequencyInterval: number;
+ recommendationName?: string;
/**
- * 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). Possible values include:
- * 'Day', 'Hour'. Default value: 'Day'.
+ * UI friendly name of the rule.
*/
- frequencyUnit: FrequencyUnit;
+ displayName?: string;
/**
- * True if the retention policy should always keep at least one backup in the storage account,
- * regardless how old it is; false otherwise. Default value: true.
+ * Localized name of the rule (Good for UI).
*/
- keepAtLeastOneBackup: boolean;
+ message?: string;
/**
- * After how many days backups should be deleted. Default value: 30.
+ * Recommendation ID of an associated recommendation object tied to the rule, if exists.
+ * If such an object doesn't exist, it is set to null.
*/
- retentionPeriodInDays: number;
+ recommendationId?: string;
/**
- * When the schedule should start working.
+ * Localized detailed description of the rule.
*/
- startTime?: Date;
+ description?: string;
/**
- * Last time when this schedule was triggered.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Name of action that is recommended by this rule in string.
*/
- readonly lastExecutionTime?: Date;
-}
-
-/**
- * Description of a backup which will be performed.
- */
-export interface BackupRequest extends ProxyOnlyResource {
+ actionName?: string;
/**
- * Name of the backup.
+ * Level of impact indicating how critical this rule is. Possible values include: 'Critical',
+ * 'Warning', 'Information', 'NonUrgentSuggestion'
*/
- backupName?: string;
+ level?: NotificationLevel;
/**
- * True if the backup schedule is enabled (must be included in that case), false if the backup
- * schedule should be disabled.
+ * List of available channels that this rule applies. Possible values include: 'Notification',
+ * 'Api', 'Email', 'Webhook', 'All'
*/
- enabled?: boolean;
+ channels?: Channels;
/**
- * SAS URL to the container.
+ * The list of category tags that this recommendation rule belongs to.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- storageAccountUrl: string;
+ readonly categoryTags?: string[];
/**
- * Schedule for the backup if it is executed periodically.
+ * True if this is associated with a dynamically added rule
*/
- backupSchedule?: BackupSchedule;
+ isDynamic?: boolean;
/**
- * Databases included in the backup.
+ * Extension name of the portal if exists. Applicable to dynamic rule only.
*/
- databases?: DatabaseBackupSetting[];
+ extensionName?: string;
+ /**
+ * Deep link to a blade on the portal. Applicable to dynamic rule only.
+ */
+ bladeName?: string;
+ /**
+ * Forward link to an external document associated with the rule. Applicable to dynamic rule
+ * only.
+ */
+ forwardLink?: string;
}
/**
- * The configuration settings of the storage of the tokens if blob storage is used.
+ * Used for getting ResourceHealthCheck settings.
*/
-export interface BlobStorageTokenStore extends ProxyOnlyResource {
+export interface ResourceHealthMetadata extends ProxyOnlyResource {
/**
- * The name of the app setting containing the SAS URL of the blob storage containing the tokens.
+ * The category that the resource matches in the RHC Policy File
*/
- sasUrlSettingName?: string;
+ category?: string;
+ /**
+ * Is there a health signal for the resource
+ */
+ signalAvailability?: boolean;
}
/**
- * The configuration settings of the app registration for providers that have client ids and client
- * secrets
+ * Github access token for Appservice CLI github integration.
*/
-export interface ClientRegistration extends ProxyOnlyResource {
+export interface AppserviceGithubToken {
/**
- * The Client ID of the app used for login.
+ * Github access token for Appservice CLI github integration
*/
- clientId?: string;
+ accessToken?: string;
/**
- * The app setting name that contains the client secret.
+ * Scope of the github access token
*/
- clientSecretSettingName?: string;
+ scope?: string;
+ /**
+ * token type
+ */
+ tokenType?: string;
+ /**
+ * True if valid github token received, False otherwise
+ */
+ gotToken?: boolean;
+ /**
+ * Error message if unable to get token
+ */
+ errorMessage?: string;
}
/**
- * Database connection string value to type pair.
+ * Appservice Github token request content.
*/
-export interface ConnStringValueTypePair {
+export interface AppserviceGithubTokenRequest {
/**
- * Value of pair.
+ * Code string to exchange for Github Access token
*/
- value: string;
+ code: string;
/**
- * Type of database. Possible values include: 'MySql', 'SQLServer', 'SQLAzure', 'Custom',
- * 'NotificationHub', 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'
+ * State string used for verification.
*/
- type: ConnectionStringType;
+ state: string;
}
/**
- * String dictionary resource.
+ * App Service billing entity that contains information about meter which the Azure billing system
+ * utilizes to charge users for services.
*/
-export interface ConnectionStringDictionary extends ProxyOnlyResource {
+export interface BillingMeter extends ProxyOnlyResource {
/**
- * Connection strings.
+ * Meter GUID onboarded in Commerce
*/
- properties?: { [propertyName: string]: ConnStringValueTypePair };
+ meterId?: string;
+ /**
+ * Azure Location of billable resource
+ */
+ billingLocation?: string;
+ /**
+ * Short Name from App Service Azure pricing Page
+ */
+ shortName?: string;
+ /**
+ * Friendly name of the meter
+ */
+ friendlyName?: string;
+ /**
+ * App Service ResourceType meter used for
+ */
+ resourceType?: string;
+ /**
+ * App Service OS type meter used for
+ */
+ osType?: string;
+ /**
+ * Meter Multiplier
+ */
+ multiplier?: number;
}
/**
- * An interface representing ContainerCpuUsage.
+ * Object with a list of the resources that need to be moved and the resource group they should be
+ * moved to.
*/
-export interface ContainerCpuUsage {
- totalUsage?: number;
- perCpuUsage?: number[];
- kernelModeUsage?: number;
- userModeUsage?: number;
+export interface CsmMoveResourceEnvelope {
+ targetResourceGroup?: string;
+ resources?: string[];
}
/**
- * An interface representing ContainerThrottlingData.
+ * Geographical region.
*/
-export interface ContainerThrottlingData {
- periods?: number;
- throttledPeriods?: number;
- throttledTime?: number;
+export interface GeoRegion extends ProxyOnlyResource {
+ /**
+ * Region description.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly description?: string;
+ /**
+ * Display name for region.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly displayName?: string;
+ /**
+ * Display name for region.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly orgDomain?: string;
}
/**
- * An interface representing ContainerCpuStatistics.
+ * Information needed to create resources on an App Service Environment.
*/
-export interface ContainerCpuStatistics {
- cpuUsage?: ContainerCpuUsage;
- systemCpuUsage?: number;
- onlineCpuCount?: number;
- throttlingData?: ContainerThrottlingData;
+export interface HostingEnvironmentDeploymentInfo {
+ /**
+ * Name of the App Service Environment.
+ */
+ name?: string;
+ /**
+ * Location of the App Service Environment.
+ */
+ location?: string;
}
/**
- * An interface representing ContainerMemoryStatistics.
+ * List of available locations (regions or App Service Environments) for
+ * deployment of App Service resources.
*/
-export interface ContainerMemoryStatistics {
- usage?: number;
- maxUsage?: number;
- limit?: number;
+export interface DeploymentLocations {
+ /**
+ * Available regions.
+ */
+ locations?: GeoRegion[];
+ /**
+ * Available App Service Environments with full descriptions of the environments.
+ */
+ hostingEnvironments?: AppServiceEnvironment[];
+ /**
+ * Available App Service Environments with basic information.
+ */
+ hostingEnvironmentDeploymentInfos?: HostingEnvironmentDeploymentInfo[];
}
/**
- * An interface representing ContainerNetworkInterfaceStatistics.
+ * A Global SKU Description.
*/
-export interface ContainerNetworkInterfaceStatistics {
- rxBytes?: number;
- rxPackets?: number;
- rxErrors?: number;
- rxDropped?: number;
- txBytes?: number;
- txPackets?: number;
- txErrors?: number;
- txDropped?: number;
-}
-
-/**
- * An interface representing ContainerInfo.
- */
-export interface ContainerInfo {
- currentTimeStamp?: Date;
- previousTimeStamp?: Date;
- currentCpuStats?: ContainerCpuStatistics;
- previousCpuStats?: ContainerCpuStatistics;
- memoryStats?: ContainerMemoryStatistics;
+export interface GlobalCsmSkuDescription {
+ /**
+ * Name of the resource SKU.
+ */
name?: string;
- id?: string;
- eth0?: ContainerNetworkInterfaceStatistics;
+ /**
+ * Service Tier of the resource SKU.
+ */
+ tier?: string;
+ /**
+ * Size specifier of the resource SKU.
+ */
+ size?: string;
+ /**
+ * Family code of the resource SKU.
+ */
+ family?: string;
+ /**
+ * Min, max, and default scale values of the SKU.
+ */
+ capacity?: SkuCapacity;
+ /**
+ * Locations of the SKU.
+ */
+ locations?: string[];
+ /**
+ * Capabilities of the SKU, e.g., is traffic manager enabled?
+ */
+ capabilities?: Capability[];
}
/**
- * Continuous Web Job Information.
+ * Premier add-on offer.
*/
-export interface ContinuousWebJob extends ProxyOnlyResource {
+export interface PremierAddOnOffer extends ProxyOnlyResource {
/**
- * Job status. Possible values include: 'Initializing', 'Starting', 'Running', 'PendingRestart',
- * 'Stopped'
+ * Premier add on SKU.
*/
- status?: ContinuousWebJobStatus;
+ sku?: string;
/**
- * Detailed status.
+ * Premier add on offer Product.
*/
- detailedStatus?: string;
+ product?: string;
/**
- * Log URL.
+ * Premier add on offer Vendor.
*/
- logUrl?: string;
+ vendor?: string;
/**
- * Run command.
+ * true if promotion code is required; otherwise, false.
*/
- runCommand?: string;
+ promoCodeRequired?: boolean;
/**
- * Job URL.
+ * Premier add on offer Quota.
*/
- url?: string;
+ quota?: number;
/**
- * Extra Info URL.
+ * App Service plans this offer is restricted to. Possible values include: 'None', 'Free',
+ * 'Shared', 'Basic', 'Standard', 'Premium'
*/
- extraInfoUrl?: string;
+ webHostingPlanRestrictions?: AppServicePlanRestrictions;
/**
- * Job type. Possible values include: 'Continuous', 'Triggered'
+ * Privacy policy URL.
*/
- webJobType?: WebJobType;
+ privacyPolicyUrl?: string;
/**
- * Error information.
+ * Legal terms URL.
*/
- error?: string;
+ legalTermsUrl?: string;
/**
- * Using SDK?
+ * Marketplace publisher.
*/
- usingSdk?: boolean;
+ marketplacePublisher?: string;
/**
- * Job settings.
+ * Marketplace offer.
*/
- settings?: { [propertyName: string]: any };
+ marketplaceOffer?: string;
}
/**
- * The configuration settings of the session cookie's expiration.
+ * Information regarding availability of a resource name.
*/
-export interface CookieExpiration extends ProxyOnlyResource {
+export interface ResourceNameAvailability {
/**
- * The convention used when determining the session cookie's expiration. Possible values include:
- * 'FixedTime', 'IdentityProviderDerived'
+ * true indicates name is valid and available. false indicates the name
+ * is invalid, unavailable, or both.
*/
- convention?: CookieExpirationConvention;
+ nameAvailable?: boolean;
/**
- * The time after the request is made when the session cookie should expire.
+ * Invalid indicates the name provided does not match Azure App Service naming
+ * requirements. AlreadyExists indicates that the name is already in use and is
+ * therefore unavailable. Possible values include: 'Invalid', 'AlreadyExists'
*/
- timeToExpiration?: string;
-}
-
-/**
- * Publishing Credentials Policies parameters.
- */
-export interface CsmPublishingCredentialsPoliciesEntity extends ProxyOnlyResource {
+ reason?: InAvailabilityReasonType;
/**
- * true to allow access to a publishing method; otherwise, false.
+ * If reason == invalid, provide the user with the reason why the given name is invalid, and
+ * provide the resource naming requirements so that the user can select a valid name. If reason
+ * == AlreadyExists, explain that resource name is already in use, and direct them to select a
+ * different name.
*/
- allow: boolean;
+ message?: string;
}
/**
- * Publishing Credentials Policies collection.
+ * Resource name availability request content.
*/
-export interface CsmPublishingCredentialsPoliciesCollection extends ProxyOnlyResource {
+export interface ResourceNameAvailabilityRequest {
/**
- * Whether FTP is allowed.
+ * Resource name to verify.
*/
- ftp: CsmPublishingCredentialsPoliciesEntity;
+ name: string;
/**
- * Whether Scm Basic Auth is allowed.
+ * Resource type used for verification. Possible values include: 'Site', 'Slot',
+ * 'HostingEnvironment', 'PublishingUser', 'Microsoft.Web/sites', 'Microsoft.Web/sites/slots',
+ * 'Microsoft.Web/hostingEnvironments', 'Microsoft.Web/publishingUsers'
*/
- scm: CsmPublishingCredentialsPoliciesEntity;
+ type: CheckNameResourceTypes;
+ /**
+ * Is fully qualified domain name.
+ */
+ isFqdn?: boolean;
}
/**
- * Publishing options for requested profile.
+ * Collection of SKU information.
*/
-export interface CsmPublishingProfileOptions {
+export interface SkuInfos {
/**
- * Name of the format. Valid values are:
- * FileZilla3
- * WebDeploy -- default
- * Ftp. Possible values include: 'FileZilla3', 'WebDeploy', 'Ftp'
+ * Resource type that this SKU applies to.
*/
- format?: PublishingProfileFormat;
+ resourceType?: string;
/**
- * Include the DisasterRecover endpoint if true
+ * List of SKUs the subscription is able to use.
*/
- includeDisasterRecoveryEndpoints?: boolean;
+ skus?: GlobalCsmSkuDescription[];
}
/**
- * Deployment slot parameters.
+ * The source control OAuth token.
*/
-export interface CsmSlotEntity {
+export interface SourceControl extends ProxyOnlyResource {
/**
- * Destination deployment slot during swap operation.
+ * OAuth access token.
*/
- targetSlot: string;
+ token?: string;
/**
- * true to preserve Virtual Network to the slot during swap; otherwise,
- * false.
+ * OAuth access token secret.
*/
- preserveVnet: boolean;
+ tokenSecret?: string;
+ /**
+ * OAuth refresh token.
+ */
+ refreshToken?: string;
+ /**
+ * OAuth token expiration.
+ */
+ expirationTime?: Date;
}
/**
- * Custom domain analysis.
+ * Resource validation request content.
*/
-export interface CustomHostnameAnalysisResult extends ProxyOnlyResource {
+export interface ValidateRequest {
/**
- * true if hostname is already verified; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Resource name to verify.
*/
- readonly isHostnameAlreadyVerified?: boolean;
+ name: string;
/**
- * DNS verification test result. Possible values include: 'Passed', 'Failed', 'Skipped'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Resource type used for verification. Possible values include: 'ServerFarm', 'Site',
+ * 'Microsoft.Web/hostingEnvironments'
*/
- readonly customDomainVerificationTest?: DnsVerificationTestResult;
+ type: ValidateResourceTypes;
/**
- * Raw failure information if DNS verification fails.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Expected location of the resource.
*/
- readonly customDomainVerificationFailureInfo?: ErrorEntity;
+ location: string;
/**
- * true if there is a conflict on a scale unit; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * ARM resource ID of an App Service plan that would host the app.
*/
- readonly hasConflictOnScaleUnit?: boolean;
+ serverFarmId?: string;
/**
- * true if there is a conflict across subscriptions; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Name of the target SKU for the App Service plan.
*/
- readonly hasConflictAcrossSubscription?: boolean;
+ skuName?: string;
/**
- * Name of the conflicting app on scale unit if it's within the same subscription.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * true if App Service plan is for Linux workers; otherwise, false.
*/
- readonly conflictingAppResourceId?: string;
+ needLinuxWorkers?: boolean;
/**
- * CName records controller can see for this hostname.
+ * true if App Service plan is for Spot instances; otherwise, false.
*/
- cNameRecords?: string[];
+ isSpot?: boolean;
/**
- * TXT records controller can see for this hostname.
+ * Target capacity of the App Service plan (number of VMs).
*/
- txtRecords?: string[];
+ capacity?: number;
/**
- * A records controller can see for this hostname.
+ * Name of App Service Environment where app or App Service plan should be created.
*/
- aRecords?: string[];
+ hostingEnvironment?: string;
/**
- * Alternate CName records controller can see for this hostname.
+ * true if App Service plan is running as a windows container
*/
- alternateCNameRecords?: string[];
+ isXenon?: boolean;
/**
- * Alternate TXT records controller can see for this hostname.
+ * Base URL of the container registry
*/
- alternateTxtRecords?: string[];
-}
-
-/**
- * The authentication client credentials of the custom Open ID Connect provider.
- */
-export interface OpenIdConnectClientCredential extends ProxyOnlyResource {
+ containerRegistryBaseUrl?: string;
/**
- * The method that should be used to authenticate the user. Possible values include:
- * 'ClientSecretPost'
+ * Username for to access the container registry
*/
- method?: ClientCredentialMethod;
+ containerRegistryUsername?: string;
/**
- * The app setting that contains the client secret for the custom Open ID Connect provider.
+ * Password for to access the container registry
*/
- clientSecretSettingName?: string;
-}
-
-/**
- * The configuration settings of the endpoints used for the custom Open ID Connect provider.
- */
-export interface OpenIdConnectConfig extends ProxyOnlyResource {
+ containerRegistryPassword?: string;
/**
- * The endpoint to be used to make an authorization request.
+ * Repository name (image name)
*/
- authorizationEndpoint?: string;
+ containerImageRepository?: string;
/**
- * The endpoint to be used to request a token.
- */
- tokenEndpoint?: string;
- /**
- * The endpoint that issues the token.
+ * Image tag
*/
- issuer?: string;
+ containerImageTag?: string;
/**
- * The endpoint that provides the keys necessary to validate the token.
+ * Platform (windows or linux)
*/
- certificationUri?: string;
+ containerImagePlatform?: string;
/**
- * The endpoint that contains all the configuration endpoints for the provider.
+ * App Service Environment Properties
*/
- wellKnownOpenIdConfiguration?: string;
+ appServiceEnvironment?: AppServiceEnvironment;
}
/**
- * The configuration settings of the app registration for the custom Open ID Connect provider.
+ * Error details for when validation fails.
*/
-export interface OpenIdConnectRegistration extends ProxyOnlyResource {
- /**
- * The client id of the custom Open ID Connect provider.
- */
- clientId?: string;
+export interface ValidateResponseError {
/**
- * The authentication credentials of the custom Open ID Connect provider.
+ * Validation error code.
*/
- clientCredential?: OpenIdConnectClientCredential;
+ code?: string;
/**
- * The configuration settings of the endpoints used for the custom Open ID Connect provider.
+ * Validation error message.
*/
- openIdConnectConfiguration?: OpenIdConnectConfig;
+ message?: string;
}
/**
- * The configuration settings of the login flow of the custom Open ID Connect provider.
+ * Describes the result of resource validation.
*/
-export interface OpenIdConnectLogin extends ProxyOnlyResource {
+export interface ValidateResponse {
/**
- * The name of the claim that contains the users name.
+ * Result of validation.
*/
- nameClaimType?: string;
+ status?: string;
/**
- * A list of the scopes that should be requested while authenticating.
+ * Error details for the case when validation fails.
*/
- scopes?: string[];
+ error?: ValidateResponseError;
}
/**
- * The configuration settings of the custom Open ID Connect provider.
+ * The required set of inputs to validate a VNET
*/
-export interface CustomOpenIdConnectProvider extends ProxyOnlyResource {
+export interface VnetParameters extends ProxyOnlyResource {
/**
- * false if the custom Open ID provider provider should not be enabled; otherwise,
- * true.
+ * The Resource Group of the VNET to be validated
*/
- enabled?: boolean;
+ vnetResourceGroup?: string;
/**
- * The configuration settings of the app registration for the custom Open ID Connect provider.
+ * The name of the VNET to be validated
*/
- registration?: OpenIdConnectRegistration;
+ vnetName?: string;
/**
- * The configuration settings of the login flow of the custom Open ID Connect provider.
+ * The subnet name to be validated
*/
- login?: OpenIdConnectLogin;
+ vnetSubnetName?: string;
+ /**
+ * The ARM Resource ID of the subnet to validate
+ */
+ subnetResourceId?: string;
}
/**
- * Details about restoring a deleted app.
+ * A class that describes a test that failed during NSG and UDR validation.
*/
-export interface DeletedAppRestoreRequest extends ProxyOnlyResource {
- /**
- * ARM resource ID of the deleted app. Example:
- * /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}
- */
- deletedSiteId?: string;
- /**
- * If true, deleted site configuration, in addition to content, will be restored.
- */
- recoverConfiguration?: boolean;
+export interface VnetValidationTestFailure extends ProxyOnlyResource {
/**
- * Point in time to restore the deleted app from, formatted as a DateTime string.
- * If unspecified, default value is the time that the app was deleted.
+ * The name of the test that failed.
*/
- snapshotTime?: string;
+ testName?: string;
/**
- * If true, the snapshot is retrieved from DRSecondary endpoint.
+ * The details of what caused the failure, e.g. the blocking rule name, etc.
*/
- useDRSecondary?: boolean;
+ details?: string;
}
/**
- * User credentials used for publishing activity.
+ * A class that describes the reason for a validation failure.
*/
-export interface Deployment extends ProxyOnlyResource {
+export interface VnetValidationFailureDetails extends ProxyOnlyResource {
/**
- * Deployment status.
+ * Text describing the validation outcome.
*/
- status?: number;
+ message?: string;
/**
- * Details about deployment status.
+ * A flag describing whether or not validation failed.
*/
- message?: string;
+ failed?: boolean;
/**
- * Who authored the deployment.
+ * A list of tests that failed in the validation.
*/
- author?: string;
+ failedTests?: VnetValidationTestFailure[];
/**
- * Who performed the deployment.
+ * A list of warnings generated during validation.
*/
- deployer?: string;
+ warnings?: VnetValidationTestFailure[];
+}
+
+/**
+ * The plan object in Azure Resource Manager, represents a marketplace plan.
+ */
+export interface ArmPlan {
/**
- * Author email.
+ * The name.
*/
- authorEmail?: string;
+ name?: string;
/**
- * Start time.
+ * The publisher.
*/
- startTime?: Date;
+ publisher?: string;
/**
- * End time.
+ * The product.
*/
- endTime?: Date;
+ product?: string;
/**
- * True if deployment is currently active, false if completed and null if not started.
+ * The promotion code.
*/
- active?: boolean;
+ promotionCode?: string;
/**
- * Details on deployment.
+ * Version of product.
*/
- details?: string;
+ version?: string;
}
/**
- * Enabled configuration.
+ * A remote private endpoint connection
*/
-export interface EnabledConfig {
+export interface RemotePrivateEndpointConnection extends ProxyOnlyResource {
/**
- * True if configuration is enabled, false if it is disabled and null if configuration is not
- * set.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- enabled?: boolean;
+ readonly provisioningState?: string;
+ /**
+ * PrivateEndpoint of a remote private endpoint connection
+ */
+ privateEndpoint?: ArmIdWrapper;
+ privateLinkServiceConnectionState?: PrivateLinkConnectionState;
+ /**
+ * Private IPAddresses mapped to the remote private endpoint
+ */
+ ipAddresses?: string[];
}
/**
- * The configuration settings of the Facebook provider.
+ * Message envelope that contains the common Azure resource manager properties and the resource
+ * provider specific content.
*/
-export interface Facebook extends ProxyOnlyResource {
+export interface ResponseMessageEnvelopeRemotePrivateEndpointConnection {
/**
- * false if the Facebook provider should not be enabled despite the set
- * registration; otherwise, true.
+ * Resource Id. Typically ID is populated only for responses to GET requests. Caller is
+ * responsible for passing in this
+ * value for GET requests only.
+ * For example:
+ * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}
*/
- enabled?: boolean;
+ id?: string;
/**
- * The configuration settings of the app registration for the Facebook provider.
+ * Name of resource.
*/
- registration?: AppRegistration;
+ name?: string;
/**
- * The version of the Facebook api to be used while logging in.
+ * Type of resource e.g "Microsoft.Web/sites".
*/
- graphApiVersion?: string;
+ type?: string;
/**
- * The configuration settings of the login flow.
+ * Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia.
*/
- login?: LoginScopes;
-}
-
-/**
- * Http logs to file system configuration.
- */
-export interface FileSystemHttpLogsConfig {
+ location?: string;
/**
- * Maximum size in megabytes that http log files can use.
- * When reached old log files will be removed to make space for new ones.
- * Value can range between 25 and 100.
+ * Tags associated with resource.
*/
- retentionInMb?: number;
+ tags?: { [propertyName: string]: string };
/**
- * Retention in days.
- * Remove files older than X days.
- * 0 or lower means no retention.
+ * Azure resource manager plan.
*/
- retentionInDays?: number;
+ plan?: ArmPlan;
/**
- * True if configuration is enabled, false if it is disabled and null if configuration is not
- * set.
+ * Resource specific properties.
*/
- enabled?: boolean;
-}
-
-/**
- * The configuration settings of the storage of the tokens if a file system is used.
- */
-export interface FileSystemTokenStore extends ProxyOnlyResource {
+ properties?: RemotePrivateEndpointConnection;
/**
- * The directory in which the tokens will be stored.
+ * SKU description of the resource.
*/
- directory?: string;
-}
-
-/**
- * The configuration settings of a forward proxy used to make the requests.
- */
-export interface ForwardProxy extends ProxyOnlyResource {
+ sku?: SkuDescription;
/**
- * The convention used to determine the url of the request made. Possible values include:
- * 'NoProxy', 'Standard', 'Custom'
+ * Azure-AsyncOperation Status info.
*/
- convention?: ForwardProxyConvention;
+ status?: string;
/**
- * The name of the header containing the host of the request.
+ * Azure-AsyncOperation Error info.
*/
- customHostHeaderName?: string;
+ error?: ErrorEntity;
/**
- * The name of the header containing the scheme of the request.
+ * MSI resource
*/
- customProtoHeaderName?: string;
+ identity?: ManagedServiceIdentity;
+ /**
+ * Logical Availability Zones the service is hosted in
+ */
+ zones?: string[];
}
/**
- * Function information.
+ * Build properties for the static site.
*/
-export interface FunctionEnvelope extends ProxyOnlyResource {
+export interface StaticSiteBuildProperties {
/**
- * Function App ID.
+ * The path to the app code within the repository.
*/
- functionAppId?: string;
+ appLocation?: string;
/**
- * Script root path URI.
+ * The path to the api code within the repository.
*/
- scriptRootPathHref?: string;
+ apiLocation?: string;
/**
- * Script URI.
+ * Deprecated: The path of the app artifacts after building (deprecated in favor of
+ * OutputLocation)
*/
- scriptHref?: string;
+ appArtifactLocation?: string;
/**
- * Config URI.
+ * The output path of the app after building.
*/
- configHref?: string;
+ outputLocation?: string;
/**
- * Test data URI.
+ * A custom command to run during deployment of the static content application.
*/
- testDataHref?: string;
+ appBuildCommand?: string;
/**
- * Secrets file URI.
+ * A custom command to run during deployment of the Azure Functions API application.
*/
- secretsFileHref?: string;
+ apiBuildCommand?: string;
/**
- * Function URI.
+ * Skip Github Action workflow generation.
*/
- href?: string;
+ skipGithubActionWorkflowGeneration?: boolean;
/**
- * Config information.
+ * Github Action secret name override.
*/
- config?: any;
+ githubActionSecretNameOverride?: string;
+}
+
+/**
+ * Template Options for the static site.
+ */
+export interface StaticSiteTemplateOptions {
/**
- * File list.
+ * URL of the template repository. The newly generated repository will be based on this one.
*/
- files?: { [propertyName: string]: string };
+ templateRepositoryUrl?: string;
/**
- * Test data used when testing via the Azure Portal.
+ * Owner of the newly generated repository.
*/
- testData?: string;
+ owner?: string;
/**
- * The invocation URL
+ * Name of the newly generated repository.
*/
- invokeUrlTemplate?: string;
+ repositoryName?: string;
/**
- * The function language
+ * Description of the newly generated repository.
*/
- language?: string;
+ description?: string;
/**
- * Gets or sets a value indicating whether the function is disabled
+ * Whether or not the newly generated repository is a private repository. Defaults to false (i.e.
+ * public).
*/
- isDisabled?: boolean;
+ isPrivate?: boolean;
}
/**
- * Function secrets.
+ * A static site user provided function.
*/
-export interface FunctionSecrets {
+export interface StaticSiteUserProvidedFunctionApp extends ProxyOnlyResource {
/**
- * Secret key.
+ * The resource id of the function app registered with the static site
*/
- key?: string;
+ functionAppResourceId?: string;
/**
- * Trigger URL.
+ * The region of the function app registered with the static site
*/
- triggerUrl?: string;
+ functionAppRegion?: string;
+ /**
+ * The date and time on which the function app was registered with the static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly createdOn?: Date;
}
/**
- * The configuration settings of the GitHub provider.
+ * Static Site ARM resource.
*/
-export interface GitHub extends ProxyOnlyResource {
+export interface StaticSiteARMResource extends Resource {
/**
- * false if the GitHub provider should not be enabled despite the set registration;
- * otherwise, true.
+ * The default autogenerated hostname for the static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- enabled?: boolean;
+ readonly defaultHostname?: string;
/**
- * The configuration settings of the app registration for the GitHub provider.
+ * URL for the repository of the static site.
*/
- registration?: ClientRegistration;
+ repositoryUrl?: string;
/**
- * The configuration settings of the login flow.
+ * The target branch in the repository.
*/
- login?: LoginScopes;
-}
-
-/**
- * The GitHub action code configuration.
- */
-export interface GitHubActionCodeConfiguration {
+ branch?: string;
/**
- * Runtime stack is used to determine the workflow file content for code base apps.
+ * The custom domains associated with this static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- runtimeStack?: string;
+ readonly customDomains?: string[];
/**
- * Runtime version is used to determine what build version to set in the workflow file.
+ * A user's github repository token. This is used to setup the Github Actions workflow file and
+ * API secrets.
*/
- runtimeVersion?: string;
-}
-
-/**
- * The GitHub action container configuration.
- */
-export interface GitHubActionContainerConfiguration {
+ repositoryToken?: string;
/**
- * The server URL for the container registry where the build will be hosted.
+ * Build properties to configure on the repository.
*/
- serverUrl?: string;
+ buildProperties?: StaticSiteBuildProperties;
/**
- * The image name for the build.
+ * Private endpoint connections
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- imageName?: string;
+ readonly privateEndpointConnections?: ResponseMessageEnvelopeRemotePrivateEndpointConnection[];
/**
- * The username used to upload the image to the container registry.
+ * State indicating whether staging environments are allowed or not allowed for a static web app.
+ * Possible values include: 'Enabled', 'Disabled'
*/
- username?: string;
+ stagingEnvironmentPolicy?: StagingEnvironmentPolicy;
/**
- * The password used to upload the image to the container registry.
+ * false if config file is locked for this static web app; otherwise,
+ * true.
*/
- password?: string;
-}
-
-/**
- * The GitHub action configuration.
- */
-export interface GitHubActionConfiguration {
+ allowConfigFileUpdates?: boolean;
/**
- * GitHub Action code configuration.
+ * Template options for generating a new repository.
*/
- codeConfiguration?: GitHubActionCodeConfiguration;
+ templateProperties?: StaticSiteTemplateOptions;
/**
- * GitHub Action container configuration.
+ * The content distribution endpoint for the static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- containerConfiguration?: GitHubActionContainerConfiguration;
+ readonly contentDistributionEndpoint?: string;
/**
- * This will help determine the workflow configuration to select.
+ * Identity to use for Key Vault Reference authentication.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- isLinux?: boolean;
+ readonly keyVaultReferenceIdentity?: string;
/**
- * Workflow option to determine whether the workflow file should be generated and written to the
- * repository.
+ * User provided function apps registered with the static site
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- generateWorkflowFile?: boolean;
+ readonly userProvidedFunctionApps?: StaticSiteUserProvidedFunctionApp[];
+ /**
+ * The provider that submitted the last deployment to the primary environment of the static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly provider?: string;
+ sku?: SkuDescription;
+ identity?: ManagedServiceIdentity;
}
/**
- * The configuration settings that determines the validation flow of users using App Service
- * Authentication/Authorization.
+ * Static Site Build ARM resource.
*/
-export interface GlobalValidation extends ProxyOnlyResource {
+export interface StaticSiteBuildARMResource extends ProxyOnlyResource {
/**
- * true if the authentication flow is required any request is made; otherwise,
- * false.
+ * An identifier for the static site build.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- requireAuthentication?: boolean;
+ readonly buildId?: string;
/**
- * The action to take when an unauthenticated client attempts to access the app. Possible values
- * include: 'RedirectToLoginPage', 'AllowAnonymous', 'Return401', 'Return403'
+ * The source branch.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- unauthenticatedClientAction?: UnauthenticatedClientActionV2;
+ readonly sourceBranch?: string;
/**
- * The default authentication provider to use when multiple providers are configured.
- * This setting is only needed if multiple providers are configured and the unauthenticated
- * client
- * action is set to "RedirectToLoginPage".
+ * The title of a pull request that a static site build is related to.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- redirectToProvider?: string;
+ readonly pullRequestTitle?: string;
/**
- * The paths for which unauthenticated flow would not be redirected to the login page.
+ * The hostname for a static site build.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- excludedPaths?: string[];
-}
-
-/**
- * The configuration settings of the Google provider.
- */
-export interface Google extends ProxyOnlyResource {
+ readonly hostname?: string;
/**
- * false if the Google provider should not be enabled despite the set registration;
- * otherwise, true.
+ * When this build was created.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- enabled?: boolean;
+ readonly createdTimeUtc?: Date;
/**
- * The configuration settings of the app registration for the Google provider.
+ * When this build was updated.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- registration?: ClientRegistration;
+ readonly lastUpdatedOn?: Date;
/**
- * The configuration settings of the login flow.
+ * The status of the static site build. Possible values include: 'WaitingForDeployment',
+ * 'Uploading', 'Deploying', 'Ready', 'Failed', 'Deleting', 'Detached'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- login?: LoginScopes;
+ readonly status?: BuildStatus;
/**
- * The configuration settings of the Azure Active Directory token validation flow.
+ * User provided function apps registered with the static site build
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- validation?: AllowedAudiencesValidation;
+ readonly userProvidedFunctionApps?: StaticSiteUserProvidedFunctionApp[];
}
/**
- * Functions host level keys.
+ * Static Site Custom Domain Overview ARM resource.
*/
-export interface HostKeys {
+export interface StaticSiteCustomDomainOverviewARMResource extends ProxyOnlyResource {
/**
- * Secret key.
+ * The domain name for the static site custom domain.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- masterKey?: string;
+ readonly domainName?: string;
/**
- * Host level function keys.
+ * The date and time on which the custom domain was created for the static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- functionKeys?: { [propertyName: string]: string };
+ readonly createdOn?: Date;
/**
- * System keys.
+ * The status of the custom domain. Possible values include: 'RetrievingValidationToken',
+ * 'Validating', 'Adding', 'Ready', 'Failed', 'Deleting'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- systemKeys?: { [propertyName: string]: string };
+ readonly status?: CustomDomainStatus;
+ /**
+ * The TXT record validation token
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly validationToken?: string;
+ /**
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly errorMessage?: string;
}
/**
- * A hostname binding object.
+ * Static Site Custom Domain Request Properties ARM resource.
*/
-export interface HostNameBinding extends ProxyOnlyResource {
+export interface StaticSiteCustomDomainRequestPropertiesARMResource extends ProxyOnlyResource {
/**
- * App Service app name.
+ * Validation method for adding a custom domain. Default value: 'cname-delegation'.
*/
- siteName?: string;
+ validationMethod?: string;
+}
+
+/**
+ * Static Site Function Overview ARM resource.
+ */
+export interface StaticSiteFunctionOverviewARMResource extends ProxyOnlyResource {
/**
- * Fully qualified ARM domain resource URI.
+ * The name for the function
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- domainId?: string;
+ readonly functionName?: string;
/**
- * Azure resource name.
+ * The trigger type of the function. Possible values include: 'HttpTrigger', 'Unknown'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- azureResourceName?: string;
+ readonly triggerType?: TriggerTypes;
+}
+
+/**
+ * ARM resource for a static site when patching
+ */
+export interface StaticSitePatchResource extends ProxyOnlyResource {
/**
- * Azure resource type. Possible values include: 'Website', 'TrafficManager'
+ * The default autogenerated hostname for the static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- azureResourceType?: AzureResourceType;
+ readonly defaultHostname?: string;
/**
- * Custom DNS record type. Possible values include: 'CName', 'A'
+ * URL for the repository of the static site.
*/
- customHostNameDnsRecordType?: CustomHostNameDnsRecordType;
+ repositoryUrl?: string;
/**
- * Hostname type. Possible values include: 'Verified', 'Managed'
+ * The target branch in the repository.
*/
- hostNameType?: HostNameType;
+ branch?: string;
/**
- * SSL type. Possible values include: 'Disabled', 'SniEnabled', 'IpBasedEnabled'
+ * The custom domains associated with this static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- sslState?: SslState;
+ readonly customDomains?: string[];
/**
- * SSL certificate thumbprint
+ * A user's github repository token. This is used to setup the Github Actions workflow file and
+ * API secrets.
*/
- thumbprint?: string;
+ repositoryToken?: string;
/**
- * Virtual IP address assigned to the hostname if IP based SSL is enabled.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Build properties to configure on the repository.
*/
- readonly virtualIP?: string;
-}
-
-/**
- * Http logs configuration.
- */
-export interface HttpLogsConfig {
+ buildProperties?: StaticSiteBuildProperties;
/**
- * Http logs to file system configuration.
+ * Private endpoint connections
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- fileSystem?: FileSystemHttpLogsConfig;
+ readonly privateEndpointConnections?: ResponseMessageEnvelopeRemotePrivateEndpointConnection[];
/**
- * Http logs to azure blob storage configuration.
+ * State indicating whether staging environments are allowed or not allowed for a static web app.
+ * Possible values include: 'Enabled', 'Disabled'
*/
- azureBlobStorage?: AzureBlobStorageHttpLogsConfig;
-}
-
-/**
- * The configuration settings of the paths HTTP requests.
- */
-export interface HttpSettingsRoutes extends ProxyOnlyResource {
+ stagingEnvironmentPolicy?: StagingEnvironmentPolicy;
/**
- * The prefix that should precede all the authentication/authorization paths.
+ * false if config file is locked for this static web app; otherwise,
+ * true.
*/
- apiPrefix?: string;
-}
-
-/**
- * The configuration settings of the HTTP requests for authentication and authorization requests
- * made against App Service Authentication/Authorization.
- */
-export interface HttpSettings extends ProxyOnlyResource {
+ allowConfigFileUpdates?: boolean;
/**
- * false if the authentication/authorization responses not having the HTTPS scheme
- * are permissible; otherwise, true.
+ * Template options for generating a new repository.
*/
- requireHttps?: boolean;
+ templateProperties?: StaticSiteTemplateOptions;
/**
- * The configuration settings of the paths HTTP requests.
+ * The content distribution endpoint for the static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- routes?: HttpSettingsRoutes;
+ readonly contentDistributionEndpoint?: string;
/**
- * The configuration settings of a forward proxy used to make the requests.
+ * Identity to use for Key Vault Reference authentication.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- forwardProxy?: ForwardProxy;
-}
-
-/**
- * The configuration settings of the app registration for the Twitter provider.
- */
-export interface TwitterRegistration extends ProxyOnlyResource {
+ readonly keyVaultReferenceIdentity?: string;
/**
- * The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- * This setting is required for enabling Twitter Sign-In.
- * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
+ * User provided function apps registered with the static site
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- consumerKey?: string;
+ readonly userProvidedFunctionApps?: StaticSiteUserProvidedFunctionApp[];
/**
- * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
- * application used for sign-in.
+ * The provider that submitted the last deployment to the primary environment of the static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- consumerSecretSettingName?: string;
+ readonly provider?: string;
}
/**
- * The configuration settings of the Twitter provider.
+ * Static Site Reset Properties ARM resource.
*/
-export interface Twitter extends ProxyOnlyResource {
+export interface StaticSiteResetPropertiesARMResource extends ProxyOnlyResource {
/**
- * false if the Twitter provider should not be enabled despite the set registration;
- * otherwise, true.
+ * The token which proves admin privileges to the repository.
*/
- enabled?: boolean;
+ repositoryToken?: string;
/**
- * The configuration settings of the app registration for the Twitter provider.
+ * Determines whether the repository should be updated with the new properties.
*/
- registration?: TwitterRegistration;
+ shouldUpdateRepository?: boolean;
}
/**
- * The configuration settings of the legacy Microsoft Account provider.
+ * Static Site User ARM resource.
*/
-export interface LegacyMicrosoftAccount extends ProxyOnlyResource {
+export interface StaticSiteUserARMResource extends ProxyOnlyResource {
/**
- * false if the legacy Microsoft Account provider should not be enabled despite the
- * set registration; otherwise, true.
+ * The identity provider for the static site user.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- enabled?: boolean;
+ readonly provider?: string;
/**
- * The configuration settings of the app registration for the legacy Microsoft Account provider.
+ * The user id for the static site user.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- registration?: ClientRegistration;
+ readonly userId?: string;
/**
- * The configuration settings of the login flow.
+ * The display name for the static site user.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- login?: LoginScopes;
+ readonly displayName?: string;
/**
- * The configuration settings of the legacy Microsoft Account provider token validation flow.
+ * The roles for the static site user, in free-form string format
*/
- validation?: AllowedAudiencesValidation;
+ roles?: string;
}
/**
- * The configuration settings of each of the identity providers used to configure App Service
- * Authentication/Authorization.
+ * Static sites user roles invitation resource.
*/
-export interface IdentityProviders extends ProxyOnlyResource {
- /**
- * The configuration settings of the Azure Active directory provider.
- */
- azureActiveDirectory?: AzureActiveDirectory;
- /**
- * The configuration settings of the Facebook provider.
- */
- facebook?: Facebook;
- /**
- * The configuration settings of the GitHub provider.
- */
- gitHub?: GitHub;
- /**
- * The configuration settings of the Google provider.
- */
- google?: Google;
+export interface StaticSiteUserInvitationRequestResource extends ProxyOnlyResource {
/**
- * The configuration settings of the Twitter provider.
+ * The domain name for the static site custom domain.
*/
- twitter?: Twitter;
+ domain?: string;
/**
- * The map of the name of the alias of each custom Open ID Connect provider to the
- * configuration settings of the custom Open ID Connect provider.
+ * The identity provider for the static site user.
*/
- customOpenIdConnectProviders?: { [propertyName: string]: CustomOpenIdConnectProvider };
+ provider?: string;
/**
- * The configuration settings of the legacy Microsoft Account provider.
+ * The user id for the static site user.
*/
- legacyMicrosoftAccount?: LegacyMicrosoftAccount;
+ userDetails?: string;
/**
- * The configuration settings of the Apple provider.
+ * The roles for the static site user, in free-form string format
*/
- apple?: Apple;
+ roles?: string;
/**
- * The configuration settings of the Azure Static Web Apps provider.
+ * The number of hours the sas token stays valid
*/
- azureStaticWebApps?: AzureStaticWebApps;
+ numHoursToExpiration?: number;
}
/**
- * Function key info.
+ * Static sites user roles invitation link resource.
*/
-export interface KeyInfo {
+export interface StaticSiteUserInvitationResponseResource extends ProxyOnlyResource {
/**
- * Key name
+ * The expiration time of the invitation
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- name?: string;
+ readonly expiresOn?: Date;
/**
- * Key value
+ * The url for the invitation link
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- value?: string;
+ readonly invitationUrl?: string;
}
/**
- * The routes that specify the endpoints used for login and logout requests.
+ * Static Site User Provided Function App ARM resource.
*/
-export interface LoginRoutes extends ProxyOnlyResource {
+export interface StaticSiteUserProvidedFunctionAppARMResource extends ProxyOnlyResource {
/**
- * The endpoint at which a logout request should be made.
+ * The resource id of the function app registered with the static site
*/
- logoutEndpoint?: string;
+ functionAppResourceId?: string;
+ /**
+ * The region of the function app registered with the static site
+ */
+ functionAppRegion?: string;
+ /**
+ * The date and time on which the function app was registered with the static site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly createdOn?: Date;
}
/**
- * The configuration settings of the token store.
+ * Static site zip deployment ARM resource.
*/
-export interface TokenStore extends ProxyOnlyResource {
+export interface StaticSiteZipDeploymentARMResource extends ProxyOnlyResource {
/**
- * true to durably store platform-specific security tokens that are obtained during
- * login flows; otherwise, false.
- * The default is false.
+ * URL for the zipped app content
*/
- enabled?: boolean;
+ appZipUrl?: string;
/**
- * The number of hours after session token expiration that a session token can be used to
- * call the token refresh API. The default is 72 hours.
+ * URL for the zipped api content
*/
- tokenRefreshExtensionHours?: number;
+ apiZipUrl?: string;
/**
- * The configuration settings of the storage of the tokens if a file system is used.
+ * A title to label the deployment
*/
- fileSystem?: FileSystemTokenStore;
+ deploymentTitle?: string;
/**
- * The configuration settings of the storage of the tokens if blob storage is used.
+ * The provider submitting this deployment
*/
- azureBlobStorage?: BlobStorageTokenStore;
+ provider?: string;
+ /**
+ * The language of the api content, if it exists
+ */
+ functionLanguage?: string;
}
/**
- * The configuration settings of the nonce used in the login flow.
+ * Preview for the Static Site Workflow to be generated
*/
-export interface Nonce extends ProxyOnlyResource {
+export interface StaticSitesWorkflowPreview extends ProxyOnlyResource {
/**
- * false if the nonce should not be validated while completing the login flow;
- * otherwise, true.
+ * The path for the workflow file to be generated
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- validateNonce?: boolean;
+ readonly path?: string;
/**
- * The time after the request is made when the nonce should expire.
- */
- nonceExpirationInterval?: string;
+ * The contents for the workflow file to be generated
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly contents?: string;
}
/**
- * The configuration settings of the login flow of users using App Service
- * Authentication/Authorization.
+ * Request entity for previewing the Static Site workflow
*/
-export interface Login extends ProxyOnlyResource {
- /**
- * The routes that specify the endpoints used for login and logout requests.
- */
- routes?: LoginRoutes;
- /**
- * The configuration settings of the token store.
- */
- tokenStore?: TokenStore;
- /**
- * true if the fragments from the request are preserved after the login request is
- * made; otherwise, false.
- */
- preserveUrlFragmentsForLogins?: boolean;
+export interface StaticSitesWorkflowPreviewRequest extends ProxyOnlyResource {
/**
- * 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.
- * This is an advanced setting typically only needed by Windows Store application backends.
- * Note that URLs within the current domain are always implicitly allowed.
+ * URL for the repository of the static site.
*/
- allowedExternalRedirectUrls?: string[];
+ repositoryUrl?: string;
/**
- * The configuration settings of the session cookie's expiration.
+ * The target branch in the repository.
*/
- cookieExpiration?: CookieExpiration;
+ branch?: string;
/**
- * The configuration settings of the nonce used in the login flow.
+ * Build properties to configure on the repository.
*/
- nonce?: Nonce;
+ buildProperties?: StaticSiteBuildProperties;
}
/**
- * MSDeploy ARM PUT information
+ * String list resource.
*/
-export interface MSDeploy extends ProxyOnlyResource {
- /**
- * Package URI
- */
- packageUri?: string;
- /**
- * SQL Connection String
- */
- connectionString?: string;
+export interface StringList extends ProxyOnlyResource {
/**
- * Database Type
+ * List of string resources.
*/
- dbType?: string;
+ properties?: string[];
+}
+
+/**
+ * An interface representing AllowedAudiencesValidation.
+ */
+export interface AllowedAudiencesValidation extends ProxyOnlyResource {
+ allowedAudiences?: string[];
+}
+
+/**
+ * Description of site key vault references.
+ */
+export interface ApiKVReference extends ProxyOnlyResource {
+ reference?: string;
/**
- * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.
+ * Possible values include: 'Initialized', 'Resolved', 'InvalidSyntax', 'MSINotEnabled',
+ * 'VaultNotFound', 'SecretNotFound', 'SecretVersionNotFound', 'AccessToKeyVaultDenied',
+ * 'OtherReasons', 'FetchTimedOut', 'UnauthorizedClient'
*/
- setParametersXmlFileUri?: string;
+ status?: ResolveStatus;
+ vaultName?: string;
+ secretName?: string;
+ secretVersion?: string;
+ identityType?: ManagedServiceIdentity;
+ details?: string;
/**
- * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.
+ * Possible values include: 'KeyVault'
*/
- setParameters?: { [propertyName: string]: string };
+ source?: ConfigReferenceSource;
+ activeVersion?: string;
+}
+
+/**
+ * The configuration settings of the app registration for providers that have app ids and app
+ * secrets
+ */
+export interface AppRegistration extends ProxyOnlyResource {
/**
- * Controls whether the MSDeploy operation skips the App_Data directory.
- * If set to true, the existing App_Data directory on the destination
- * will not be deleted, and any App_Data directory in the source will be ignored.
- * Setting is false by default.
+ * The App ID of the app used for login.
*/
- skipAppData?: boolean;
+ appId?: string;
/**
- * Sets the AppOffline rule while the MSDeploy operation executes.
- * Setting is false by default.
+ * The app setting name that contains the app secret.
*/
- appOffline?: boolean;
+ appSecretSettingName?: string;
}
/**
- * MSDeploy log entry
+ * The configuration settings of the registration for the Apple provider
*/
-export interface MSDeployLogEntry {
- /**
- * Timestamp of log entry
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly time?: Date;
+export interface AppleRegistration extends ProxyOnlyResource {
/**
- * Log entry type. Possible values include: 'Message', 'Warning', 'Error'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The Client ID of the app used for login.
*/
- readonly type?: MSDeployLogEntryType;
+ clientId?: string;
/**
- * Log entry message
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The app setting name that contains the client secret.
*/
- readonly message?: string;
+ clientSecretSettingName?: string;
}
/**
- * MSDeploy log
+ * The configuration settings of the login flow, including the scopes that should be requested.
*/
-export interface MSDeployLog extends ProxyOnlyResource {
+export interface LoginScopes extends ProxyOnlyResource {
/**
- * List of log entry messages
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * A list of the scopes that should be requested while authenticating.
*/
- readonly entries?: MSDeployLogEntry[];
+ scopes?: string[];
}
/**
- * MSDeploy ARM response
+ * The configuration settings of the Apple provider.
*/
-export interface MSDeployStatus extends ProxyOnlyResource {
- /**
- * Username of deployer
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly deployer?: string;
- /**
- * Provisioning state. Possible values include: 'accepted', 'running', 'succeeded', 'failed',
- * 'canceled'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly provisioningState?: MSDeployProvisioningState;
+export interface Apple extends ProxyOnlyResource {
/**
- * Start time of deploy operation
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * false if the Apple provider should not be enabled despite the set registration;
+ * otherwise, true.
*/
- readonly startTime?: Date;
+ enabled?: boolean;
/**
- * End time of deploy operation
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The configuration settings of the Apple registration.
*/
- readonly endTime?: Date;
+ registration?: AppleRegistration;
/**
- * Whether the deployment operation has completed
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The configuration settings of the login flow.
*/
- readonly complete?: boolean;
+ login?: LoginScopes;
}
/**
- * MySQL migration request.
+ * Application logs to file system configuration.
*/
-export interface MigrateMySqlRequest extends ProxyOnlyResource {
- /**
- * Connection string to the remote MySQL database.
- */
- connectionString: string;
+export interface FileSystemApplicationLogsConfig {
/**
- * The type of migration operation to be done. Possible values include: 'LocalToRemote',
- * 'RemoteToLocal'
+ * Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'.
+ * Default value: 'Off'.
*/
- migrationType: MySqlMigrationType;
+ level?: LogLevel;
}
/**
- * MySQL migration status.
+ * Application logs to Azure table storage configuration.
*/
-export interface MigrateMySqlStatus extends ProxyOnlyResource {
- /**
- * Status of the migration task. Possible values include: 'InProgress', 'Failed', 'Succeeded',
- * 'TimedOut', 'Created'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly migrationOperationStatus?: OperationStatus;
+export interface AzureTableStorageApplicationLogsConfig {
/**
- * Operation ID for the migration task.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
*/
- readonly operationId?: string;
+ level?: LogLevel;
/**
- * True if the web app has in app MySql enabled
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * SAS URL to an Azure table with add/query/delete permissions.
*/
- readonly localMySqlEnabled?: boolean;
-}
-
-/**
- * Hybrid Connection for an App Service app.
- */
-export interface RelayServiceConnectionEntity extends ProxyOnlyResource {
- entityName?: string;
- entityConnectionString?: string;
- resourceType?: string;
- resourceConnectionString?: string;
- hostname?: string;
- port?: number;
- biztalkUri?: string;
+ sasUrl: string;
}
/**
- * Full view of network features for an app (presently VNET integration and Hybrid Connections).
+ * Application logs azure blob storage configuration.
*/
-export interface NetworkFeatures extends ProxyOnlyResource {
- /**
- * The Virtual Network name.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly virtualNetworkName?: string;
+export interface AzureBlobStorageApplicationLogsConfig {
/**
- * The Virtual Network summary view.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'
*/
- readonly virtualNetworkConnection?: VnetInfo;
+ level?: LogLevel;
/**
- * The Hybrid Connections summary view.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * SAS url to a azure blob container with read/write/list/delete permissions.
*/
- readonly hybridConnections?: RelayServiceConnectionEntity[];
+ sasUrl?: string;
/**
- * The Hybrid Connection V2 (Service Bus) view.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Retention in days.
+ * Remove blobs older than X days.
+ * 0 or lower means no retention.
*/
- readonly hybridConnectionsV2?: HybridConnection[];
+ retentionInDays?: number;
}
/**
- * Network trace
+ * Application logs configuration.
*/
-export interface NetworkTrace {
+export interface ApplicationLogsConfig {
/**
- * Local file path for the captured network trace file.
+ * Application logs to file system configuration.
*/
- path?: string;
+ fileSystem?: FileSystemApplicationLogsConfig;
/**
- * Current status of the network trace operation, same as Operation.Status
- * (InProgress/Succeeded/Failed).
+ * Application logs to azure table storage configuration.
*/
- status?: string;
+ azureTableStorage?: AzureTableStorageApplicationLogsConfig;
/**
- * Detailed message of a network trace operation, e.g. error message in case of failure.
+ * Application logs to blob storage configuration.
*/
- message?: string;
+ azureBlobStorage?: AzureBlobStorageApplicationLogsConfig;
}
/**
- * Performance monitor sample in a set.
+ * The configuration settings of the platform of App Service Authentication/Authorization.
*/
-export interface PerfMonSample {
+export interface AuthPlatform extends ProxyOnlyResource {
/**
- * Point in time for which counter was measured.
+ * true if the Authentication / Authorization feature is enabled for the current
+ * app; otherwise, false.
*/
- time?: Date;
+ enabled?: boolean;
/**
- * Name of the server on which the measurement is made.
+ * The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
+ * The setting in this value can control the behavior of certain features in the Authentication /
+ * Authorization module.
*/
- instanceName?: string;
+ runtimeVersion?: string;
/**
- * Value of counter at a certain time.
+ * The path of the config file containing auth settings if they come from a file.
+ * If the path is relative, base will the site's root directory.
*/
- value?: number;
+ configFilePath?: string;
}
/**
- * Metric information.
+ * The configuration settings of the Azure Active Directory app registration.
*/
-export interface PerfMonSet {
- /**
- * Unique key name of the counter.
- */
- name?: string;
+export interface AzureActiveDirectoryRegistration extends ProxyOnlyResource {
/**
- * Start time of the period.
+ * The OpenID Connect Issuer URI that represents the entity which issues access tokens for this
+ * application.
+ * When using Azure Active Directory, this value is the URI of the directory tenant, e.g.
+ * https://login.microsoftonline.com/v2.0/{tenant-guid}/.
+ * This URI is a case-sensitive identifier for the token issuer.
+ * More information on OpenID Connect Discovery:
+ * http://openid.net/specs/openid-connect-discovery-1_0.html
*/
- startTime?: Date;
+ openIdIssuer?: string;
/**
- * End time of the period.
+ * The Client ID of this relying party application, known as the client_id.
+ * This setting is required for enabling OpenID Connection authentication with Azure Active
+ * Directory or
+ * other 3rd party OpenID Connect providers.
+ * More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
*/
- endTime?: Date;
+ clientId?: string;
/**
- * Presented time grain.
+ * The app setting name that contains the client secret of the relying party application.
*/
- timeGrain?: string;
+ clientSecretSettingName?: string;
/**
- * Collection of workers that are active during this time.
+ * An alternative to the client secret, that is the thumbprint of a certificate used for signing
+ * purposes. This property acts as
+ * a replacement for the Client Secret. It is also optional.
*/
- values?: PerfMonSample[];
+ clientSecretCertificateThumbprint?: string;
}
/**
- * Performance monitor API response.
+ * The configuration settings of the Azure Active Directory login flow.
*/
-export interface PerfMonResponse {
- /**
- * The response code.
- */
- code?: string;
- /**
- * The message.
- */
- message?: string;
+export interface AzureActiveDirectoryLogin extends ProxyOnlyResource {
+ disableWWWAuthenticate?: boolean;
/**
- * The performance monitor counters.
+ * Login parameters to send to the OpenID Connect authorization endpoint when
+ * a user logs in. Each parameter must be in the form "key=value".
*/
- data?: PerfMonSet;
+ loginParameters?: string[];
}
/**
- * Premier add-on.
+ * The configuration settings of the checks that should be made while validating the JWT Claims.
*/
-export interface PremierAddOn extends Resource {
- /**
- * Premier add on SKU.
- */
- sku?: string;
+export interface JwtClaimChecks extends ProxyOnlyResource {
/**
- * Premier add on Product.
+ * The list of the allowed groups.
*/
- product?: string;
+ allowedGroups?: string[];
/**
- * Premier add on Vendor.
+ * The list of the allowed client applications.
*/
- vendor?: string;
+ allowedClientApplications?: string[];
+}
+
+/**
+ * The configuration settings of the Azure Active Directory token validation flow.
+ */
+export interface AzureActiveDirectoryValidation extends ProxyOnlyResource {
/**
- * Premier add on Marketplace publisher.
+ * The configuration settings of the checks that should be made while validating the JWT Claims.
*/
- marketplacePublisher?: string;
+ jwtClaimChecks?: JwtClaimChecks;
/**
- * Premier add on Marketplace offer.
+ * The list of audiences that can make successful authentication/authorization requests.
*/
- marketplaceOffer?: string;
+ allowedAudiences?: string[];
}
/**
- * ARM resource for a PremierAddOn.
+ * The configuration settings of the Azure Active directory provider.
*/
-export interface PremierAddOnPatchResource extends ProxyOnlyResource {
+export interface AzureActiveDirectory extends ProxyOnlyResource {
/**
- * Premier add on SKU.
+ * false if the Azure Active Directory provider should not be enabled despite the
+ * set registration; otherwise, true.
*/
- sku?: string;
+ enabled?: boolean;
/**
- * Premier add on Product.
+ * The configuration settings of the Azure Active Directory app registration.
*/
- product?: string;
+ registration?: AzureActiveDirectoryRegistration;
/**
- * Premier add on Vendor.
+ * The configuration settings of the Azure Active Directory login flow.
*/
- vendor?: string;
+ login?: AzureActiveDirectoryLogin;
/**
- * Premier add on Marketplace publisher.
+ * The configuration settings of the Azure Active Directory token validation flow.
*/
- marketplacePublisher?: string;
+ validation?: AzureActiveDirectoryValidation;
/**
- * Premier add on Marketplace offer.
+ * Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st
+ * party tooling.
+ * This is an internal flag primarily intended to support the Azure Management Portal. Users
+ * should not
+ * read or write to this property.
*/
- marketplaceOffer?: string;
+ isAutoProvisioned?: boolean;
}
/**
- * Description of a Virtual Network subnet that is useable for private site access.
+ * Http logs to azure blob storage configuration.
*/
-export interface PrivateAccessSubnet {
+export interface AzureBlobStorageHttpLogsConfig {
/**
- * The name of the subnet.
+ * SAS url to a azure blob container with read/write/list/delete permissions.
*/
- name?: string;
+ sasUrl?: string;
/**
- * The key (ID) of the subnet.
+ * Retention in days.
+ * Remove blobs older than X days.
+ * 0 or lower means no retention.
*/
- key?: number;
+ retentionInDays?: number;
+ /**
+ * True if configuration is enabled, false if it is disabled and null if configuration is not
+ * set.
+ */
+ enabled?: boolean;
}
/**
- * Description of a Virtual Network that is useable for private site access.
+ * The configuration settings of the registration for the Azure Static Web Apps provider
*/
-export interface PrivateAccessVirtualNetwork {
+export interface AzureStaticWebAppsRegistration extends ProxyOnlyResource {
/**
- * The name of the Virtual Network.
+ * The Client ID of the app used for login.
*/
- name?: string;
+ clientId?: string;
+}
+
+/**
+ * The configuration settings of the Azure Static Web Apps provider.
+ */
+export interface AzureStaticWebApps extends ProxyOnlyResource {
/**
- * The key (ID) of the Virtual Network.
+ * false if the Azure Static Web Apps provider should not be enabled despite the set
+ * registration; otherwise, true.
*/
- key?: number;
+ enabled?: boolean;
/**
- * The ARM uri of the Virtual Network
+ * The configuration settings of the Azure Static Web Apps registration.
*/
- resourceId?: string;
+ registration?: AzureStaticWebAppsRegistration;
+}
+
+/**
+ * AzureStorageInfo dictionary resource.
+ */
+export interface AzureStoragePropertyDictionaryResource extends ProxyOnlyResource {
/**
- * 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.
+ * Azure storage accounts.
*/
- subnets?: PrivateAccessSubnet[];
+ properties?: { [propertyName: string]: AzureStorageInfoValue };
}
/**
- * Description of the parameters of Private Access for a Web Site.
+ * Database backup settings.
*/
-export interface PrivateAccess extends ProxyOnlyResource {
+export interface DatabaseBackupSetting {
/**
- * Whether private access is enabled or not.
+ * Database type (e.g. SqlAzure / MySql). Possible values include: 'SqlAzure', 'MySql',
+ * 'LocalMySql', 'PostgreSql'
*/
- enabled?: boolean;
+ databaseType: DatabaseType;
+ name?: string;
/**
- * The Virtual Networks (and subnets) allowed to access the site privately.
+ * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.
+ * This is used during restore with overwrite connection strings options.
*/
- virtualNetworks?: PrivateAccessVirtualNetwork[];
+ connectionStringName?: string;
+ /**
+ * 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.
+ */
+ connectionString?: string;
}
/**
- * Process Thread Information.
+ * Backup description.
*/
-export interface ProcessThreadInfo extends ProxyOnlyResource {
+export interface BackupItem extends ProxyOnlyResource {
/**
- * Site extension ID.
+ * Id of the backup.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly identifier?: number;
+ readonly backupId?: number;
/**
- * HRef URI.
+ * SAS URL for the storage account container which contains this backup.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- href?: string;
+ readonly storageAccountUrl?: string;
/**
- * Process URI.
+ * Name of the blob which contains data for this backup.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- process?: string;
+ readonly blobName?: string;
/**
- * Start address.
+ * Name of this backup.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- startAddress?: string;
+ readonly backupItemName?: string;
/**
- * Current thread priority.
+ * Backup status. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut',
+ * 'Created', 'Skipped', 'PartiallySucceeded', 'DeleteInProgress', 'DeleteFailed', 'Deleted'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- currentPriority?: number;
+ readonly status?: BackupItemStatus;
/**
- * Thread priority level.
+ * Size of the backup in bytes.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- priorityLevel?: string;
+ readonly sizeInBytes?: number;
/**
- * Base priority.
+ * Timestamp of the backup creation.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- basePriority?: number;
+ readonly created?: Date;
/**
- * Start time.
+ * Details regarding this backup. Might contain an error message.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- startTime?: Date;
+ readonly log?: string;
/**
- * Total processor time.
+ * List of databases included in the backup.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- totalProcessorTime?: string;
+ readonly databases?: DatabaseBackupSetting[];
/**
- * User processor time.
+ * True if this backup has been created due to a schedule being triggered.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- userProcessorTime?: string;
+ readonly scheduled?: boolean;
/**
- * Thread state.
+ * Timestamp of a last restore operation which used this backup.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- state?: string;
+ readonly lastRestoreTimeStamp?: Date;
/**
- * Wait reason.
+ * Timestamp when this backup finished.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- waitReason?: string;
+ readonly finishedTimeStamp?: Date;
+ /**
+ * Unique correlation identifier. Please use this along with the timestamp while communicating
+ * with Azure support.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly correlationId?: string;
+ /**
+ * Size of the original web app which has been backed up.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly websiteSizeInBytes?: number;
}
/**
- * Process Module Information.
+ * Description of a backup schedule. Describes how often should be the backup performed and what
+ * should be the retention policy.
*/
-export interface ProcessModuleInfo extends ProxyOnlyResource {
+export interface BackupSchedule {
/**
- * Base address. Used as module identifier in ARM resource URI.
+ * 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). Default value: 7.
*/
- baseAddress?: string;
+ frequencyInterval: number;
/**
- * File name.
+ * 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). Possible values include:
+ * 'Day', 'Hour'. Default value: 'Day'.
*/
- fileName?: string;
+ frequencyUnit: FrequencyUnit;
/**
- * HRef URI.
+ * True if the retention policy should always keep at least one backup in the storage account,
+ * regardless how old it is; false otherwise. Default value: true.
*/
- href?: string;
+ keepAtLeastOneBackup: boolean;
/**
- * File path.
+ * After how many days backups should be deleted. Default value: 30.
*/
- filePath?: string;
+ retentionPeriodInDays: number;
/**
- * Module memory size.
+ * When the schedule should start working.
*/
- moduleMemorySize?: number;
+ startTime?: Date;
/**
- * File version.
+ * Last time when this schedule was triggered.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- fileVersion?: string;
+ readonly lastExecutionTime?: Date;
+}
+
+/**
+ * Description of a backup which will be performed.
+ */
+export interface BackupRequest extends ProxyOnlyResource {
/**
- * File description.
+ * Name of the backup.
*/
- fileDescription?: string;
+ backupName?: string;
/**
- * Product name.
+ * True if the backup schedule is enabled (must be included in that case), false if the backup
+ * schedule should be disabled.
*/
- product?: string;
+ enabled?: boolean;
/**
- * Product version.
+ * SAS URL to the container.
*/
- productVersion?: string;
+ storageAccountUrl: string;
/**
- * Is debug?
+ * Schedule for the backup if it is executed periodically.
*/
- isDebug?: boolean;
+ backupSchedule?: BackupSchedule;
/**
- * Module language (locale).
+ * Databases included in the backup.
*/
- language?: string;
+ databases?: DatabaseBackupSetting[];
}
/**
- * Process Information.
+ * The configuration settings of the storage of the tokens if blob storage is used.
*/
-export interface ProcessInfo extends ProxyOnlyResource {
+export interface BlobStorageTokenStore extends ProxyOnlyResource {
/**
- * ARM Identifier for deployment.
+ * The name of the app setting containing the SAS URL of the blob storage containing the tokens.
+ */
+ sasUrlSettingName?: string;
+}
+
+/**
+ * The configuration settings of the app registration for providers that have client ids and client
+ * secrets
+ */
+export interface ClientRegistration extends ProxyOnlyResource {
+ /**
+ * The Client ID of the app used for login.
+ */
+ clientId?: string;
+ /**
+ * The app setting name that contains the client secret.
+ */
+ clientSecretSettingName?: string;
+}
+
+/**
+ * Database connection string value to type pair.
+ */
+export interface ConnStringValueTypePair {
+ /**
+ * Value of pair.
+ */
+ value: string;
+ /**
+ * Type of database. Possible values include: 'MySql', 'SQLServer', 'SQLAzure', 'Custom',
+ * 'NotificationHub', 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'
+ */
+ type: ConnectionStringType;
+}
+
+/**
+ * String dictionary resource.
+ */
+export interface ConnectionStringDictionary extends ProxyOnlyResource {
+ /**
+ * Connection strings.
+ */
+ properties?: { [propertyName: string]: ConnStringValueTypePair };
+}
+
+/**
+ * An interface representing ContainerCpuUsage.
+ */
+export interface ContainerCpuUsage {
+ totalUsage?: number;
+ perCpuUsage?: number[];
+ kernelModeUsage?: number;
+ userModeUsage?: number;
+}
+
+/**
+ * An interface representing ContainerThrottlingData.
+ */
+export interface ContainerThrottlingData {
+ periods?: number;
+ throttledPeriods?: number;
+ throttledTime?: number;
+}
+
+/**
+ * An interface representing ContainerCpuStatistics.
+ */
+export interface ContainerCpuStatistics {
+ cpuUsage?: ContainerCpuUsage;
+ systemCpuUsage?: number;
+ onlineCpuCount?: number;
+ throttlingData?: ContainerThrottlingData;
+}
+
+/**
+ * An interface representing ContainerMemoryStatistics.
+ */
+export interface ContainerMemoryStatistics {
+ usage?: number;
+ maxUsage?: number;
+ limit?: number;
+}
+
+/**
+ * An interface representing ContainerNetworkInterfaceStatistics.
+ */
+export interface ContainerNetworkInterfaceStatistics {
+ rxBytes?: number;
+ rxPackets?: number;
+ rxErrors?: number;
+ rxDropped?: number;
+ txBytes?: number;
+ txPackets?: number;
+ txErrors?: number;
+ txDropped?: number;
+}
+
+/**
+ * An interface representing ContainerInfo.
+ */
+export interface ContainerInfo {
+ currentTimeStamp?: Date;
+ previousTimeStamp?: Date;
+ currentCpuStats?: ContainerCpuStatistics;
+ previousCpuStats?: ContainerCpuStatistics;
+ memoryStats?: ContainerMemoryStatistics;
+ name?: string;
+ id?: string;
+ eth0?: ContainerNetworkInterfaceStatistics;
+}
+
+/**
+ * Continuous Web Job Information.
+ */
+export interface ContinuousWebJob extends ProxyOnlyResource {
+ /**
+ * Job status. Possible values include: 'Initializing', 'Starting', 'Running', 'PendingRestart',
+ * 'Stopped'
+ */
+ status?: ContinuousWebJobStatus;
+ /**
+ * Detailed status.
+ */
+ detailedStatus?: string;
+ /**
+ * Log URL.
+ */
+ logUrl?: string;
+ /**
+ * Run command.
+ */
+ runCommand?: string;
+ /**
+ * Job URL.
+ */
+ url?: string;
+ /**
+ * Extra Info URL.
+ */
+ extraInfoUrl?: string;
+ /**
+ * Job type. Possible values include: 'Continuous', 'Triggered'
+ */
+ webJobType?: WebJobType;
+ /**
+ * Error information.
+ */
+ error?: string;
+ /**
+ * Using SDK?
+ */
+ usingSdk?: boolean;
+ /**
+ * Job settings.
+ */
+ settings?: { [propertyName: string]: any };
+}
+
+/**
+ * The configuration settings of the session cookie's expiration.
+ */
+export interface CookieExpiration extends ProxyOnlyResource {
+ /**
+ * The convention used when determining the session cookie's expiration. Possible values include:
+ * 'FixedTime', 'IdentityProviderDerived'
+ */
+ convention?: CookieExpirationConvention;
+ /**
+ * The time after the request is made when the session cookie should expire.
+ */
+ timeToExpiration?: string;
+}
+
+/**
+ * Publishing Credentials Policies parameters.
+ */
+export interface CsmPublishingCredentialsPoliciesEntity extends ProxyOnlyResource {
+ /**
+ * true to allow access to a publishing method; otherwise, false.
+ */
+ allow: boolean;
+}
+
+/**
+ * Publishing Credentials Policies collection.
+ */
+export interface CsmPublishingCredentialsPoliciesCollection extends ProxyOnlyResource {
+ /**
+ * Whether FTP is allowed.
+ */
+ ftp: CsmPublishingCredentialsPoliciesEntity;
+ /**
+ * Whether Scm Basic Auth is allowed.
+ */
+ scm: CsmPublishingCredentialsPoliciesEntity;
+}
+
+/**
+ * Publishing options for requested profile.
+ */
+export interface CsmPublishingProfileOptions {
+ /**
+ * Name of the format. Valid values are:
+ * FileZilla3
+ * WebDeploy -- default
+ * Ftp. Possible values include: 'FileZilla3', 'WebDeploy', 'Ftp'
+ */
+ format?: PublishingProfileFormat;
+ /**
+ * Include the DisasterRecover endpoint if true
+ */
+ includeDisasterRecoveryEndpoints?: boolean;
+}
+
+/**
+ * Deployment slot parameters.
+ */
+export interface CsmSlotEntity {
+ /**
+ * Destination deployment slot during swap operation.
+ */
+ targetSlot: string;
+ /**
+ * true to preserve Virtual Network to the slot during swap; otherwise,
+ * false.
+ */
+ preserveVnet: boolean;
+}
+
+/**
+ * Custom domain analysis.
+ */
+export interface CustomHostnameAnalysisResult extends ProxyOnlyResource {
+ /**
+ * true if hostname is already verified; otherwise, false.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly identifier?: number;
+ readonly isHostnameAlreadyVerified?: boolean;
/**
- * Deployment name.
+ * DNS verification test result. Possible values include: 'Passed', 'Failed', 'Skipped'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- deploymentName?: string;
+ readonly customDomainVerificationTest?: DnsVerificationTestResult;
/**
- * HRef URI.
+ * Raw failure information if DNS verification fails.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- href?: string;
+ readonly customDomainVerificationFailureInfo?: ErrorEntity;
/**
- * Minidump URI.
+ * true if there is a conflict on a scale unit; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- minidump?: string;
+ readonly hasConflictOnScaleUnit?: boolean;
/**
- * Is profile running?
+ * true if there is a conflict across subscriptions; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- isProfileRunning?: boolean;
+ readonly hasConflictAcrossSubscription?: boolean;
/**
- * Is the IIS Profile running?
+ * Name of the conflicting app on scale unit if it's within the same subscription.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- isIisProfileRunning?: boolean;
+ readonly conflictingAppResourceId?: string;
/**
- * IIS Profile timeout (seconds).
+ * CName records controller can see for this hostname.
*/
- iisProfileTimeoutInSeconds?: number;
+ cNameRecords?: string[];
/**
- * Parent process.
+ * TXT records controller can see for this hostname.
*/
- parent?: string;
+ txtRecords?: string[];
/**
- * Child process list.
+ * A records controller can see for this hostname.
*/
- children?: string[];
+ aRecords?: string[];
/**
- * Thread list.
+ * Alternate CName records controller can see for this hostname.
*/
- threads?: ProcessThreadInfo[];
+ alternateCNameRecords?: string[];
/**
- * List of open files.
+ * Alternate TXT records controller can see for this hostname.
*/
- openFileHandles?: string[];
+ alternateTxtRecords?: string[];
+}
+
+/**
+ * The authentication client credentials of the custom Open ID Connect provider.
+ */
+export interface OpenIdConnectClientCredential extends ProxyOnlyResource {
/**
- * List of modules.
+ * The method that should be used to authenticate the user. Possible values include:
+ * 'ClientSecretPost'
*/
- modules?: ProcessModuleInfo[];
+ method?: ClientCredentialMethod;
/**
- * File name of this process.
+ * The app setting that contains the client secret for the custom Open ID Connect provider.
*/
- fileName?: string;
+ clientSecretSettingName?: string;
+}
+
+/**
+ * The configuration settings of the endpoints used for the custom Open ID Connect provider.
+ */
+export interface OpenIdConnectConfig extends ProxyOnlyResource {
/**
- * Command line.
+ * The endpoint to be used to make an authorization request.
*/
- commandLine?: string;
+ authorizationEndpoint?: string;
/**
- * User name.
+ * The endpoint to be used to request a token.
*/
- userName?: string;
+ tokenEndpoint?: string;
/**
- * Handle count.
+ * The endpoint that issues the token.
*/
- handleCount?: number;
+ issuer?: string;
/**
- * Module count.
+ * The endpoint that provides the keys necessary to validate the token.
*/
- moduleCount?: number;
+ certificationUri?: string;
/**
- * Thread count.
+ * The endpoint that contains all the configuration endpoints for the provider.
*/
- threadCount?: number;
+ wellKnownOpenIdConfiguration?: string;
+}
+
+/**
+ * The configuration settings of the app registration for the custom Open ID Connect provider.
+ */
+export interface OpenIdConnectRegistration extends ProxyOnlyResource {
/**
- * Start time.
+ * The client id of the custom Open ID Connect provider.
*/
- startTime?: Date;
+ clientId?: string;
+ /**
+ * The authentication credentials of the custom Open ID Connect provider.
+ */
+ clientCredential?: OpenIdConnectClientCredential;
+ /**
+ * The configuration settings of the endpoints used for the custom Open ID Connect provider.
+ */
+ openIdConnectConfiguration?: OpenIdConnectConfig;
+}
+
+/**
+ * The configuration settings of the login flow of the custom Open ID Connect provider.
+ */
+export interface OpenIdConnectLogin extends ProxyOnlyResource {
+ /**
+ * The name of the claim that contains the users name.
+ */
+ nameClaimType?: string;
+ /**
+ * A list of the scopes that should be requested while authenticating.
+ */
+ scopes?: string[];
+}
+
+/**
+ * The configuration settings of the custom Open ID Connect provider.
+ */
+export interface CustomOpenIdConnectProvider extends ProxyOnlyResource {
+ /**
+ * false if the custom Open ID provider provider should not be enabled; otherwise,
+ * true.
+ */
+ enabled?: boolean;
+ /**
+ * The configuration settings of the app registration for the custom Open ID Connect provider.
+ */
+ registration?: OpenIdConnectRegistration;
+ /**
+ * The configuration settings of the login flow of the custom Open ID Connect provider.
+ */
+ login?: OpenIdConnectLogin;
+}
+
+/**
+ * Details about restoring a deleted app.
+ */
+export interface DeletedAppRestoreRequest extends ProxyOnlyResource {
+ /**
+ * ARM resource ID of the deleted app. Example:
+ * /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}
+ */
+ deletedSiteId?: string;
/**
- * Total CPU time.
+ * If true, deleted site configuration, in addition to content, will be restored.
*/
- totalCpuTime?: string;
+ recoverConfiguration?: boolean;
/**
- * User CPU time.
+ * Point in time to restore the deleted app from, formatted as a DateTime string.
+ * If unspecified, default value is the time that the app was deleted.
*/
- userCpuTime?: string;
+ snapshotTime?: string;
/**
- * Privileged CPU time.
+ * If true, the snapshot is retrieved from DRSecondary endpoint.
*/
- privilegedCpuTime?: string;
+ useDRSecondary?: boolean;
+}
+
+/**
+ * User credentials used for publishing activity.
+ */
+export interface Deployment extends ProxyOnlyResource {
/**
- * Working set.
+ * Deployment status.
*/
- workingSet?: number;
+ status?: number;
/**
- * Peak working set.
+ * Details about deployment status.
*/
- peakWorkingSet?: number;
+ message?: string;
/**
- * Private memory size.
+ * Who authored the deployment.
*/
- privateMemory?: number;
+ author?: string;
/**
- * Virtual memory size.
+ * Who performed the deployment.
*/
- virtualMemory?: number;
+ deployer?: string;
/**
- * Peak virtual memory usage.
+ * Author email.
*/
- peakVirtualMemory?: number;
+ authorEmail?: string;
/**
- * Paged system memory.
+ * Start time.
*/
- pagedSystemMemory?: number;
+ startTime?: Date;
/**
- * Non-paged system memory.
+ * End time.
*/
- nonPagedSystemMemory?: number;
+ endTime?: Date;
/**
- * Paged memory.
+ * True if deployment is currently active, false if completed and null if not started.
*/
- pagedMemory?: number;
+ active?: boolean;
/**
- * Peak paged memory.
+ * Details on deployment.
*/
- peakPagedMemory?: number;
+ details?: string;
+}
+
+/**
+ * Enabled configuration.
+ */
+export interface EnabledConfig {
/**
- * Time stamp.
+ * True if configuration is enabled, false if it is disabled and null if configuration is not
+ * set.
*/
- timeStamp?: Date;
+ enabled?: boolean;
+}
+
+/**
+ * The configuration settings of the Facebook provider.
+ */
+export interface Facebook extends ProxyOnlyResource {
/**
- * List of environment variables.
+ * false if the Facebook provider should not be enabled despite the set
+ * registration; otherwise, true.
*/
- environmentVariables?: { [propertyName: string]: string };
+ enabled?: boolean;
/**
- * Is this the SCM site?
+ * The configuration settings of the app registration for the Facebook provider.
*/
- isScmSite?: boolean;
+ registration?: AppRegistration;
/**
- * Is this a Web Job?
+ * The version of the Facebook api to be used while logging in.
*/
- isWebjob?: boolean;
+ graphApiVersion?: string;
/**
- * Description of process.
+ * The configuration settings of the login flow.
*/
- description?: string;
+ login?: LoginScopes;
}
/**
- * Public certificate object
+ * Http logs to file system configuration.
*/
-export interface PublicCertificate extends ProxyOnlyResource {
+export interface FileSystemHttpLogsConfig {
/**
- * Public Certificate byte array
+ * Maximum size in megabytes that http log files can use.
+ * When reached old log files will be removed to make space for new ones.
+ * Value can range between 25 and 100.
*/
- blob?: Uint8Array;
+ retentionInMb?: number;
/**
- * Public Certificate Location. Possible values include: 'CurrentUserMy', 'LocalMachineMy',
- * 'Unknown'
+ * Retention in days.
+ * Remove files older than X days.
+ * 0 or lower means no retention.
*/
- publicCertificateLocation?: PublicCertificateLocation;
+ retentionInDays?: number;
/**
- * Certificate Thumbprint
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * True if configuration is enabled, false if it is disabled and null if configuration is not
+ * set.
*/
- readonly thumbprint?: string;
+ enabled?: boolean;
}
/**
- * Description of a restore request.
+ * The configuration settings of the storage of the tokens if a file system is used.
*/
-export interface RestoreRequest extends ProxyOnlyResource {
+export interface FileSystemTokenStore extends ProxyOnlyResource {
/**
- * SAS URL to the container.
+ * The directory in which the tokens will be stored.
*/
- storageAccountUrl: string;
+ directory?: string;
+}
+
+/**
+ * The configuration settings of a forward proxy used to make the requests.
+ */
+export interface ForwardProxy extends ProxyOnlyResource {
/**
- * Name of a blob which contains the backup.
+ * The convention used to determine the url of the request made. Possible values include:
+ * 'NoProxy', 'Standard', 'Custom'
*/
- blobName?: string;
+ convention?: ForwardProxyConvention;
/**
- * true if the restore operation can overwrite target app; otherwise,
- * false. true is needed if trying to restore over an existing app.
+ * The name of the header containing the host of the request.
*/
- overwrite: boolean;
+ customHostHeaderName?: string;
/**
- * Name of an app.
+ * The name of the header containing the scheme of the request.
*/
- siteName?: string;
+ customProtoHeaderName?: string;
+}
+
+/**
+ * Function information.
+ */
+export interface FunctionEnvelope extends ProxyOnlyResource {
/**
- * Collection of databases which should be restored. This list has to match the list of databases
- * included in the backup.
+ * Function App ID.
*/
- databases?: DatabaseBackupSetting[];
+ functionAppId?: string;
/**
- * Changes a logic when restoring an app with custom domains. true to remove custom
- * domains automatically. If false, custom domains are added to
- * the app's object when it is being restored, but that might fail due to conflicts during the
- * operation. Default value: false.
+ * Script root path URI.
*/
- ignoreConflictingHostNames?: boolean;
+ scriptRootPathHref?: string;
/**
- * Ignore the databases and only restore the site content. Default value: false.
+ * Script URI.
*/
- ignoreDatabases?: boolean;
+ scriptHref?: string;
/**
- * Specify app service plan that will own restored site.
+ * Config URI.
*/
- appServicePlan?: string;
+ configHref?: string;
/**
- * Operation type. Possible values include: 'Default', 'Clone', 'Relocation', 'Snapshot',
- * 'CloudFS'. Default value: 'Default'.
+ * Test data URI.
*/
- operationType?: BackupRestoreOperationType;
+ testDataHref?: string;
/**
- * true if SiteConfig.ConnectionStrings should be set in new app; otherwise,
- * false.
+ * Secrets file URI.
*/
- adjustConnectionStrings?: boolean;
+ secretsFileHref?: string;
/**
- * App Service Environment name, if needed (only when restoring an app to an App Service
- * Environment).
+ * Function URI.
*/
- hostingEnvironment?: string;
-}
-
-/**
- * Configuration settings for the Azure App Service Authentication / Authorization feature.
- */
-export interface SiteAuthSettings extends ProxyOnlyResource {
+ href?: string;
/**
- * true if the Authentication / Authorization feature is enabled for the current
- * app; otherwise, false.
+ * Config information.
*/
- enabled?: boolean;
+ config?: any;
/**
- * The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
- * The setting in this value can control the behavior of certain features in the Authentication /
- * Authorization module.
+ * File list.
*/
- runtimeVersion?: string;
+ files?: { [propertyName: string]: string };
/**
- * The action to take when an unauthenticated client attempts to access the app. Possible values
- * include: 'RedirectToLoginPage', 'AllowAnonymous'
+ * Test data used when testing via the Azure Portal.
*/
- unauthenticatedClientAction?: UnauthenticatedClientAction;
+ testData?: string;
/**
- * true to durably store platform-specific security tokens that are obtained during
- * login flows; otherwise, false.
- * The default is false.
+ * The invocation URL
*/
- tokenStoreEnabled?: boolean;
+ invokeUrlTemplate?: string;
/**
- * 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.
- * This is an advanced setting typically only needed by Windows Store application backends.
- * Note that URLs within the current domain are always implicitly allowed.
+ * The function language
*/
- allowedExternalRedirectUrls?: string[];
+ language?: string;
/**
- * The default authentication provider to use when multiple providers are configured.
- * This setting is only needed if multiple providers are configured and the unauthenticated
- * client
- * action is set to "RedirectToLoginPage". Possible values include: 'AzureActiveDirectory',
- * 'Facebook', 'Google', 'MicrosoftAccount', 'Twitter', 'Github'
+ * Gets or sets a value indicating whether the function is disabled
*/
- defaultProvider?: BuiltInAuthenticationProvider;
+ isDisabled?: boolean;
+}
+
+/**
+ * Function secrets.
+ */
+export interface FunctionSecrets {
/**
- * The number of hours after session token expiration that a session token can be used to
- * call the token refresh API. The default is 72 hours.
+ * Secret key.
*/
- tokenRefreshExtensionHours?: number;
+ key?: string;
/**
- * The Client ID of this relying party application, known as the client_id.
- * This setting is required for enabling OpenID Connection authentication with Azure Active
- * Directory or
- * other 3rd party OpenID Connect providers.
- * More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
+ * Trigger URL.
+ */
+ triggerUrl?: string;
+}
+
+/**
+ * The configuration settings of the GitHub provider.
+ */
+export interface GitHub extends ProxyOnlyResource {
+ /**
+ * false if the GitHub provider should not be enabled despite the set registration;
+ * otherwise, true.
+ */
+ enabled?: boolean;
+ /**
+ * The configuration settings of the app registration for the GitHub provider.
*/
- clientId?: string;
+ registration?: ClientRegistration;
/**
- * The Client Secret of this relying party application (in Azure Active Directory, this is also
- * referred to as the Key).
- * This setting is optional. If no client secret is configured, the OpenID Connect implicit auth
- * flow is used to authenticate end users.
- * Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.
- * More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
+ * The configuration settings of the login flow.
*/
- clientSecret?: string;
+ login?: LoginScopes;
+}
+
+/**
+ * The GitHub action code configuration.
+ */
+export interface GitHubActionCodeConfiguration {
/**
- * The app setting name that contains the client secret of the relying party application.
+ * Runtime stack is used to determine the workflow file content for code base apps.
*/
- clientSecretSettingName?: string;
+ runtimeStack?: string;
/**
- * An alternative to the client secret, that is the thumbprint of a certificate used for signing
- * purposes. This property acts as
- * a replacement for the Client Secret. It is also optional.
+ * Runtime version is used to determine what build version to set in the workflow file.
*/
- clientSecretCertificateThumbprint?: string;
+ runtimeVersion?: string;
+}
+
+/**
+ * The GitHub action container configuration.
+ */
+export interface GitHubActionContainerConfiguration {
/**
- * The OpenID Connect Issuer URI that represents the entity which issues access tokens for this
- * application.
- * When using Azure Active Directory, this value is the URI of the directory tenant, e.g.
- * https://sts.windows.net/{tenant-guid}/.
- * This URI is a case-sensitive identifier for the token issuer.
- * More information on OpenID Connect Discovery:
- * http://openid.net/specs/openid-connect-discovery-1_0.html
+ * The server URL for the container registry where the build will be hosted.
*/
- issuer?: string;
+ serverUrl?: string;
/**
- * Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as
- * such.
+ * The image name for the build.
*/
- validateIssuer?: boolean;
+ imageName?: string;
/**
- * Allowed audience values to consider when validating JWTs issued by
- * Azure Active Directory. Note that the ClientID value is always considered an
- * allowed audience, regardless of this setting.
+ * The username used to upload the image to the container registry.
*/
- allowedAudiences?: string[];
+ username?: string;
/**
- * Login parameters to send to the OpenID Connect authorization endpoint when
- * a user logs in. Each parameter must be in the form "key=value".
+ * The password used to upload the image to the container registry.
*/
- additionalLoginParams?: string[];
+ password?: string;
+}
+
+/**
+ * The GitHub action configuration.
+ */
+export interface GitHubActionConfiguration {
/**
- * Gets a JSON string containing the Azure AD Acl settings.
+ * GitHub Action code configuration.
*/
- aadClaimsAuthorization?: string;
+ codeConfiguration?: GitHubActionCodeConfiguration;
/**
- * The OpenID Connect Client ID for the Google web application.
- * This setting is required for enabling Google Sign-In.
- * Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
+ * GitHub Action container configuration.
*/
- googleClientId?: string;
+ containerConfiguration?: GitHubActionContainerConfiguration;
/**
- * The client secret associated with the Google web application.
- * This setting is required for enabling Google Sign-In.
- * Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
+ * This will help determine the workflow configuration to select.
*/
- googleClientSecret?: string;
+ isLinux?: boolean;
/**
- * The app setting name that contains the client secret associated with
- * the Google web application.
+ * Workflow option to determine whether the workflow file should be generated and written to the
+ * repository.
*/
- googleClientSecretSettingName?: string;
+ generateWorkflowFile?: boolean;
+}
+
+/**
+ * The configuration settings that determines the validation flow of users using App Service
+ * Authentication/Authorization.
+ */
+export interface GlobalValidation extends ProxyOnlyResource {
/**
- * The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
- * This setting is optional. If not specified, "openid", "profile", and "email" are used as
- * default scopes.
- * Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
+ * true if the authentication flow is required any request is made; otherwise,
+ * false.
*/
- googleOAuthScopes?: string[];
+ requireAuthentication?: boolean;
/**
- * The App ID of the Facebook app used for login.
- * This setting is required for enabling Facebook Login.
- * Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
+ * The action to take when an unauthenticated client attempts to access the app. Possible values
+ * include: 'RedirectToLoginPage', 'AllowAnonymous', 'Return401', 'Return403'
*/
- facebookAppId?: string;
+ unauthenticatedClientAction?: UnauthenticatedClientActionV2;
/**
- * The App Secret of the Facebook app used for Facebook Login.
- * This setting is required for enabling Facebook Login.
- * Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
+ * The default authentication provider to use when multiple providers are configured.
+ * This setting is only needed if multiple providers are configured and the unauthenticated
+ * client
+ * action is set to "RedirectToLoginPage".
*/
- facebookAppSecret?: string;
+ redirectToProvider?: string;
/**
- * The app setting name that contains the app secret used for Facebook Login.
+ * The paths for which unauthenticated flow would not be redirected to the login page.
*/
- facebookAppSecretSettingName?: string;
+ excludedPaths?: string[];
+}
+
+/**
+ * The configuration settings of the Google provider.
+ */
+export interface Google extends ProxyOnlyResource {
/**
- * The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
- * This setting is optional.
- * Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
+ * false if the Google provider should not be enabled despite the set registration;
+ * otherwise, true.
*/
- facebookOAuthScopes?: string[];
+ enabled?: boolean;
/**
- * The Client Id of the GitHub app used for login.
- * This setting is required for enabling Github login
+ * The configuration settings of the app registration for the Google provider.
*/
- gitHubClientId?: string;
+ registration?: ClientRegistration;
/**
- * The Client Secret of the GitHub app used for Github Login.
- * This setting is required for enabling Github login.
+ * The configuration settings of the login flow.
*/
- gitHubClientSecret?: string;
+ login?: LoginScopes;
/**
- * The app setting name that contains the client secret of the Github
- * app used for GitHub Login.
+ * The configuration settings of the Azure Active Directory token validation flow.
*/
- gitHubClientSecretSettingName?: string;
+ validation?: AllowedAudiencesValidation;
+}
+
+/**
+ * Functions host level keys.
+ */
+export interface HostKeys {
/**
- * The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
- * This setting is optional
+ * Secret key.
*/
- gitHubOAuthScopes?: string[];
+ masterKey?: string;
/**
- * The OAuth 1.0a consumer key of the Twitter application used for sign-in.
- * This setting is required for enabling Twitter Sign-In.
- * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
+ * Host level function keys.
*/
- twitterConsumerKey?: string;
+ functionKeys?: { [propertyName: string]: string };
/**
- * The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- * This setting is required for enabling Twitter Sign-In.
- * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
+ * System keys.
*/
- twitterConsumerSecret?: string;
+ systemKeys?: { [propertyName: string]: string };
+}
+
+/**
+ * A hostname binding object.
+ */
+export interface HostNameBinding extends ProxyOnlyResource {
/**
- * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
- * application used for sign-in.
+ * App Service app name.
*/
- twitterConsumerSecretSettingName?: string;
+ siteName?: string;
/**
- * The OAuth 2.0 client ID that was created for the app used for authentication.
- * This setting is required for enabling Microsoft Account authentication.
- * Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
+ * Fully qualified ARM domain resource URI.
*/
- microsoftAccountClientId?: string;
+ domainId?: string;
/**
- * The OAuth 2.0 client secret that was created for the app used for authentication.
- * This setting is required for enabling Microsoft Account authentication.
- * Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
+ * Azure resource name.
*/
- microsoftAccountClientSecret?: string;
+ azureResourceName?: string;
/**
- * The app setting name containing the OAuth 2.0 client secret that was created for the
- * app used for authentication.
+ * Azure resource type. Possible values include: 'Website', 'TrafficManager'
*/
- microsoftAccountClientSecretSettingName?: string;
+ azureResourceType?: AzureResourceType;
/**
- * The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
- * This setting is optional. If not specified, "wl.basic" is used as the default scope.
- * Microsoft Account Scopes and permissions documentation:
- * https://msdn.microsoft.com/en-us/library/dn631845.aspx
+ * Custom DNS record type. Possible values include: 'CName', 'A'
*/
- microsoftAccountOAuthScopes?: string[];
+ customHostNameDnsRecordType?: CustomHostNameDnsRecordType;
/**
- * "true" if the auth config settings should be read from a file,
- * "false" otherwise
+ * Hostname type. Possible values include: 'Verified', 'Managed'
*/
- isAuthFromFile?: string;
+ hostNameType?: HostNameType;
/**
- * The path of the config file containing auth settings.
- * If the path is relative, base will the site's root directory.
+ * SSL type. Possible values include: 'Disabled', 'SniEnabled', 'IpBasedEnabled'
*/
- authFilePath?: string;
+ sslState?: SslState;
/**
- * The ConfigVersion of the Authentication / Authorization feature in use for the current app.
- * The setting in this value can control the behavior of the control plane for Authentication /
- * Authorization.
+ * SSL certificate thumbprint
*/
- configVersion?: string;
+ thumbprint?: string;
+ /**
+ * Virtual IP address assigned to the hostname if IP based SSL is enabled.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly virtualIP?: string;
}
/**
- * Configuration settings for the Azure App Service Authentication / Authorization V2 feature.
+ * Http logs configuration.
*/
-export interface SiteAuthSettingsV2 extends ProxyOnlyResource {
- /**
- * The configuration settings of the platform of App Service Authentication/Authorization.
- */
- platform?: AuthPlatform;
- /**
- * The configuration settings that determines the validation flow of users using App Service
- * Authentication/Authorization.
- */
- globalValidation?: GlobalValidation;
+export interface HttpLogsConfig {
/**
- * The configuration settings of each of the identity providers used to configure App Service
- * Authentication/Authorization.
+ * Http logs to file system configuration.
*/
- identityProviders?: IdentityProviders;
+ fileSystem?: FileSystemHttpLogsConfig;
/**
- * The configuration settings of the login flow of users using App Service
- * Authentication/Authorization.
+ * Http logs to azure blob storage configuration.
*/
- login?: Login;
+ azureBlobStorage?: AzureBlobStorageHttpLogsConfig;
+}
+
+/**
+ * The configuration settings of the paths HTTP requests.
+ */
+export interface HttpSettingsRoutes extends ProxyOnlyResource {
/**
- * The configuration settings of the HTTP requests for authentication and authorization requests
- * made against App Service Authentication/Authorization.
+ * The prefix that should precede all the authentication/authorization paths.
*/
- httpSettings?: HttpSettings;
+ apiPrefix?: string;
}
/**
- * An app cloneability criterion.
+ * The configuration settings of the HTTP requests for authentication and authorization requests
+ * made against App Service Authentication/Authorization.
*/
-export interface SiteCloneabilityCriterion {
+export interface HttpSettings extends ProxyOnlyResource {
/**
- * Name of criterion.
+ * false if the authentication/authorization responses not having the HTTPS scheme
+ * are permissible; otherwise, true.
*/
- name?: string;
+ requireHttps?: boolean;
/**
- * Description of criterion.
+ * The configuration settings of the paths HTTP requests.
*/
- description?: string;
+ routes?: HttpSettingsRoutes;
+ /**
+ * The configuration settings of a forward proxy used to make the requests.
+ */
+ forwardProxy?: ForwardProxy;
}
/**
- * Represents whether or not an app is cloneable.
+ * The configuration settings of the app registration for the Twitter provider.
*/
-export interface SiteCloneability {
+export interface TwitterRegistration extends ProxyOnlyResource {
/**
- * Name of app. Possible values include: 'Cloneable', 'PartiallyCloneable', 'NotCloneable'
+ * The OAuth 1.0a consumer key of the Twitter application used for sign-in.
+ * This setting is required for enabling Twitter Sign-In.
+ * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
*/
- result?: CloneAbilityResult;
+ consumerKey?: string;
/**
- * List of features enabled on app that prevent cloning.
+ * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
+ * application used for sign-in.
*/
- blockingFeatures?: SiteCloneabilityCriterion[];
+ consumerSecretSettingName?: string;
+}
+
+/**
+ * The configuration settings of the Twitter provider.
+ */
+export interface Twitter extends ProxyOnlyResource {
/**
- * List of features enabled on app that are non-blocking but cannot be cloned. The app can still
- * be cloned
- * but the features in this list will not be set up on cloned app.
+ * false if the Twitter provider should not be enabled despite the set registration;
+ * otherwise, true.
*/
- unsupportedFeatures?: SiteCloneabilityCriterion[];
+ enabled?: boolean;
/**
- * List of blocking application characteristics.
+ * The configuration settings of the app registration for the Twitter provider.
*/
- blockingCharacteristics?: SiteCloneabilityCriterion[];
+ registration?: TwitterRegistration;
}
/**
- * Web app configuration ARM resource.
+ * The configuration settings of the legacy Microsoft Account provider.
*/
-export interface SiteConfigResource extends ProxyOnlyResource {
- /**
- * Number of workers.
- */
- numberOfWorkers?: number;
+export interface LegacyMicrosoftAccount extends ProxyOnlyResource {
/**
- * Default documents.
+ * false if the legacy Microsoft Account provider should not be enabled despite the
+ * set registration; otherwise, true.
*/
- defaultDocuments?: string[];
+ enabled?: boolean;
/**
- * .NET Framework version. Default value: 'v4.6'.
+ * The configuration settings of the app registration for the legacy Microsoft Account provider.
*/
- netFrameworkVersion?: string;
+ registration?: ClientRegistration;
/**
- * Version of PHP.
+ * The configuration settings of the login flow.
*/
- phpVersion?: string;
+ login?: LoginScopes;
/**
- * Version of Python.
+ * The configuration settings of the legacy Microsoft Account provider token validation flow.
*/
- pythonVersion?: string;
+ validation?: AllowedAudiencesValidation;
+}
+
+/**
+ * The configuration settings of each of the identity providers used to configure App Service
+ * Authentication/Authorization.
+ */
+export interface IdentityProviders extends ProxyOnlyResource {
/**
- * Version of Node.js.
+ * The configuration settings of the Azure Active directory provider.
*/
- nodeVersion?: string;
+ azureActiveDirectory?: AzureActiveDirectory;
/**
- * Version of PowerShell.
+ * The configuration settings of the Facebook provider.
*/
- powerShellVersion?: string;
+ facebook?: Facebook;
/**
- * Linux App Framework and version
+ * The configuration settings of the GitHub provider.
*/
- linuxFxVersion?: string;
+ gitHub?: GitHub;
/**
- * Xenon App Framework and version
+ * The configuration settings of the Google provider.
*/
- windowsFxVersion?: string;
+ google?: Google;
/**
- * true if request tracing is enabled; otherwise, false.
+ * The configuration settings of the Twitter provider.
*/
- requestTracingEnabled?: boolean;
+ twitter?: Twitter;
/**
- * Request tracing expiration time.
+ * The map of the name of the alias of each custom Open ID Connect provider to the
+ * configuration settings of the custom Open ID Connect provider.
*/
- requestTracingExpirationTime?: Date;
+ customOpenIdConnectProviders?: { [propertyName: string]: CustomOpenIdConnectProvider };
/**
- * true if remote debugging is enabled; otherwise, false.
+ * The configuration settings of the legacy Microsoft Account provider.
*/
- remoteDebuggingEnabled?: boolean;
+ legacyMicrosoftAccount?: LegacyMicrosoftAccount;
/**
- * Remote debugging version.
+ * The configuration settings of the Apple provider.
*/
- remoteDebuggingVersion?: string;
+ apple?: Apple;
/**
- * true if HTTP logging is enabled; otherwise, false.
+ * The configuration settings of the Azure Static Web Apps provider.
*/
- httpLoggingEnabled?: boolean;
+ azureStaticWebApps?: AzureStaticWebApps;
+}
+
+/**
+ * Function key info.
+ */
+export interface KeyInfo {
/**
- * HTTP logs directory size limit.
+ * Key name
*/
- logsDirectorySizeLimit?: number;
+ name?: string;
/**
- * true if detailed error logging is enabled; otherwise, false.
+ * Key value
*/
- detailedErrorLoggingEnabled?: boolean;
+ value?: string;
+}
+
+/**
+ * The routes that specify the endpoints used for login and logout requests.
+ */
+export interface LoginRoutes extends ProxyOnlyResource {
/**
- * Publishing user name.
+ * The endpoint at which a logout request should be made.
*/
- publishingUsername?: string;
+ logoutEndpoint?: string;
+}
+
+/**
+ * The configuration settings of the token store.
+ */
+export interface TokenStore extends ProxyOnlyResource {
/**
- * Application settings.
+ * true to durably store platform-specific security tokens that are obtained during
+ * login flows; otherwise, false.
+ * The default is false.
*/
- appSettings?: NameValuePair[];
+ enabled?: boolean;
/**
- * Connection strings.
+ * The number of hours after session token expiration that a session token can be used to
+ * call the token refresh API. The default is 72 hours.
*/
- connectionStrings?: ConnStringInfo[];
+ tokenRefreshExtensionHours?: number;
/**
- * Site MachineKey.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The configuration settings of the storage of the tokens if a file system is used.
*/
- readonly machineKey?: SiteMachineKey;
+ fileSystem?: FileSystemTokenStore;
/**
- * Handler mappings.
+ * The configuration settings of the storage of the tokens if blob storage is used.
*/
- handlerMappings?: HandlerMapping[];
+ azureBlobStorage?: BlobStorageTokenStore;
+}
+
+/**
+ * The configuration settings of the nonce used in the login flow.
+ */
+export interface Nonce extends ProxyOnlyResource {
/**
- * Document root.
+ * false if the nonce should not be validated while completing the login flow;
+ * otherwise, true.
*/
- documentRoot?: string;
+ validateNonce?: boolean;
/**
- * SCM type. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub',
- * 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg',
- * 'OneDrive', 'VSO', 'VSTSRM'
+ * The time after the request is made when the nonce should expire.
*/
- scmType?: ScmType;
+ nonceExpirationInterval?: string;
+}
+
+/**
+ * The configuration settings of the login flow of users using App Service
+ * Authentication/Authorization.
+ */
+export interface Login extends ProxyOnlyResource {
/**
- * true to use 32-bit worker process; otherwise, false.
+ * The routes that specify the endpoints used for login and logout requests.
*/
- use32BitWorkerProcess?: boolean;
+ routes?: LoginRoutes;
/**
- * true if WebSocket is enabled; otherwise, false.
+ * The configuration settings of the token store.
*/
- webSocketsEnabled?: boolean;
+ tokenStore?: TokenStore;
/**
- * true if Always On is enabled; otherwise, false.
+ * true if the fragments from the request are preserved after the login request is
+ * made; otherwise, false.
*/
- alwaysOn?: boolean;
+ preserveUrlFragmentsForLogins?: boolean;
/**
- * Java version.
+ * 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.
+ * This is an advanced setting typically only needed by Windows Store application backends.
+ * Note that URLs within the current domain are always implicitly allowed.
*/
- javaVersion?: string;
+ allowedExternalRedirectUrls?: string[];
/**
- * Java container.
+ * The configuration settings of the session cookie's expiration.
*/
- javaContainer?: string;
+ cookieExpiration?: CookieExpiration;
/**
- * Java container version.
+ * The configuration settings of the nonce used in the login flow.
*/
- javaContainerVersion?: string;
+ nonce?: Nonce;
+}
+
+/**
+ * MSDeploy ARM PUT information
+ */
+export interface MSDeploy extends ProxyOnlyResource {
/**
- * App command line to launch.
+ * Package URI
*/
- appCommandLine?: string;
+ packageUri?: string;
/**
- * Managed pipeline mode. Possible values include: 'Integrated', 'Classic'
+ * SQL Connection String
*/
- managedPipelineMode?: ManagedPipelineMode;
+ connectionString?: string;
/**
- * Virtual applications.
+ * Database Type
*/
- virtualApplications?: VirtualApplication[];
+ dbType?: string;
/**
- * Site load balancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests',
- * 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash', 'PerSiteRoundRobin'
+ * URI of MSDeploy Parameters file. Must not be set if SetParameters is used.
*/
- loadBalancing?: SiteLoadBalancing;
+ setParametersXmlFileUri?: string;
/**
- * This is work around for polymorphic types.
+ * MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.
*/
- experiments?: Experiments;
+ setParameters?: { [propertyName: string]: string };
/**
- * Site limits.
+ * Controls whether the MSDeploy operation skips the App_Data directory.
+ * If set to true, the existing App_Data directory on the destination
+ * will not be deleted, and any App_Data directory in the source will be ignored.
+ * Setting is false by default.
*/
- limits?: SiteLimits;
+ skipAppData?: boolean;
/**
- * true if Auto Heal is enabled; otherwise, false.
+ * Sets the AppOffline rule while the MSDeploy operation executes.
+ * Setting is false by default.
*/
- autoHealEnabled?: boolean;
+ appOffline?: boolean;
+}
+
+/**
+ * MSDeploy log entry
+ */
+export interface MSDeployLogEntry {
/**
- * Auto Heal rules.
+ * Timestamp of log entry
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- autoHealRules?: AutoHealRules;
+ readonly time?: Date;
/**
- * Tracing options.
+ * Log entry type. Possible values include: 'Message', 'Warning', 'Error'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- tracingOptions?: string;
+ readonly type?: MSDeployLogEntryType;
/**
- * Virtual Network name.
+ * Log entry message
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- vnetName?: string;
+ readonly message?: string;
+}
+
+/**
+ * MSDeploy log
+ */
+export interface MSDeployLog extends ProxyOnlyResource {
/**
- * Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network
- * Security Groups and User Defined Routes applied.
+ * List of log entry messages
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- vnetRouteAllEnabled?: boolean;
+ readonly entries?: MSDeployLogEntry[];
+}
+
+/**
+ * MSDeploy ARM response
+ */
+export interface MSDeployStatus extends ProxyOnlyResource {
/**
- * The number of private ports assigned to this app. These will be assigned dynamically on
- * runtime.
+ * Username of deployer
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- vnetPrivatePortsCount?: number;
+ readonly deployer?: string;
/**
- * Cross-Origin Resource Sharing (CORS) settings.
+ * Provisioning state. Possible values include: 'accepted', 'running', 'succeeded', 'failed',
+ * 'canceled'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- cors?: CorsSettings;
+ readonly provisioningState?: MSDeployProvisioningState;
/**
- * Push endpoint settings.
+ * Start time of deploy operation
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- push?: PushSettings;
+ readonly startTime?: Date;
/**
- * Information about the formal API definition for the app.
+ * End time of deploy operation
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- apiDefinition?: ApiDefinitionInfo;
+ readonly endTime?: Date;
/**
- * Azure API management settings linked to the app.
+ * Whether the deployment operation has completed
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- apiManagementConfig?: ApiManagementConfig;
+ readonly complete?: boolean;
+}
+
+/**
+ * MySQL migration request.
+ */
+export interface MigrateMySqlRequest extends ProxyOnlyResource {
/**
- * Auto-swap slot name.
+ * Connection string to the remote MySQL database.
*/
- autoSwapSlotName?: string;
+ connectionString: string;
/**
- * true to enable local MySQL; otherwise, false. Default value: false.
+ * The type of migration operation to be done. Possible values include: 'LocalToRemote',
+ * 'RemoteToLocal'
*/
- localMySqlEnabled?: boolean;
+ migrationType: MySqlMigrationType;
+}
+
+/**
+ * MySQL migration status.
+ */
+export interface MigrateMySqlStatus extends ProxyOnlyResource {
/**
- * Managed Service Identity Id
+ * Status of the migration task. Possible values include: 'InProgress', 'Failed', 'Succeeded',
+ * 'TimedOut', 'Created'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- managedServiceIdentityId?: number;
+ readonly migrationOperationStatus?: OperationStatus;
/**
- * Explicit Managed Service Identity Id
+ * Operation ID for the migration task.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- xManagedServiceIdentityId?: number;
+ readonly operationId?: string;
/**
- * Identity to use for Key Vault Reference authentication.
+ * True if the web app has in app MySql enabled
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- keyVaultReferenceIdentity?: string;
+ readonly localMySqlEnabled?: boolean;
+}
+
+/**
+ * Hybrid Connection for an App Service app.
+ */
+export interface RelayServiceConnectionEntity extends ProxyOnlyResource {
+ entityName?: string;
+ entityConnectionString?: string;
+ resourceType?: string;
+ resourceConnectionString?: string;
+ hostname?: string;
+ port?: number;
+ biztalkUri?: string;
+}
+
+/**
+ * Full view of network features for an app (presently VNET integration and Hybrid Connections).
+ */
+export interface NetworkFeatures extends ProxyOnlyResource {
/**
- * IP security restrictions for main.
+ * The Virtual Network name.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- ipSecurityRestrictions?: IpSecurityRestriction[];
+ readonly virtualNetworkName?: string;
/**
- * IP security restrictions for scm.
+ * The Virtual Network summary view.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- scmIpSecurityRestrictions?: IpSecurityRestriction[];
+ readonly virtualNetworkConnection?: VnetInfo;
/**
- * IP security restrictions for scm to use main.
+ * The Hybrid Connections summary view.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- scmIpSecurityRestrictionsUseMain?: boolean;
+ readonly hybridConnections?: RelayServiceConnectionEntity[];
/**
- * Http20Enabled: configures a web site to allow clients to connect over http2.0. Default value:
- * true.
+ * The Hybrid Connection V2 (Service Bus) view.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- http20Enabled?: boolean;
+ readonly hybridConnectionsV2?: HybridConnection[];
+}
+
+/**
+ * Network trace
+ */
+export interface NetworkTrace {
/**
- * MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible
- * values include: '1.0', '1.1', '1.2'
+ * Local file path for the captured network trace file.
*/
- minTlsVersion?: SupportedTlsVersions;
+ path?: string;
/**
- * ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM
- * site. Possible values include: '1.0', '1.1', '1.2'
+ * Current status of the network trace operation, same as Operation.Status
+ * (InProgress/Succeeded/Failed).
*/
- scmMinTlsVersion?: SupportedTlsVersions;
+ status?: string;
/**
- * State of FTP / FTPS service. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'
+ * Detailed message of a network trace operation, e.g. error message in case of failure.
*/
- ftpsState?: FtpsState;
+ message?: string;
+}
+
+/**
+ * Performance monitor sample in a set.
+ */
+export interface PerfMonSample {
/**
- * Number of preWarmed instances.
- * This setting only applies to the Consumption and Elastic Plans
+ * Point in time for which counter was measured.
*/
- preWarmedInstanceCount?: number;
+ time?: Date;
/**
- * Maximum number of workers that a site can scale out to.
- * This setting only applies to the Consumption and Elastic Premium Plans
+ * Name of the server on which the measurement is made.
*/
- functionAppScaleLimit?: number;
+ instanceName?: string;
/**
- * Health check path
+ * Value of counter at a certain time.
*/
- healthCheckPath?: string;
+ value?: number;
+}
+
+/**
+ * Metric information.
+ */
+export interface PerfMonSet {
/**
- * Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When
- * enabled,
- * the ScaleController will not monitor event sources directly, but will instead call to the
- * runtime to get scale status.
+ * Unique key name of the counter.
*/
- functionsRuntimeScaleMonitoringEnabled?: boolean;
+ name?: string;
/**
- * 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
+ * Start time of the period.
*/
- websiteTimeZone?: string;
+ startTime?: Date;
/**
- * Number of minimum instance count for a site
- * This setting only applies to the Elastic Plans
+ * End time of the period.
*/
- minimumElasticInstanceCount?: number;
+ endTime?: Date;
/**
- * List of Azure Storage Accounts.
+ * Presented time grain.
*/
- azureStorageAccounts?: { [propertyName: string]: AzureStorageInfoValue };
+ timeGrain?: string;
/**
- * Property to allow or block all public traffic.
+ * Collection of workers that are active during this time.
*/
- publicNetworkAccess?: string;
+ values?: PerfMonSample[];
}
/**
- * A snapshot of a web app configuration.
+ * Performance monitor API response.
*/
-export interface SiteConfigurationSnapshotInfo extends ProxyOnlyResource {
+export interface PerfMonResponse {
/**
- * The time the snapshot was taken.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The response code.
*/
- readonly time?: Date;
+ code?: string;
/**
- * The id of the snapshot
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The message.
*/
- readonly snapshotId?: number;
+ message?: string;
+ /**
+ * The performance monitor counters.
+ */
+ data?: PerfMonSet;
}
/**
- * Site Extension Information.
- */
-export interface SiteExtensionInfo extends ProxyOnlyResource {
- /**
- * Site extension ID.
- */
- extensionId?: string;
- title?: string;
+ * Premier add-on.
+ */
+export interface PremierAddOn extends Resource {
/**
- * Site extension type. Possible values include: 'Gallery', 'WebRoot'
+ * Premier add on SKU.
*/
- extensionType?: SiteExtensionType;
+ sku?: string;
/**
- * Summary description.
+ * Premier add on Product.
*/
- summary?: string;
+ product?: string;
/**
- * Detailed description.
+ * Premier add on Vendor.
*/
- description?: string;
+ vendor?: string;
/**
- * Version information.
+ * Premier add on Marketplace publisher.
*/
- version?: string;
+ marketplacePublisher?: string;
/**
- * Extension URL.
+ * Premier add on Marketplace offer.
*/
- extensionUrl?: string;
+ marketplaceOffer?: string;
+}
+
+/**
+ * ARM resource for a PremierAddOn.
+ */
+export interface PremierAddOnPatchResource extends ProxyOnlyResource {
/**
- * Project URL.
+ * Premier add on SKU.
*/
- projectUrl?: string;
+ sku?: string;
/**
- * Icon URL.
+ * Premier add on Product.
*/
- iconUrl?: string;
+ product?: string;
/**
- * License URL.
+ * Premier add on Vendor.
*/
- licenseUrl?: string;
+ vendor?: string;
/**
- * Feed URL.
+ * Premier add on Marketplace publisher.
*/
- feedUrl?: string;
+ marketplacePublisher?: string;
/**
- * List of authors.
+ * Premier add on Marketplace offer.
*/
- authors?: string[];
+ marketplaceOffer?: string;
+}
+
+/**
+ * Description of a Virtual Network subnet that is useable for private site access.
+ */
+export interface PrivateAccessSubnet {
/**
- * Installer command line parameters.
+ * The name of the subnet.
*/
- installerCommandLineParams?: string;
+ name?: string;
/**
- * Published timestamp.
+ * The key (ID) of the subnet.
*/
- publishedDateTime?: Date;
+ key?: number;
+}
+
+/**
+ * Description of a Virtual Network that is useable for private site access.
+ */
+export interface PrivateAccessVirtualNetwork {
/**
- * Count of downloads.
+ * The name of the Virtual Network.
*/
- downloadCount?: number;
+ name?: string;
/**
- * true if the local version is the latest version; false otherwise.
+ * The key (ID) of the Virtual Network.
*/
- localIsLatestVersion?: boolean;
+ key?: number;
/**
- * Local path.
+ * The ARM uri of the Virtual Network
*/
- localPath?: string;
+ resourceId?: string;
/**
- * Installed timestamp.
+ * 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.
*/
- installedDateTime?: Date;
+ subnets?: PrivateAccessSubnet[];
+}
+
+/**
+ * Description of the parameters of Private Access for a Web Site.
+ */
+export interface PrivateAccess extends ProxyOnlyResource {
/**
- * Provisioning state.
+ * Whether private access is enabled or not.
*/
- provisioningState?: string;
+ enabled?: boolean;
/**
- * Site Extension comment.
+ * The Virtual Networks (and subnets) allowed to access the site privately.
*/
- comment?: string;
+ virtualNetworks?: PrivateAccessVirtualNetwork[];
}
/**
- * Configuration of App Service site logs.
+ * Process Thread Information.
*/
-export interface SiteLogsConfig extends ProxyOnlyResource {
+export interface ProcessThreadInfo extends ProxyOnlyResource {
/**
- * Application logs configuration.
+ * Site extension ID.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- applicationLogs?: ApplicationLogsConfig;
+ readonly identifier?: number;
/**
- * HTTP logs configuration.
+ * HRef URI.
*/
- httpLogs?: HttpLogsConfig;
+ href?: string;
/**
- * Failed requests tracing configuration.
+ * Process URI.
*/
- failedRequestsTracing?: EnabledConfig;
+ process?: string;
/**
- * Detailed error messages configuration.
+ * Start address.
*/
- detailedErrorMessages?: EnabledConfig;
-}
-
-/**
- * ARM resource for a site.
- */
-export interface SitePatchResource extends ProxyOnlyResource {
+ startAddress?: string;
/**
- * Current state of the app.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Current thread priority.
*/
- readonly state?: string;
+ currentPriority?: number;
/**
- * Hostnames associated with the app.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Thread priority level.
*/
- readonly hostNames?: string[];
+ priorityLevel?: string;
/**
- * Name of the repository site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Base priority.
*/
- readonly repositorySiteName?: string;
+ basePriority?: number;
/**
- * State indicating whether the app has exceeded its quota usage. Read-only. Possible values
- * include: 'Normal', 'Exceeded'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Start time.
*/
- readonly usageState?: UsageState;
+ startTime?: Date;
/**
- * true if the app is enabled; otherwise, false. Setting this value to
- * false disables the app (takes the app offline).
+ * Total processor time.
*/
- enabled?: boolean;
+ totalProcessorTime?: string;
/**
- * Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled.
- * Otherwise,
- * the app is not served on those hostnames.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * User processor time.
*/
- readonly enabledHostNames?: string[];
+ userProcessorTime?: string;
/**
- * Management information availability state for the app. Possible values include: 'Normal',
- * 'Limited', 'DisasterRecoveryMode'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Thread state.
*/
- readonly availabilityState?: SiteAvailabilityState;
+ state?: string;
/**
- * Hostname SSL states are used to manage the SSL bindings for app's hostnames.
+ * Wait reason.
*/
- hostNameSslStates?: HostNameSslState[];
+ waitReason?: string;
+}
+
+/**
+ * Process Module Information.
+ */
+export interface ProcessModuleInfo extends ProxyOnlyResource {
/**
- * Resource ID of the associated App Service plan, formatted as:
- * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
+ * Base address. Used as module identifier in ARM resource URI.
*/
- serverFarmId?: string;
+ baseAddress?: string;
/**
- * true if reserved; otherwise, false. Default value: false.
+ * File name.
*/
- reserved?: boolean;
+ fileName?: string;
/**
- * Obsolete: Hyper-V sandbox. Default value: false.
+ * HRef URI.
*/
- isXenon?: boolean;
+ href?: string;
/**
- * Hyper-V sandbox. Default value: false.
+ * File path.
*/
- hyperV?: boolean;
+ filePath?: string;
/**
- * Last time the app was modified, in UTC. Read-only.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Module memory size.
*/
- readonly lastModifiedTimeUtc?: Date;
+ moduleMemorySize?: number;
/**
- * Configuration of the app.
+ * File version.
*/
- siteConfig?: SiteConfig;
+ fileVersion?: string;
/**
- * Azure Traffic Manager hostnames associated with the app. Read-only.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * File description.
*/
- readonly trafficManagerHostNames?: string[];
+ fileDescription?: string;
/**
- * true to stop SCM (KUDU) site when the app is stopped; otherwise,
- * false. The default is false. Default value: false.
+ * Product name.
*/
- scmSiteAlsoStopped?: boolean;
+ product?: string;
/**
- * Specifies which deployment slot this app will swap into. Read-only.
+ * Product version.
+ */
+ productVersion?: string;
+ /**
+ * Is debug?
+ */
+ isDebug?: boolean;
+ /**
+ * Module language (locale).
+ */
+ language?: string;
+}
+
+/**
+ * Process Information.
+ */
+export interface ProcessInfo extends ProxyOnlyResource {
+ /**
+ * ARM Identifier for deployment.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly targetSwapSlot?: string;
+ readonly identifier?: number;
/**
- * App Service Environment to use for the app.
+ * Deployment name.
*/
- hostingEnvironmentProfile?: HostingEnvironmentProfile;
+ deploymentName?: string;
/**
- * true to enable client affinity; false to stop sending session
- * affinity cookies, which route client requests in the same session to the same instance.
- * Default is true.
+ * HRef URI.
*/
- clientAffinityEnabled?: boolean;
+ href?: string;
/**
- * true to enable client certificate authentication (TLS mutual authentication);
- * otherwise, false. Default is false.
+ * Minidump URI.
*/
- clientCertEnabled?: boolean;
+ minidump?: string;
/**
- * This composes with ClientCertEnabled setting.
- * - ClientCertEnabled: false means ClientCert is ignored.
- * - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
- * - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or
- * accepted. Possible values include: 'Required', 'Optional', 'OptionalInteractiveUser'
+ * Is profile running?
*/
- clientCertMode?: ClientCertMode;
+ isProfileRunning?: boolean;
/**
- * client certificate authentication comma-separated exclusion paths
+ * Is the IIS Profile running?
*/
- clientCertExclusionPaths?: string;
+ isIisProfileRunning?: boolean;
/**
- * true to disable the public hostnames of the app; otherwise, false.
- * If true, the app is only accessible via API management process.
+ * IIS Profile timeout (seconds).
*/
- hostNamesDisabled?: boolean;
+ iisProfileTimeoutInSeconds?: number;
/**
- * Unique identifier that verifies the custom domains assigned to the app. Customer will add this
- * id to a txt record for verification.
+ * Parent process.
*/
- customDomainVerificationId?: string;
+ parent?: string;
/**
- * List of IP addresses that the app uses for outbound connections (e.g. database access).
- * Includes VIPs from tenants that site can be hosted with current settings. Read-only.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Child process list.
*/
- readonly outboundIpAddresses?: string;
+ children?: string[];
/**
- * List of IP addresses that the app uses for outbound connections (e.g. database access).
- * Includes VIPs from all tenants except dataComponent. Read-only.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Thread list.
*/
- readonly possibleOutboundIpAddresses?: string;
+ threads?: ProcessThreadInfo[];
/**
- * Size of the function container.
+ * List of open files.
*/
- containerSize?: number;
+ openFileHandles?: string[];
/**
- * Maximum allowed daily memory-time quota (applicable on dynamic apps only).
+ * List of modules.
*/
- dailyMemoryTimeQuota?: number;
+ modules?: ProcessModuleInfo[];
/**
- * App suspended till in case memory-time quota is exceeded.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * File name of this process.
*/
- readonly suspendedTill?: Date;
+ fileName?: string;
/**
- * Maximum number of workers.
- * This only applies to Functions container.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Command line.
*/
- readonly maxNumberOfWorkers?: number;
+ commandLine?: string;
/**
- * If specified during app creation, the app is cloned from a source app.
+ * User name.
*/
- cloningInfo?: CloningInfo;
+ userName?: string;
/**
- * Name of the resource group the app belongs to. Read-only.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Handle count.
*/
- readonly resourceGroup?: string;
+ handleCount?: number;
/**
- * true if the app is a default container; otherwise, false.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Module count.
*/
- readonly isDefaultContainer?: boolean;
+ moduleCount?: number;
/**
- * Default hostname of the app. Read-only.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Thread count.
*/
- readonly defaultHostName?: string;
+ threadCount?: number;
/**
- * Status of the last deployment slot swap operation.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Start time.
*/
- readonly slotSwapStatus?: SlotSwapStatus;
+ startTime?: Date;
/**
- * HttpsOnly: configures a web site to accept only https requests. Issues redirect for
- * http requests
+ * Total CPU time.
*/
- httpsOnly?: boolean;
+ totalCpuTime?: string;
/**
- * Site redundancy mode. Possible values include: 'None', 'Manual', 'Failover', 'ActiveActive',
- * 'GeoRedundant'
+ * User CPU time.
*/
- redundancyMode?: RedundancyMode;
+ userCpuTime?: string;
/**
- * Specifies an operation id if this site has a pending operation.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Privileged CPU time.
*/
- readonly inProgressOperationId?: string;
+ privilegedCpuTime?: string;
/**
- * Checks if Customer provided storage account is required
+ * Working set.
*/
- storageAccountRequired?: boolean;
+ workingSet?: number;
/**
- * Identity to use for Key Vault Reference authentication.
+ * Peak working set.
*/
- keyVaultReferenceIdentity?: string;
+ peakWorkingSet?: number;
/**
- * Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET
- * Integration.
- * This must be of the form
- * /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}
+ * Private memory size.
*/
- virtualNetworkSubnetId?: string;
- identity?: ManagedServiceIdentity;
-}
-
-/**
- * Used for getting PHP error logging flag.
- */
-export interface SitePhpErrorLogFlag extends ProxyOnlyResource {
+ privateMemory?: number;
/**
- * Local log_errors setting.
+ * Virtual memory size.
*/
- localLogErrors?: string;
+ virtualMemory?: number;
/**
- * Master log_errors setting.
+ * Peak virtual memory usage.
*/
- masterLogErrors?: string;
+ peakVirtualMemory?: number;
/**
- * Local log_errors_max_len setting.
+ * Paged system memory.
*/
- localLogErrorsMaxLength?: string;
+ pagedSystemMemory?: number;
/**
- * Master log_errors_max_len setting.
+ * Non-paged system memory.
*/
- masterLogErrorsMaxLength?: string;
-}
-
-/**
- * Source control configuration for an app.
- */
-export interface SiteSourceControl extends ProxyOnlyResource {
+ nonPagedSystemMemory?: number;
/**
- * Repository or source control URL.
+ * Paged memory.
*/
- repoUrl?: string;
+ pagedMemory?: number;
/**
- * Name of branch to use for deployment.
+ * Peak paged memory.
*/
- branch?: string;
+ peakPagedMemory?: number;
/**
- * true to limit to manual integration; false to enable continuous
- * integration (which configures webhooks into online repos like GitHub).
+ * Time stamp.
*/
- isManualIntegration?: boolean;
+ timeStamp?: Date;
/**
- * true if this is deployed via GitHub action.
+ * List of environment variables.
*/
- isGitHubAction?: boolean;
+ environmentVariables?: { [propertyName: string]: string };
/**
- * true to enable deployment rollback; otherwise, false.
+ * Is this the SCM site?
*/
- deploymentRollbackEnabled?: boolean;
+ isScmSite?: boolean;
/**
- * true for a Mercurial repository; false for a Git repository.
+ * Is this a Web Job?
*/
- isMercurial?: boolean;
+ isWebjob?: boolean;
/**
- * If GitHub Action is selected, than the associated configuration.
+ * Description of process.
*/
- gitHubActionConfiguration?: GitHubActionConfiguration;
+ description?: string;
}
/**
- * Slot Config names azure resource.
+ * Public certificate object
*/
-export interface SlotConfigNamesResource extends ProxyOnlyResource {
+export interface PublicCertificate extends ProxyOnlyResource {
/**
- * List of connection string names.
+ * Public Certificate byte array
*/
- connectionStringNames?: string[];
+ blob?: Uint8Array;
/**
- * List of application settings names.
+ * Public Certificate Location. Possible values include: 'CurrentUserMy', 'LocalMachineMy',
+ * 'Unknown'
*/
- appSettingNames?: string[];
+ publicCertificateLocation?: PublicCertificateLocation;
/**
- * List of external Azure storage account identifiers.
+ * Certificate Thumbprint
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- azureStorageConfigNames?: string[];
+ readonly thumbprint?: string;
}
/**
- * A setting difference between two deployment slots of an app.
+ * Description of a restore request.
*/
-export interface SlotDifference extends ProxyOnlyResource {
+export interface RestoreRequest extends ProxyOnlyResource {
/**
- * Level of the difference: Information, Warning or Error.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * SAS URL to the container.
*/
- readonly level?: string;
+ storageAccountUrl: string;
/**
- * The type of the setting: General, AppSetting or ConnectionString.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Name of a blob which contains the backup.
*/
- readonly settingType?: string;
+ blobName?: string;
/**
- * Rule that describes how to process the setting difference during a slot swap.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * true if the restore operation can overwrite target app; otherwise,
+ * false. true is needed if trying to restore over an existing app.
*/
- readonly diffRule?: string;
+ overwrite: boolean;
/**
- * Name of the setting.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Name of an app.
*/
- readonly settingName?: string;
+ siteName?: string;
/**
- * Value of the setting in the current slot.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Collection of databases which should be restored. This list has to match the list of databases
+ * included in the backup.
*/
- readonly valueInCurrentSlot?: string;
+ databases?: DatabaseBackupSetting[];
/**
- * Value of the setting in the target slot.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Changes a logic when restoring an app with custom domains. true to remove custom
+ * domains automatically. If false, custom domains are added to
+ * the app's object when it is being restored, but that might fail due to conflicts during the
+ * operation. Default value: false.
*/
- readonly valueInTargetSlot?: string;
+ ignoreConflictingHostNames?: boolean;
/**
- * Description of the setting difference.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Ignore the databases and only restore the site content. Default value: false.
*/
- readonly description?: string;
+ ignoreDatabases?: boolean;
+ /**
+ * Specify app service plan that will own restored site.
+ */
+ appServicePlan?: string;
+ /**
+ * Operation type. Possible values include: 'Default', 'Clone', 'Relocation', 'Snapshot',
+ * 'CloudFS'. Default value: 'Default'.
+ */
+ operationType?: BackupRestoreOperationType;
+ /**
+ * true if SiteConfig.ConnectionStrings should be set in new app; otherwise,
+ * false.
+ */
+ adjustConnectionStrings?: boolean;
+ /**
+ * App Service Environment name, if needed (only when restoring an app to an App Service
+ * Environment).
+ */
+ hostingEnvironment?: string;
}
/**
- * Specifies the web app that snapshot contents will be retrieved from.
+ * Configuration settings for the Azure App Service Authentication / Authorization feature.
*/
-export interface SnapshotRecoverySource {
+export interface SiteAuthSettings extends ProxyOnlyResource {
/**
- * Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS
+ * true if the Authentication / Authorization feature is enabled for the current
+ * app; otherwise, false.
*/
- location?: string;
+ enabled?: boolean;
/**
- * ARM resource ID of the source app.
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
- * for production slots and
- * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
- * for other slots.
+ * The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
+ * The setting in this value can control the behavior of certain features in the Authentication /
+ * Authorization module.
*/
- id?: string;
-}
-
-/**
- * Details about app recovery operation.
- */
-export interface SnapshotRestoreRequest extends ProxyOnlyResource {
+ runtimeVersion?: string;
/**
- * Point in time in which the app restore should be done, formatted as a DateTime string.
+ * The action to take when an unauthenticated client attempts to access the app. Possible values
+ * include: 'RedirectToLoginPage', 'AllowAnonymous'
*/
- snapshotTime?: string;
+ unauthenticatedClientAction?: UnauthenticatedClientAction;
/**
- * Optional. Specifies the web app that snapshot contents will be retrieved from.
- * If empty, the targeted web app will be used as the source.
+ * true to durably store platform-specific security tokens that are obtained during
+ * login flows; otherwise, false.
+ * The default is false.
*/
- recoverySource?: SnapshotRecoverySource;
+ tokenStoreEnabled?: boolean;
/**
- * If true the restore operation can overwrite source app; otherwise,
- * false.
+ * 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.
+ * This is an advanced setting typically only needed by Windows Store application backends.
+ * Note that URLs within the current domain are always implicitly allowed.
*/
- overwrite: boolean;
+ allowedExternalRedirectUrls?: string[];
/**
- * If true, site configuration, in addition to content, will be reverted.
+ * The default authentication provider to use when multiple providers are configured.
+ * This setting is only needed if multiple providers are configured and the unauthenticated
+ * client
+ * action is set to "RedirectToLoginPage". Possible values include: 'AzureActiveDirectory',
+ * 'Facebook', 'Google', 'MicrosoftAccount', 'Twitter', 'Github'
*/
- recoverConfiguration?: boolean;
+ defaultProvider?: BuiltInAuthenticationProvider;
/**
- * If true, custom hostname conflicts will be ignored when recovering to a target web app.
- * This setting is only necessary when RecoverConfiguration is enabled.
+ * The number of hours after session token expiration that a session token can be used to
+ * call the token refresh API. The default is 72 hours.
*/
- ignoreConflictingHostNames?: boolean;
+ tokenRefreshExtensionHours?: number;
/**
- * If true, the snapshot is retrieved from DRSecondary endpoint.
+ * The Client ID of this relying party application, known as the client_id.
+ * This setting is required for enabling OpenID Connection authentication with Azure Active
+ * Directory or
+ * other 3rd party OpenID Connect providers.
+ * More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
*/
- useDRSecondary?: boolean;
-}
-
-/**
- * Options for app content migration.
- */
-export interface StorageMigrationOptions extends ProxyOnlyResource {
+ clientId?: string;
/**
- * AzureFiles connection string.
+ * The Client Secret of this relying party application (in Azure Active Directory, this is also
+ * referred to as the Key).
+ * This setting is optional. If no client secret is configured, the OpenID Connect implicit auth
+ * flow is used to authenticate end users.
+ * Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.
+ * More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
*/
- azurefilesConnectionString: string;
+ clientSecret?: string;
/**
- * AzureFiles share.
+ * The app setting name that contains the client secret of the relying party application.
*/
- azurefilesShare: string;
+ clientSecretSettingName?: string;
/**
- * trueif the app should be switched over; otherwise, false. Default
- * value: false.
+ * An alternative to the client secret, that is the thumbprint of a certificate used for signing
+ * purposes. This property acts as
+ * a replacement for the Client Secret. It is also optional.
*/
- switchSiteAfterMigration?: boolean;
+ clientSecretCertificateThumbprint?: string;
/**
- * true if the app should be read only during copy operation; otherwise,
- * false. Default value: false.
+ * The OpenID Connect Issuer URI that represents the entity which issues access tokens for this
+ * application.
+ * When using Azure Active Directory, this value is the URI of the directory tenant, e.g.
+ * https://sts.windows.net/{tenant-guid}/.
+ * This URI is a case-sensitive identifier for the token issuer.
+ * More information on OpenID Connect Discovery:
+ * http://openid.net/specs/openid-connect-discovery-1_0.html
*/
- blockWriteAccessToSite?: boolean;
-}
-
-/**
- * Response for a migration of app content request.
- */
-export interface StorageMigrationResponse extends ProxyOnlyResource {
+ issuer?: string;
/**
- * When server starts the migration process, it will return an operation ID identifying that
- * particular migration operation.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as
+ * such.
*/
- readonly operationId?: string;
-}
-
-/**
- * Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual
- * network integration.
- */
-export interface SwiftVirtualNetwork extends ProxyOnlyResource {
+ validateIssuer?: boolean;
/**
- * 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.
+ * Allowed audience values to consider when validating JWTs issued by
+ * Azure Active Directory. Note that the ClientID value is always considered an
+ * allowed audience, regardless of this setting.
*/
- subnetResourceId?: string;
+ allowedAudiences?: string[];
/**
- * A flag that specifies if the scale unit this Web App is on supports Swift integration.
+ * Login parameters to send to the OpenID Connect authorization endpoint when
+ * a user logs in. Each parameter must be in the form "key=value".
*/
- swiftSupported?: boolean;
-}
-
-/**
- * Triggered Web Job Run Information.
- */
-export interface TriggeredJobRun extends ProxyOnlyResource {
+ additionalLoginParams?: string[];
/**
- * Job ID.
+ * Gets a JSON string containing the Azure AD Acl settings.
*/
- webJobId?: string;
+ aadClaimsAuthorization?: string;
/**
- * Job name.
+ * The OpenID Connect Client ID for the Google web application.
+ * This setting is required for enabling Google Sign-In.
+ * Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
*/
- webJobName?: string;
+ googleClientId?: string;
/**
- * Job status. Possible values include: 'Success', 'Failed', 'Error'
+ * The client secret associated with the Google web application.
+ * This setting is required for enabling Google Sign-In.
+ * Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
*/
- status?: TriggeredWebJobStatus;
+ googleClientSecret?: string;
/**
- * Start time.
+ * The app setting name that contains the client secret associated with
+ * the Google web application.
*/
- startTime?: Date;
+ googleClientSecretSettingName?: string;
/**
- * End time.
+ * The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
+ * This setting is optional. If not specified, "openid", "profile", and "email" are used as
+ * default scopes.
+ * Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
*/
- endTime?: Date;
+ googleOAuthScopes?: string[];
/**
- * Job duration.
+ * The App ID of the Facebook app used for login.
+ * This setting is required for enabling Facebook Login.
+ * Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
*/
- duration?: string;
+ facebookAppId?: string;
/**
- * Output URL.
+ * The App Secret of the Facebook app used for Facebook Login.
+ * This setting is required for enabling Facebook Login.
+ * Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
*/
- outputUrl?: string;
+ facebookAppSecret?: string;
/**
- * Error URL.
+ * The app setting name that contains the app secret used for Facebook Login.
*/
- errorUrl?: string;
+ facebookAppSecretSettingName?: string;
/**
- * Job URL.
+ * The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
+ * This setting is optional.
+ * Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
*/
- url?: string;
+ facebookOAuthScopes?: string[];
/**
- * Job name.
+ * The Client Id of the GitHub app used for login.
+ * This setting is required for enabling Github login
*/
- jobName?: string;
+ gitHubClientId?: string;
/**
- * Job trigger.
+ * The Client Secret of the GitHub app used for Github Login.
+ * This setting is required for enabling Github login.
*/
- trigger?: string;
-}
-
-/**
- * Triggered Web Job History. List of Triggered Web Job Run Information elements.
- */
-export interface TriggeredJobHistory extends ProxyOnlyResource {
+ gitHubClientSecret?: string;
/**
- * List of triggered web job runs.
+ * The app setting name that contains the client secret of the Github
+ * app used for GitHub Login.
*/
- runs?: TriggeredJobRun[];
-}
-
-/**
- * Triggered Web Job Information.
- */
-export interface TriggeredWebJob extends ProxyOnlyResource {
+ gitHubClientSecretSettingName?: string;
/**
- * Latest job run information.
+ * The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
+ * This setting is optional
*/
- latestRun?: TriggeredJobRun;
+ gitHubOAuthScopes?: string[];
/**
- * History URL.
+ * The OAuth 1.0a consumer key of the Twitter application used for sign-in.
+ * This setting is required for enabling Twitter Sign-In.
+ * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
*/
- historyUrl?: string;
+ twitterConsumerKey?: string;
/**
- * Scheduler Logs URL.
+ * The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
+ * This setting is required for enabling Twitter Sign-In.
+ * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
*/
- schedulerLogsUrl?: string;
+ twitterConsumerSecret?: string;
/**
- * Run command.
+ * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
+ * application used for sign-in.
*/
- runCommand?: string;
+ twitterConsumerSecretSettingName?: string;
/**
- * Job URL.
+ * The OAuth 2.0 client ID that was created for the app used for authentication.
+ * This setting is required for enabling Microsoft Account authentication.
+ * Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
*/
- url?: string;
+ microsoftAccountClientId?: string;
/**
- * Extra Info URL.
+ * The OAuth 2.0 client secret that was created for the app used for authentication.
+ * This setting is required for enabling Microsoft Account authentication.
+ * Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
*/
- extraInfoUrl?: string;
+ microsoftAccountClientSecret?: string;
/**
- * Job type. Possible values include: 'Continuous', 'Triggered'
+ * The app setting name containing the OAuth 2.0 client secret that was created for the
+ * app used for authentication.
*/
- webJobType?: WebJobType;
+ microsoftAccountClientSecretSettingName?: string;
/**
- * Error information.
+ * The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
+ * This setting is optional. If not specified, "wl.basic" is used as the default scope.
+ * Microsoft Account Scopes and permissions documentation:
+ * https://msdn.microsoft.com/en-us/library/dn631845.aspx
*/
- error?: string;
+ microsoftAccountOAuthScopes?: string[];
/**
- * Using SDK?
+ * "true" if the auth config settings should be read from a file,
+ * "false" otherwise
+ */
+ isAuthFromFile?: string;
+ /**
+ * The path of the config file containing auth settings.
+ * If the path is relative, base will the site's root directory.
*/
- usingSdk?: boolean;
+ authFilePath?: string;
/**
- * Job settings.
+ * The ConfigVersion of the Authentication / Authorization feature in use for the current app.
+ * The setting in this value can control the behavior of the control plane for Authentication /
+ * Authorization.
*/
- settings?: { [propertyName: string]: any };
+ configVersion?: string;
}
/**
- * An interface representing WebSiteInstanceStatus.
+ * Configuration settings for the Azure App Service Authentication / Authorization V2 feature.
*/
-export interface WebSiteInstanceStatus extends ProxyOnlyResource {
+export interface SiteAuthSettingsV2 extends ProxyOnlyResource {
/**
- * Possible values include: 'READY', 'STOPPED', 'UNKNOWN'
+ * The configuration settings of the platform of App Service Authentication/Authorization.
*/
- state?: SiteRuntimeState;
+ platform?: AuthPlatform;
/**
- * Link to the GetStatusApi in Kudu
+ * The configuration settings that determines the validation flow of users using App Service
+ * Authentication/Authorization.
*/
- statusUrl?: string;
+ globalValidation?: GlobalValidation;
/**
- * Link to the Diagnose and Solve Portal
+ * The configuration settings of each of the identity providers used to configure App Service
+ * Authentication/Authorization.
*/
- detectorUrl?: string;
+ identityProviders?: IdentityProviders;
/**
- * Link to the console to web app instance
+ * The configuration settings of the login flow of users using App Service
+ * Authentication/Authorization.
*/
- consoleUrl?: string;
+ login?: Login;
/**
- * Link to the console to web app instance
+ * The configuration settings of the HTTP requests for authentication and authorization requests
+ * made against App Service Authentication/Authorization.
*/
- healthCheckUrl?: string;
- containers?: { [propertyName: string]: ContainerInfo };
+ httpSettings?: HttpSettings;
}
/**
- * Web Job Information.
+ * An app cloneability criterion.
*/
-export interface WebJob extends ProxyOnlyResource {
- /**
- * Run command.
- */
- runCommand?: string;
+export interface SiteCloneabilityCriterion {
/**
- * Job URL.
+ * Name of criterion.
*/
- url?: string;
+ name?: string;
/**
- * Extra Info URL.
+ * Description of criterion.
*/
- extraInfoUrl?: string;
+ description?: string;
+}
+
+/**
+ * Represents whether or not an app is cloneable.
+ */
+export interface SiteCloneability {
/**
- * Job type. Possible values include: 'Continuous', 'Triggered'
+ * Name of app. Possible values include: 'Cloneable', 'PartiallyCloneable', 'NotCloneable'
*/
- webJobType?: WebJobType;
+ result?: CloneAbilityResult;
/**
- * Error information.
+ * List of features enabled on app that prevent cloning.
*/
- error?: string;
+ blockingFeatures?: SiteCloneabilityCriterion[];
/**
- * Using SDK?
+ * List of features enabled on app that are non-blocking but cannot be cloned. The app can still
+ * be cloned
+ * but the features in this list will not be set up on cloned app.
*/
- usingSdk?: boolean;
+ unsupportedFeatures?: SiteCloneabilityCriterion[];
/**
- * Job settings.
+ * List of blocking application characteristics.
*/
- settings?: { [propertyName: string]: any };
+ blockingCharacteristics?: SiteCloneabilityCriterion[];
}
/**
- * The plan object in Azure Resource Manager, represents a marketplace plan.
+ * Web app configuration ARM resource.
*/
-export interface ArmPlan {
+export interface SiteConfigResource extends ProxyOnlyResource {
/**
- * The name.
+ * Number of workers.
*/
- name?: string;
+ numberOfWorkers?: number;
/**
- * The publisher.
+ * Default documents.
*/
- publisher?: string;
+ defaultDocuments?: string[];
/**
- * The product.
+ * .NET Framework version. Default value: 'v4.6'.
*/
- product?: string;
+ netFrameworkVersion?: string;
/**
- * The promotion code.
+ * Version of PHP.
*/
- promotionCode?: string;
+ phpVersion?: string;
/**
- * Version of product.
+ * Version of Python.
*/
- version?: string;
-}
-
-/**
- * A remote private endpoint connection
- */
-export interface RemotePrivateEndpointConnection extends ProxyOnlyResource {
+ pythonVersion?: string;
/**
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Version of Node.js.
*/
- readonly provisioningState?: string;
+ nodeVersion?: string;
/**
- * PrivateEndpoint of a remote private endpoint connection
+ * Version of PowerShell.
*/
- privateEndpoint?: ArmIdWrapper;
- privateLinkServiceConnectionState?: PrivateLinkConnectionState;
+ powerShellVersion?: string;
/**
- * Private IPAddresses mapped to the remote private endpoint
+ * Linux App Framework and version
*/
- ipAddresses?: string[];
-}
-
-/**
- * Message envelope that contains the common Azure resource manager properties and the resource
- * provider specific content.
- */
-export interface ResponseMessageEnvelopeRemotePrivateEndpointConnection {
+ linuxFxVersion?: string;
/**
- * Resource Id. Typically ID is populated only for responses to GET requests. Caller is
- * responsible for passing in this
- * value for GET requests only.
- * For example:
- * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}
+ * Xenon App Framework and version
*/
- id?: string;
+ windowsFxVersion?: string;
/**
- * Name of resource.
+ * true if request tracing is enabled; otherwise, false.
*/
- name?: string;
+ requestTracingEnabled?: boolean;
/**
- * Type of resource e.g "Microsoft.Web/sites".
+ * Request tracing expiration time.
*/
- type?: string;
+ requestTracingExpirationTime?: Date;
/**
- * Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia.
+ * true if remote debugging is enabled; otherwise, false.
*/
- location?: string;
+ remoteDebuggingEnabled?: boolean;
/**
- * Tags associated with resource.
+ * Remote debugging version.
*/
- tags?: { [propertyName: string]: string };
+ remoteDebuggingVersion?: string;
/**
- * Azure resource manager plan.
+ * true if HTTP logging is enabled; otherwise, false.
*/
- plan?: ArmPlan;
+ httpLoggingEnabled?: boolean;
/**
- * Resource specific properties.
+ * Flag to use Managed Identity Creds for ACR pull
*/
- properties?: RemotePrivateEndpointConnection;
+ acrUseManagedIdentityCreds?: boolean;
/**
- * SKU description of the resource.
+ * If using user managed identity, the user managed identity ClientId
*/
- sku?: SkuDescription;
+ acrUserManagedIdentityID?: string;
/**
- * Azure-AsyncOperation Status info.
+ * HTTP logs directory size limit.
*/
- status?: string;
+ logsDirectorySizeLimit?: number;
/**
- * Azure-AsyncOperation Error info.
+ * true if detailed error logging is enabled; otherwise, false.
*/
- error?: ErrorEntity;
+ detailedErrorLoggingEnabled?: boolean;
/**
- * MSI resource
+ * Publishing user name.
*/
- identity?: ManagedServiceIdentity;
+ publishingUsername?: string;
/**
- * Logical Availability Zones the service is hosted in
+ * Application settings.
*/
- zones?: string[];
-}
-
-/**
- * Build properties for the static site.
- */
-export interface StaticSiteBuildProperties {
+ appSettings?: NameValuePair[];
/**
- * The path to the app code within the repository.
+ * Connection strings.
*/
- appLocation?: string;
+ connectionStrings?: ConnStringInfo[];
/**
- * The path to the api code within the repository.
+ * Site MachineKey.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- apiLocation?: string;
+ readonly machineKey?: SiteMachineKey;
/**
- * Deprecated: The path of the app artifacts after building (deprecated in favor of
- * OutputLocation)
+ * Handler mappings.
*/
- appArtifactLocation?: string;
+ handlerMappings?: HandlerMapping[];
/**
- * The output path of the app after building.
+ * Document root.
*/
- outputLocation?: string;
+ documentRoot?: string;
/**
- * A custom command to run during deployment of the static content application.
+ * SCM type. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub',
+ * 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg',
+ * 'OneDrive', 'VSO', 'VSTSRM'
*/
- appBuildCommand?: string;
+ scmType?: ScmType;
/**
- * A custom command to run during deployment of the Azure Functions API application.
+ * true to use 32-bit worker process; otherwise, false.
*/
- apiBuildCommand?: string;
+ use32BitWorkerProcess?: boolean;
/**
- * Skip Github Action workflow generation.
+ * true if WebSocket is enabled; otherwise, false.
*/
- skipGithubActionWorkflowGeneration?: boolean;
+ webSocketsEnabled?: boolean;
/**
- * Github Action secret name override.
+ * true if Always On is enabled; otherwise, false.
*/
- githubActionSecretNameOverride?: string;
-}
-
-/**
- * Template Options for the static site.
- */
-export interface StaticSiteTemplateOptions {
+ alwaysOn?: boolean;
/**
- * URL of the template repository. The newly generated repository will be based on this one.
+ * Java version.
*/
- templateRepositoryUrl?: string;
+ javaVersion?: string;
/**
- * Owner of the newly generated repository.
+ * Java container.
*/
- owner?: string;
+ javaContainer?: string;
/**
- * Name of the newly generated repository.
+ * Java container version.
*/
- repositoryName?: string;
+ javaContainerVersion?: string;
/**
- * Description of the newly generated repository.
+ * App command line to launch.
*/
- description?: string;
+ appCommandLine?: string;
/**
- * Whether or not the newly generated repository is a private repository. Defaults to false (i.e.
- * public).
+ * Managed pipeline mode. Possible values include: 'Integrated', 'Classic'
*/
- isPrivate?: boolean;
-}
-
-/**
- * A static site user provided function.
- */
-export interface StaticSiteUserProvidedFunctionApp extends ProxyOnlyResource {
+ managedPipelineMode?: ManagedPipelineMode;
+ /**
+ * Virtual applications.
+ */
+ virtualApplications?: VirtualApplication[];
+ /**
+ * Site load balancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests',
+ * 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash', 'PerSiteRoundRobin'
+ */
+ loadBalancing?: SiteLoadBalancing;
/**
- * The resource id of the function app registered with the static site
+ * This is work around for polymorphic types.
*/
- functionAppResourceId?: string;
+ experiments?: Experiments;
/**
- * The region of the function app registered with the static site
+ * Site limits.
*/
- functionAppRegion?: string;
+ limits?: SiteLimits;
/**
- * The date and time on which the function app was registered with the static site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * true if Auto Heal is enabled; otherwise, false.
*/
- readonly createdOn?: Date;
-}
-
-/**
- * Static Site ARM resource.
- */
-export interface StaticSiteARMResource extends Resource {
+ autoHealEnabled?: boolean;
/**
- * The default autogenerated hostname for the static site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Auto Heal rules.
*/
- readonly defaultHostname?: string;
+ autoHealRules?: AutoHealRules;
/**
- * URL for the repository of the static site.
+ * Tracing options.
*/
- repositoryUrl?: string;
+ tracingOptions?: string;
/**
- * The target branch in the repository.
+ * Virtual Network name.
*/
- branch?: string;
+ vnetName?: string;
/**
- * The custom domains associated with this static site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network
+ * Security Groups and User Defined Routes applied.
*/
- readonly customDomains?: string[];
+ vnetRouteAllEnabled?: boolean;
/**
- * A user's github repository token. This is used to setup the Github Actions workflow file and
- * API secrets.
+ * The number of private ports assigned to this app. These will be assigned dynamically on
+ * runtime.
*/
- repositoryToken?: string;
+ vnetPrivatePortsCount?: number;
/**
- * Build properties to configure on the repository.
+ * Cross-Origin Resource Sharing (CORS) settings.
*/
- buildProperties?: StaticSiteBuildProperties;
+ cors?: CorsSettings;
/**
- * Private endpoint connections
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Push endpoint settings.
*/
- readonly privateEndpointConnections?: ResponseMessageEnvelopeRemotePrivateEndpointConnection[];
+ push?: PushSettings;
/**
- * State indicating whether staging environments are allowed or not allowed for a static web app.
- * Possible values include: 'Enabled', 'Disabled'
+ * Information about the formal API definition for the app.
*/
- stagingEnvironmentPolicy?: StagingEnvironmentPolicy;
+ apiDefinition?: ApiDefinitionInfo;
/**
- * false if config file is locked for this static web app; otherwise,
- * true.
+ * Azure API management settings linked to the app.
*/
- allowConfigFileUpdates?: boolean;
+ apiManagementConfig?: ApiManagementConfig;
/**
- * Template options for generating a new repository.
+ * Auto-swap slot name.
*/
- templateProperties?: StaticSiteTemplateOptions;
+ autoSwapSlotName?: string;
/**
- * The content distribution endpoint for the static site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * true to enable local MySQL; otherwise, false. Default value: false.
*/
- readonly contentDistributionEndpoint?: string;
+ localMySqlEnabled?: boolean;
/**
- * Identity to use for Key Vault Reference authentication.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Managed Service Identity Id
*/
- readonly keyVaultReferenceIdentity?: string;
+ managedServiceIdentityId?: number;
/**
- * User provided function apps registered with the static site
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Explicit Managed Service Identity Id
*/
- readonly userProvidedFunctionApps?: StaticSiteUserProvidedFunctionApp[];
+ xManagedServiceIdentityId?: number;
/**
- * The provider that submitted the last deployment to the primary environment of the static site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Identity to use for Key Vault Reference authentication.
*/
- readonly provider?: string;
- sku?: SkuDescription;
- identity?: ManagedServiceIdentity;
-}
-
-/**
- * Static Site Build ARM resource.
- */
-export interface StaticSiteBuildARMResource extends ProxyOnlyResource {
+ keyVaultReferenceIdentity?: string;
/**
- * An identifier for the static site build.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * IP security restrictions for main.
*/
- readonly buildId?: string;
+ ipSecurityRestrictions?: IpSecurityRestriction[];
/**
- * The source branch.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * IP security restrictions for scm.
*/
- readonly sourceBranch?: string;
+ scmIpSecurityRestrictions?: IpSecurityRestriction[];
/**
- * The title of a pull request that a static site build is related to.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * IP security restrictions for scm to use main.
*/
- readonly pullRequestTitle?: string;
+ scmIpSecurityRestrictionsUseMain?: boolean;
/**
- * The hostname for a static site build.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Http20Enabled: configures a web site to allow clients to connect over http2.0. Default value:
+ * true.
*/
- readonly hostname?: string;
+ http20Enabled?: boolean;
/**
- * When this build was created.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible
+ * values include: '1.0', '1.1', '1.2'
*/
- readonly createdTimeUtc?: Date;
+ minTlsVersion?: SupportedTlsVersions;
/**
- * When this build was updated.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM
+ * site. Possible values include: '1.0', '1.1', '1.2'
*/
- readonly lastUpdatedOn?: Date;
+ scmMinTlsVersion?: SupportedTlsVersions;
/**
- * The status of the static site build. Possible values include: 'WaitingForDeployment',
- * 'Uploading', 'Deploying', 'Ready', 'Failed', 'Deleting', 'Detached'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * State of FTP / FTPS service. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'
*/
- readonly status?: BuildStatus;
+ ftpsState?: FtpsState;
/**
- * User provided function apps registered with the static site build
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Number of preWarmed instances.
+ * This setting only applies to the Consumption and Elastic Plans
*/
- readonly userProvidedFunctionApps?: StaticSiteUserProvidedFunctionApp[];
-}
-
-/**
- * Static Site Custom Domain Overview ARM resource.
- */
-export interface StaticSiteCustomDomainOverviewARMResource extends ProxyOnlyResource {
+ preWarmedInstanceCount?: number;
/**
- * The domain name for the static site custom domain.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Maximum number of workers that a site can scale out to.
+ * This setting only applies to the Consumption and Elastic Premium Plans
*/
- readonly domainName?: string;
+ functionAppScaleLimit?: number;
/**
- * The date and time on which the custom domain was created for the static site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Health check path
*/
- readonly createdOn?: Date;
+ healthCheckPath?: string;
/**
- * The status of the custom domain. Possible values include: 'RetrievingValidationToken',
- * 'Validating', 'Adding', 'Ready', 'Failed', 'Deleting'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When
+ * enabled,
+ * the ScaleController will not monitor event sources directly, but will instead call to the
+ * runtime to get scale status.
*/
- readonly status?: CustomDomainStatus;
+ functionsRuntimeScaleMonitoringEnabled?: boolean;
/**
- * The TXT record validation token
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * 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
*/
- readonly validationToken?: string;
+ websiteTimeZone?: string;
/**
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Number of minimum instance count for a site
+ * This setting only applies to the Elastic Plans
*/
- readonly errorMessage?: string;
-}
-
-/**
- * Static Site Custom Domain Request Properties ARM resource.
- */
-export interface StaticSiteCustomDomainRequestPropertiesARMResource extends ProxyOnlyResource {
+ minimumElasticInstanceCount?: number;
/**
- * Validation method for adding a custom domain. Default value: 'cname-delegation'.
+ * List of Azure Storage Accounts.
*/
- validationMethod?: string;
+ azureStorageAccounts?: { [propertyName: string]: AzureStorageInfoValue };
+ /**
+ * Property to allow or block all public traffic.
+ */
+ publicNetworkAccess?: string;
}
/**
- * Static Site Function Overview ARM resource.
+ * A snapshot of a web app configuration.
*/
-export interface StaticSiteFunctionOverviewARMResource extends ProxyOnlyResource {
+export interface SiteConfigurationSnapshotInfo extends ProxyOnlyResource {
/**
- * The name for the function
+ * The time the snapshot was taken.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly functionName?: string;
+ readonly time?: Date;
/**
- * The trigger type of the function. Possible values include: 'HttpTrigger', 'Unknown'
+ * The id of the snapshot
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly triggerType?: TriggerTypes;
+ readonly snapshotId?: number;
}
/**
- * ARM resource for a static site when patching
+ * Site Extension Information.
*/
-export interface StaticSitePatchResource extends ProxyOnlyResource {
- /**
- * The default autogenerated hostname for the static site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly defaultHostname?: string;
+export interface SiteExtensionInfo extends ProxyOnlyResource {
/**
- * URL for the repository of the static site.
+ * Site extension ID.
*/
- repositoryUrl?: string;
+ extensionId?: string;
+ title?: string;
/**
- * The target branch in the repository.
+ * Site extension type. Possible values include: 'Gallery', 'WebRoot'
*/
- branch?: string;
+ extensionType?: SiteExtensionType;
/**
- * The custom domains associated with this static site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Summary description.
*/
- readonly customDomains?: string[];
+ summary?: string;
/**
- * A user's github repository token. This is used to setup the Github Actions workflow file and
- * API secrets.
+ * Detailed description.
*/
- repositoryToken?: string;
+ description?: string;
/**
- * Build properties to configure on the repository.
+ * Version information.
*/
- buildProperties?: StaticSiteBuildProperties;
+ version?: string;
/**
- * Private endpoint connections
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Extension URL.
*/
- readonly privateEndpointConnections?: ResponseMessageEnvelopeRemotePrivateEndpointConnection[];
+ extensionUrl?: string;
/**
- * State indicating whether staging environments are allowed or not allowed for a static web app.
- * Possible values include: 'Enabled', 'Disabled'
+ * Project URL.
*/
- stagingEnvironmentPolicy?: StagingEnvironmentPolicy;
+ projectUrl?: string;
/**
- * false if config file is locked for this static web app; otherwise,
- * true.
+ * Icon URL.
*/
- allowConfigFileUpdates?: boolean;
+ iconUrl?: string;
/**
- * Template options for generating a new repository.
+ * License URL.
*/
- templateProperties?: StaticSiteTemplateOptions;
+ licenseUrl?: string;
/**
- * The content distribution endpoint for the static site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Feed URL.
*/
- readonly contentDistributionEndpoint?: string;
+ feedUrl?: string;
/**
- * Identity to use for Key Vault Reference authentication.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * List of authors.
*/
- readonly keyVaultReferenceIdentity?: string;
+ authors?: string[];
/**
- * User provided function apps registered with the static site
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Installer command line parameters.
*/
- readonly userProvidedFunctionApps?: StaticSiteUserProvidedFunctionApp[];
+ installerCommandLineParams?: string;
/**
- * The provider that submitted the last deployment to the primary environment of the static site.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Published timestamp.
*/
- readonly provider?: string;
-}
-
-/**
- * Static Site Reset Properties ARM resource.
- */
-export interface StaticSiteResetPropertiesARMResource extends ProxyOnlyResource {
+ publishedDateTime?: Date;
/**
- * The token which proves admin privileges to the repository.
+ * Count of downloads.
*/
- repositoryToken?: string;
+ downloadCount?: number;
/**
- * Determines whether the repository should be updated with the new properties.
+ * true if the local version is the latest version; false otherwise.
*/
- shouldUpdateRepository?: boolean;
-}
-
-/**
- * Static Site User ARM resource.
- */
-export interface StaticSiteUserARMResource extends ProxyOnlyResource {
+ localIsLatestVersion?: boolean;
/**
- * The identity provider for the static site user.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Local path.
*/
- readonly provider?: string;
+ localPath?: string;
/**
- * The user id for the static site user.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Installed timestamp.
*/
- readonly userId?: string;
+ installedDateTime?: Date;
/**
- * The display name for the static site user.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Provisioning state.
*/
- readonly displayName?: string;
+ provisioningState?: string;
/**
- * The roles for the static site user, in free-form string format
+ * Site Extension comment.
*/
- roles?: string;
+ comment?: string;
}
/**
- * Static sites user roles invitation resource.
+ * Configuration of App Service site logs.
*/
-export interface StaticSiteUserInvitationRequestResource extends ProxyOnlyResource {
- /**
- * The domain name for the static site custom domain.
- */
- domain?: string;
+export interface SiteLogsConfig extends ProxyOnlyResource {
/**
- * The identity provider for the static site user.
+ * Application logs configuration.
*/
- provider?: string;
+ applicationLogs?: ApplicationLogsConfig;
/**
- * The user id for the static site user.
+ * HTTP logs configuration.
*/
- userDetails?: string;
+ httpLogs?: HttpLogsConfig;
/**
- * The roles for the static site user, in free-form string format
+ * Failed requests tracing configuration.
*/
- roles?: string;
+ failedRequestsTracing?: EnabledConfig;
/**
- * The number of hours the sas token stays valid
+ * Detailed error messages configuration.
*/
- numHoursToExpiration?: number;
+ detailedErrorMessages?: EnabledConfig;
}
/**
- * Static sites user roles invitation link resource.
+ * ARM resource for a site.
*/
-export interface StaticSiteUserInvitationResponseResource extends ProxyOnlyResource {
+export interface SitePatchResource extends ProxyOnlyResource {
/**
- * The expiration time of the invitation
+ * Current state of the app.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly expiresOn?: Date;
+ readonly state?: string;
/**
- * The url for the invitation link
+ * Hostnames associated with the app.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly invitationUrl?: string;
-}
-
-/**
- * Static Site User Provided Function App ARM resource.
- */
-export interface StaticSiteUserProvidedFunctionAppARMResource extends ProxyOnlyResource {
+ readonly hostNames?: string[];
/**
- * The resource id of the function app registered with the static site
+ * Name of the repository site.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- functionAppResourceId?: string;
+ readonly repositorySiteName?: string;
/**
- * The region of the function app registered with the static site
+ * State indicating whether the app has exceeded its quota usage. Read-only. Possible values
+ * include: 'Normal', 'Exceeded'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- functionAppRegion?: string;
+ readonly usageState?: UsageState;
/**
- * The date and time on which the function app was registered with the static site.
+ * true if the app is enabled; otherwise, false. Setting this value to
+ * false disables the app (takes the app offline).
+ */
+ enabled?: boolean;
+ /**
+ * Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled.
+ * Otherwise,
+ * the app is not served on those hostnames.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly createdOn?: Date;
-}
-
-/**
- * Static site zip deployment ARM resource.
- */
-export interface StaticSiteZipDeploymentARMResource extends ProxyOnlyResource {
+ readonly enabledHostNames?: string[];
/**
- * URL for the zipped app content
+ * Management information availability state for the app. Possible values include: 'Normal',
+ * 'Limited', 'DisasterRecoveryMode'
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- appZipUrl?: string;
+ readonly availabilityState?: SiteAvailabilityState;
/**
- * URL for the zipped api content
+ * Hostname SSL states are used to manage the SSL bindings for app's hostnames.
*/
- apiZipUrl?: string;
+ hostNameSslStates?: HostNameSslState[];
/**
- * A title to label the deployment
+ * Resource ID of the associated App Service plan, formatted as:
+ * "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
*/
- deploymentTitle?: string;
+ serverFarmId?: string;
/**
- * The provider submitting this deployment
+ * true if reserved; otherwise, false. Default value: false.
*/
- provider?: string;
+ reserved?: boolean;
/**
- * The language of the api content, if it exists
+ * Obsolete: Hyper-V sandbox. Default value: false.
*/
- functionLanguage?: string;
-}
-
-/**
- * Preview for the Static Site Workflow to be generated
- */
-export interface StaticSitesWorkflowPreview extends ProxyOnlyResource {
+ isXenon?: boolean;
/**
- * The path for the workflow file to be generated
+ * Hyper-V sandbox. Default value: false.
+ */
+ hyperV?: boolean;
+ /**
+ * Last time the app was modified, in UTC. Read-only.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly path?: string;
+ readonly lastModifiedTimeUtc?: Date;
/**
- * The contents for the workflow file to be generated
+ * Configuration of the app.
+ */
+ siteConfig?: SiteConfig;
+ /**
+ * Azure Traffic Manager hostnames associated with the app. Read-only.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly contents?: string;
-}
-
-/**
- * Request entity for previewing the Static Site workflow
- */
-export interface StaticSitesWorkflowPreviewRequest extends ProxyOnlyResource {
+ readonly trafficManagerHostNames?: string[];
/**
- * URL for the repository of the static site.
+ * true to stop SCM (KUDU) site when the app is stopped; otherwise,
+ * false. The default is false. Default value: false.
*/
- repositoryUrl?: string;
+ scmSiteAlsoStopped?: boolean;
/**
- * The target branch in the repository.
+ * Specifies which deployment slot this app will swap into. Read-only.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- branch?: string;
+ readonly targetSwapSlot?: string;
/**
- * Build properties to configure on the repository.
+ * App Service Environment to use for the app.
*/
- buildProperties?: StaticSiteBuildProperties;
-}
-
-/**
- * String list resource.
- */
-export interface StringList extends ProxyOnlyResource {
+ hostingEnvironmentProfile?: HostingEnvironmentProfile;
/**
- * List of string resources.
+ * true to enable client affinity; false to stop sending session
+ * affinity cookies, which route client requests in the same session to the same instance.
+ * Default is true.
*/
- properties?: string[];
-}
-
-/**
- * Virtual IP mapping.
- */
-export interface VirtualIPMapping {
+ clientAffinityEnabled?: boolean;
/**
- * Virtual IP address.
+ * true to enable client certificate authentication (TLS mutual authentication);
+ * otherwise, false. Default is false.
*/
- virtualIP?: string;
+ clientCertEnabled?: boolean;
/**
- * Internal HTTP port.
+ * This composes with ClientCertEnabled setting.
+ * - ClientCertEnabled: false means ClientCert is ignored.
+ * - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
+ * - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or
+ * accepted. Possible values include: 'Required', 'Optional', 'OptionalInteractiveUser'
*/
- internalHttpPort?: number;
+ clientCertMode?: ClientCertMode;
/**
- * Internal HTTPS port.
+ * client certificate authentication comma-separated exclusion paths
*/
- internalHttpsPort?: number;
+ clientCertExclusionPaths?: string;
/**
- * Is virtual IP mapping in use.
+ * true to disable the public hostnames of the app; otherwise, false.
+ * If true, the app is only accessible via API management process.
*/
- inUse?: boolean;
+ hostNamesDisabled?: boolean;
/**
- * name of the service that virtual IP is assigned to
+ * Unique identifier that verifies the custom domains assigned to the app. Customer will add this
+ * id to a txt record for verification.
*/
- serviceName?: string;
-}
-
-/**
- * Describes main public IP address and any extra virtual IPs.
- */
-export interface AddressResponse extends ProxyOnlyResource {
+ customDomainVerificationId?: string;
/**
- * Main public virtual IP.
+ * List of IP addresses that the app uses for outbound connections (e.g. database access).
+ * Includes VIPs from tenants that site can be hosted with current settings. Read-only.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- serviceIpAddress?: string;
+ readonly outboundIpAddresses?: string;
/**
- * Virtual Network internal IP address of the App Service Environment if it is in internal
- * load-balancing mode.
+ * List of IP addresses that the app uses for outbound connections (e.g. database access).
+ * Includes VIPs from all tenants except dataComponent. Read-only.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- internalIpAddress?: string;
+ readonly possibleOutboundIpAddresses?: string;
/**
- * IP addresses appearing on outbound connections.
+ * Size of the function container.
*/
- outboundIpAddresses?: string[];
+ containerSize?: number;
/**
- * Additional virtual IPs.
+ * Maximum allowed daily memory-time quota (applicable on dynamic apps only).
*/
- vipMappings?: VirtualIPMapping[];
-}
-
-/**
- * App Service Environment ARM resource.
- */
-export interface AppServiceEnvironmentResource extends Resource {
+ dailyMemoryTimeQuota?: number;
/**
- * Provisioning state of the App Service Environment. Possible values include: 'Succeeded',
- * 'Failed', 'Canceled', 'InProgress', 'Deleting'
+ * App suspended till in case memory-time quota is exceeded.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly provisioningState?: ProvisioningState;
+ readonly suspendedTill?: Date;
/**
- * Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready',
- * 'Scaling', 'Deleting'
+ * Maximum number of workers.
+ * This only applies to Functions container.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly status?: HostingEnvironmentStatus;
+ readonly maxNumberOfWorkers?: number;
/**
- * Description of the Virtual Network.
+ * If specified during app creation, the app is cloned from a source app.
*/
- virtualNetwork: VirtualNetworkProfile;
+ cloningInfo?: CloningInfo;
/**
- * Specifies which endpoints to serve internally in the Virtual Network for the App Service
- * Environment. Possible values include: 'None', 'Web', 'Publishing', 'Web, Publishing'
+ * Name of the resource group the app belongs to. Read-only.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- internalLoadBalancingMode?: LoadBalancingMode;
+ readonly resourceGroup?: string;
/**
- * Front-end VM size, e.g. "Medium", "Large".
+ * true if the app is a default container; otherwise, false.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- multiSize?: string;
+ readonly isDefaultContainer?: boolean;
/**
- * Number of front-end instances.
+ * Default hostname of the app. Read-only.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly multiRoleCount?: number;
+ readonly defaultHostName?: string;
/**
- * Number of IP SSL addresses reserved for the App Service Environment.
+ * Status of the last deployment slot swap operation.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- ipsslAddressCount?: number;
+ readonly slotSwapStatus?: SlotSwapStatus;
/**
- * DNS suffix of the App Service Environment.
+ * HttpsOnly: configures a web site to accept only https requests. Issues redirect for
+ * http requests
*/
- dnsSuffix?: string;
+ httpsOnly?: boolean;
/**
- * Maximum number of VMs in the App Service Environment.
+ * Site redundancy mode. Possible values include: 'None', 'Manual', 'Failover', 'ActiveActive',
+ * 'GeoRedundant'
+ */
+ redundancyMode?: RedundancyMode;
+ /**
+ * Specifies an operation id if this site has a pending operation.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly maximumNumberOfMachines?: number;
+ readonly inProgressOperationId?: string;
/**
- * Scale factor for front-ends.
+ * Checks if Customer provided storage account is required
*/
- frontEndScaleFactor?: number;
+ storageAccountRequired?: boolean;
/**
- * true if the App Service Environment is suspended; otherwise, false.
- * The environment can be suspended, e.g. when the management endpoint is no longer available
- * (most likely because NSG blocked the incoming traffic).
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Identity to use for Key Vault Reference authentication.
*/
- readonly suspended?: boolean;
+ keyVaultReferenceIdentity?: string;
/**
- * Custom settings for changing the behavior of the App Service Environment.
+ * Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET
+ * Integration.
+ * This must be of the form
+ * /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}
*/
- clusterSettings?: NameValuePair[];
+ virtualNetworkSubnetId?: string;
+ identity?: ManagedServiceIdentity;
+}
+
+/**
+ * Used for getting PHP error logging flag.
+ */
+export interface SitePhpErrorLogFlag extends ProxyOnlyResource {
/**
- * User added ip ranges to whitelist on ASE db
+ * Local log_errors setting.
*/
- userWhitelistedIpRanges?: string[];
+ localLogErrors?: string;
/**
- * Flag that displays whether an ASE has linux workers or not
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Master log_errors setting.
*/
- readonly hasLinuxWorkers?: boolean;
+ masterLogErrors?: string;
/**
- * Dedicated Host Count
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Local log_errors_max_len setting.
*/
- readonly dedicatedHostCount?: number;
+ localLogErrorsMaxLength?: string;
+ /**
+ * Master log_errors_max_len setting.
+ */
+ masterLogErrorsMaxLength?: string;
}
/**
- * ARM resource for a app service environment.
+ * Source control configuration for an app.
*/
-export interface AppServiceEnvironmentPatchResource extends ProxyOnlyResource {
+export interface SiteSourceControl extends ProxyOnlyResource {
/**
- * Provisioning state of the App Service Environment. Possible values include: 'Succeeded',
- * 'Failed', 'Canceled', 'InProgress', 'Deleting'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Repository or source control URL.
*/
- readonly provisioningState?: ProvisioningState;
+ repoUrl?: string;
/**
- * Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready',
- * 'Scaling', 'Deleting'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Name of branch to use for deployment.
*/
- readonly status?: HostingEnvironmentStatus;
+ branch?: string;
/**
- * Description of the Virtual Network.
+ * true to limit to manual integration; false to enable continuous
+ * integration (which configures webhooks into online repos like GitHub).
*/
- virtualNetwork: VirtualNetworkProfile;
+ isManualIntegration?: boolean;
/**
- * Specifies which endpoints to serve internally in the Virtual Network for the App Service
- * Environment. Possible values include: 'None', 'Web', 'Publishing', 'Web, Publishing'
+ * true if this is deployed via GitHub action.
*/
- internalLoadBalancingMode?: LoadBalancingMode;
+ isGitHubAction?: boolean;
/**
- * Front-end VM size, e.g. "Medium", "Large".
+ * true to enable deployment rollback; otherwise, false.
*/
- multiSize?: string;
+ deploymentRollbackEnabled?: boolean;
/**
- * Number of front-end instances.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * true for a Mercurial repository; false for a Git repository.
*/
- readonly multiRoleCount?: number;
+ isMercurial?: boolean;
/**
- * Number of IP SSL addresses reserved for the App Service Environment.
+ * If GitHub Action is selected, than the associated configuration.
*/
- ipsslAddressCount?: number;
+ gitHubActionConfiguration?: GitHubActionConfiguration;
+}
+
+/**
+ * Slot Config names azure resource.
+ */
+export interface SlotConfigNamesResource extends ProxyOnlyResource {
/**
- * DNS suffix of the App Service Environment.
+ * List of connection string names.
*/
- dnsSuffix?: string;
+ connectionStringNames?: string[];
/**
- * Maximum number of VMs in the App Service Environment.
+ * List of application settings names.
+ */
+ appSettingNames?: string[];
+ /**
+ * List of external Azure storage account identifiers.
+ */
+ azureStorageConfigNames?: string[];
+}
+
+/**
+ * A setting difference between two deployment slots of an app.
+ */
+export interface SlotDifference extends ProxyOnlyResource {
+ /**
+ * Level of the difference: Information, Warning or Error.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly maximumNumberOfMachines?: number;
+ readonly level?: string;
/**
- * Scale factor for front-ends.
+ * The type of the setting: General, AppSetting or ConnectionString.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- frontEndScaleFactor?: number;
+ readonly settingType?: string;
/**
- * true if the App Service Environment is suspended; otherwise, false.
- * The environment can be suspended, e.g. when the management endpoint is no longer available
- * (most likely because NSG blocked the incoming traffic).
+ * Rule that describes how to process the setting difference during a slot swap.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly suspended?: boolean;
+ readonly diffRule?: string;
/**
- * Custom settings for changing the behavior of the App Service Environment.
+ * Name of the setting.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- clusterSettings?: NameValuePair[];
+ readonly settingName?: string;
/**
- * User added ip ranges to whitelist on ASE db
+ * Value of the setting in the current slot.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- userWhitelistedIpRanges?: string[];
+ readonly valueInCurrentSlot?: string;
/**
- * Flag that displays whether an ASE has linux workers or not
+ * Value of the setting in the target slot.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly hasLinuxWorkers?: boolean;
+ readonly valueInTargetSlot?: string;
/**
- * Dedicated Host Count
+ * Description of the setting difference.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly dedicatedHostCount?: number;
+ readonly description?: string;
}
/**
- * Full view of networking configuration for an ASE.
+ * Specifies the web app that snapshot contents will be retrieved from.
*/
-export interface AseV3NetworkingConfiguration extends ProxyOnlyResource {
- /**
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
- */
- readonly windowsOutboundIpAddresses?: string[];
+export interface SnapshotRecoverySource {
/**
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS
*/
- readonly linuxOutboundIpAddresses?: string[];
+ location?: string;
/**
- * Property to enable and disable new private endpoint connection creation on ASE
+ * ARM resource ID of the source app.
+ * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}
+ * for production slots and
+ * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName}
+ * for other slots.
*/
- allowNewPrivateEndpointConnections?: boolean;
+ id?: string;
}
/**
- * Current TCP connectivity information from the App Service Environment to a single endpoint.
+ * Details about app recovery operation.
*/
-export interface EndpointDetail {
+export interface SnapshotRestoreRequest extends ProxyOnlyResource {
/**
- * An IP Address that Domain Name currently resolves to.
+ * Point in time in which the app restore should be done, formatted as a DateTime string.
*/
- ipAddress?: string;
+ snapshotTime?: string;
/**
- * The port an endpoint is connected to.
+ * Optional. Specifies the web app that snapshot contents will be retrieved from.
+ * If empty, the targeted web app will be used as the source.
*/
- port?: number;
+ recoverySource?: SnapshotRecoverySource;
/**
- * The time in milliseconds it takes for a TCP connection to be created from the App Service
- * Environment to this IpAddress at this Port.
+ * If true the restore operation can overwrite source app; otherwise,
+ * false.
*/
- latency?: number;
+ overwrite: boolean;
+ /**
+ * If true, site configuration, in addition to content, will be reverted.
+ */
+ recoverConfiguration?: boolean;
+ /**
+ * If true, custom hostname conflicts will be ignored when recovering to a target web app.
+ * This setting is only necessary when RecoverConfiguration is enabled.
+ */
+ ignoreConflictingHostNames?: boolean;
/**
- * Whether it is possible to create a TCP connection from the App Service Environment to this
- * IpAddress at this Port.
+ * If true, the snapshot is retrieved from DRSecondary endpoint.
*/
- isAccessible?: boolean;
+ useDRSecondary?: boolean;
}
/**
- * A domain name that a service is reached at, including details of the current connection status.
+ * Options for app content migration.
*/
-export interface EndpointDependency {
+export interface StorageMigrationOptions extends ProxyOnlyResource {
/**
- * The domain name of the dependency.
+ * AzureFiles connection string.
*/
- domainName?: string;
+ azurefilesConnectionString: string;
/**
- * The IP Addresses and Ports used when connecting to DomainName.
+ * AzureFiles share.
*/
- endpointDetails?: EndpointDetail[];
-}
-
-/**
- * Diagnostics for an App Service Environment.
- */
-export interface HostingEnvironmentDiagnostics {
+ azurefilesShare: string;
/**
- * Name/identifier of the diagnostics.
+ * trueif the app should be switched over; otherwise, false. Default
+ * value: false.
*/
- name?: string;
+ switchSiteAfterMigration?: boolean;
/**
- * Diagnostics output.
+ * true if the app should be read only during copy operation; otherwise,
+ * false. Default value: false.
*/
- diagnosticsOutput?: string;
+ blockWriteAccessToSite?: boolean;
}
/**
- * The IP Addresses and Ports that require inbound network access to and within the subnet of the
- * App Service Environment.
+ * Response for a migration of app content request.
*/
-export interface InboundEnvironmentEndpoint {
- /**
- * Short text describing the purpose of the network traffic.
- */
- description?: string;
- /**
- * The IP addresses that network traffic will originate from in cidr notation.
- */
- endpoints?: string[];
+export interface StorageMigrationResponse extends ProxyOnlyResource {
/**
- * The ports that network traffic will arrive to the App Service Environment at.
+ * When server starts the migration process, it will return an operation ID identifying that
+ * particular migration operation.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- ports?: string[];
+ readonly operationId?: string;
}
/**
- * Endpoints accessed for a common purpose that the App Service Environment requires outbound
- * network access to.
+ * Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual
+ * network integration.
*/
-export interface OutboundEnvironmentEndpoint {
+export interface SwiftVirtualNetwork extends ProxyOnlyResource {
/**
- * The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL
- * Database, and Azure Active Directory.
+ * 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.
*/
- category?: string;
+ subnetResourceId?: string;
/**
- * The endpoints that the App Service Environment reaches the service at.
+ * A flag that specifies if the scale unit this Web App is on supports Swift integration.
*/
- endpoints?: EndpointDependency[];
+ swiftSupported?: boolean;
}
/**
- * Metrics availability and retention.
+ * Triggered Web Job Run Information.
*/
-export interface ResourceMetricAvailability {
+export interface TriggeredJobRun extends ProxyOnlyResource {
/**
- * Time grain .
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Job ID.
*/
- readonly timeGrain?: string;
+ webJobId?: string;
/**
- * Retention period for the current time grain.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Job name.
*/
- readonly retention?: string;
-}
-
-/**
- * Metadata for the metrics.
- */
-export interface ResourceMetricDefinition extends ProxyOnlyResource {
+ webJobName?: string;
/**
- * Unit of the metric.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Job status. Possible values include: 'Success', 'Failed', 'Error'
*/
- readonly unit?: string;
+ status?: TriggeredWebJobStatus;
/**
- * Primary aggregation type.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Start time.
*/
- readonly primaryAggregationType?: string;
+ startTime?: Date;
/**
- * List of time grains supported for the metric together with retention period.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * End time.
*/
- readonly metricAvailabilities?: ResourceMetricAvailability[];
+ endTime?: Date;
/**
- * Resource URI.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Job duration.
*/
- readonly resourceUri?: string;
+ duration?: string;
/**
- * Resource metric definition properties.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Output URL.
*/
- readonly properties?: { [propertyName: string]: string };
-}
-
-/**
- * SKU discovery information.
- */
-export interface SkuInfo {
+ outputUrl?: string;
/**
- * Resource type that this SKU applies to.
+ * Error URL.
*/
- resourceType?: string;
+ errorUrl?: string;
/**
- * Name and tier of the SKU.
+ * Job URL.
*/
- sku?: SkuDescription;
+ url?: string;
/**
- * Min, max, and default scale values of the SKU.
+ * Job name.
*/
- capacity?: SkuCapacity;
+ jobName?: string;
+ /**
+ * Job trigger.
+ */
+ trigger?: string;
}
/**
- * Stamp capacity information.
+ * Triggered Web Job History. List of Triggered Web Job Run Information elements.
*/
-export interface StampCapacity {
+export interface TriggeredJobHistory extends ProxyOnlyResource {
/**
- * Name of the stamp.
+ * List of triggered web job runs.
*/
- name?: string;
+ runs?: TriggeredJobRun[];
+}
+
+/**
+ * Triggered Web Job Information.
+ */
+export interface TriggeredWebJob extends ProxyOnlyResource {
/**
- * Available capacity (# of machines, bytes of storage etc...).
+ * Latest job run information.
*/
- availableCapacity?: number;
+ latestRun?: TriggeredJobRun;
/**
- * Total capacity (# of machines, bytes of storage etc...).
+ * History URL.
*/
- totalCapacity?: number;
+ historyUrl?: string;
/**
- * Name of the unit.
+ * Scheduler Logs URL.
*/
- unit?: string;
+ schedulerLogsUrl?: string;
/**
- * Shared/dedicated workers. Possible values include: 'Shared', 'Dedicated', 'Dynamic'
+ * Run command.
*/
- computeMode?: ComputeModeOptions;
+ runCommand?: string;
/**
- * Size of the machines. Possible values include: 'Small', 'Medium', 'Large', 'D1', 'D2', 'D3',
- * 'SmallV3', 'MediumV3', 'LargeV3', 'NestedSmall', 'NestedSmallLinux', 'Default'
+ * Job URL.
*/
- workerSize?: WorkerSizeOptions;
+ url?: string;
/**
- * Size ID of machines:
- * 0 - Small
- * 1 - Medium
- * 2 - Large
+ * Extra Info URL.
*/
- workerSizeId?: number;
+ extraInfoUrl?: string;
/**
- * If true, it includes basic apps.
- * Basic apps are not used for capacity allocation.
+ * Job type. Possible values include: 'Continuous', 'Triggered'
*/
- excludeFromCapacityAllocation?: boolean;
+ webJobType?: WebJobType;
/**
- * true if capacity is applicable for all apps; otherwise, false.
+ * Error information.
*/
- isApplicableForAllComputeModes?: boolean;
+ error?: string;
/**
- * Shared or Dedicated.
+ * Using SDK?
*/
- siteMode?: string;
+ usingSdk?: boolean;
/**
- * Is this a linux stamp capacity
+ * Job settings.
*/
- isLinux?: boolean;
+ settings?: { [propertyName: string]: any };
}
/**
- * Usage of the quota resource.
+ * An interface representing WebSiteInstanceStatus.
*/
-export interface Usage extends ProxyOnlyResource {
+export interface WebSiteInstanceStatus extends ProxyOnlyResource {
/**
- * Friendly name shown in the UI.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Possible values include: 'READY', 'STOPPED', 'UNKNOWN'
*/
- readonly displayName?: string;
+ state?: SiteRuntimeState;
/**
- * Name of the quota resource.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Link to the GetStatusApi in Kudu
*/
- readonly resourceName?: string;
+ statusUrl?: string;
/**
- * Units of measurement for the quota resource.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Link to the Diagnose and Solve Portal
*/
- readonly unit?: string;
+ detectorUrl?: string;
/**
- * The current value of the resource counter.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Link to the console to web app instance
*/
- readonly currentValue?: number;
+ consoleUrl?: string;
/**
- * The resource limit.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Link to the console to web app instance
*/
- readonly limit?: number;
+ healthCheckUrl?: string;
+ containers?: { [propertyName: string]: ContainerInfo };
+}
+
+/**
+ * Web Job Information.
+ */
+export interface WebJob extends ProxyOnlyResource {
/**
- * Next reset time for the resource counter.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Run command.
*/
- readonly nextResetTime?: Date;
+ runCommand?: string;
/**
- * Compute mode used for this usage. Possible values include: 'Shared', 'Dedicated', 'Dynamic'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Job URL.
*/
- readonly computeMode?: ComputeModeOptions;
+ url?: string;
/**
- * Site mode used for this usage.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Extra Info URL.
*/
- readonly siteMode?: string;
-}
-
-/**
- * Worker pool of an App Service Environment ARM resource.
- */
-export interface WorkerPoolResource extends ProxyOnlyResource {
+ extraInfoUrl?: string;
/**
- * Worker size ID for referencing this worker pool.
+ * Job type. Possible values include: 'Continuous', 'Triggered'
*/
- workerSizeId?: number;
+ webJobType?: WebJobType;
/**
- * Shared or dedicated app hosting. Possible values include: 'Shared', 'Dedicated', 'Dynamic'
+ * Error information.
*/
- computeMode?: ComputeModeOptions;
+ error?: string;
/**
- * VM size of the worker pool instances.
+ * Using SDK?
*/
- workerSize?: string;
+ usingSdk?: boolean;
/**
- * Number of instances in the worker pool.
+ * Job settings.
*/
- workerCount?: number;
+ settings?: { [propertyName: string]: any };
+}
+
+/**
+ * An interface representing LogAnalyticsConfiguration.
+ */
+export interface LogAnalyticsConfiguration {
+ customerId?: string;
+ sharedKey?: string;
+}
+
+/**
+ * An interface representing AppLogsConfiguration.
+ */
+export interface AppLogsConfiguration {
+ destination?: string;
+ logAnalyticsConfiguration?: LogAnalyticsConfiguration;
+}
+
+/**
+ * An interface representing FrontEndConfiguration.
+ */
+export interface FrontEndConfiguration {
/**
- * Names of all instances in the worker pool (read only).
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Possible values include: 'NodePort', 'LoadBalancer'
*/
- readonly instanceNames?: string[];
- sku?: SkuDescription;
+ kind?: FrontEndServiceType;
}
/**
- * ARM resource for a app service plan.
+ * An interface representing ArcConfiguration.
*/
-export interface AppServicePlanPatchResource extends ProxyOnlyResource {
+export interface ArcConfiguration {
/**
- * Target worker tier assigned to the App Service plan.
+ * Possible values include: 'LocalNode', 'NetworkFileSystem'
*/
- workerTierName?: string;
+ artifactsStorageType?: StorageType;
+ artifactStorageClassName?: string;
+ artifactStorageMountPath?: string;
+ artifactStorageNodeName?: string;
+ artifactStorageAccessMode?: string;
+ frontEndServiceConfiguration?: FrontEndConfiguration;
+ kubeConfig?: string;
+}
+
+/**
+ * A Kubernetes cluster specialized for web workloads by Azure App Service
+ */
+export interface KubeEnvironment extends Resource {
/**
- * App Service plan status. Possible values include: 'Ready', 'Pending', 'Creating'
+ * Provisioning state of the Kubernetes Environment. Possible values include: 'Succeeded',
+ * 'Failed', 'Canceled', 'Waiting', 'InitializationInProgress', 'InfrastructureSetupInProgress',
+ * 'InfrastructureSetupComplete', 'ScheduledForDelete', 'UpgradeRequested', 'UpgradeFailed'
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly status?: StatusOptions;
+ readonly provisioningState?: KubeEnvironmentProvisioningState;
/**
- * App Service plan subscription.
+ * Any errors that occurred during deployment or deployment validation
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly subscription?: string;
+ readonly deploymentErrors?: string;
/**
- * Specification for the App Service Environment to use for the App Service plan.
+ * Only visible within Vnet/Subnet
*/
- hostingEnvironmentProfile?: HostingEnvironmentProfile;
+ internalLoadBalancerEnabled?: boolean;
/**
- * Maximum number of instances that can be assigned to this App Service plan.
+ * Default Domain Name for the cluster
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly maximumNumberOfWorkers?: number;
+ readonly defaultDomain?: string;
/**
- * Geographical location for the App Service plan.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Static IP of the KubeEnvironment
*/
- readonly geoRegion?: string;
+ staticIp?: string;
/**
- * If true, apps assigned to this App Service plan can be scaled independently.
- * If false, apps assigned to this App Service plan will scale to all instances of
- * the plan. Default value: false.
+ * Cluster configuration which determines the ARC cluster
+ * components types. Eg: Choosing between BuildService kind,
+ * FrontEnd Service ArtifactsStorageType etc.
*/
- perSiteScaling?: boolean;
+ arcConfiguration?: ArcConfiguration;
/**
- * Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
+ * Cluster configuration which enables the log daemon to export
+ * app logs to a destination. Currently only "log-analytics" is
+ * supported
*/
- maximumElasticWorkerCount?: number;
+ appLogsConfiguration?: AppLogsConfiguration;
+ aksResourceID?: string;
+ extendedLocation?: ExtendedLocation;
+}
+
+/**
+ * ARM resource for a KubeEnvironment when patching
+ */
+export interface KubeEnvironmentPatchResource extends ProxyOnlyResource {
/**
- * Number of apps assigned to this App Service plan.
+ * Provisioning state of the Kubernetes Environment. Possible values include: 'Succeeded',
+ * 'Failed', 'Canceled', 'Waiting', 'InitializationInProgress', 'InfrastructureSetupInProgress',
+ * 'InfrastructureSetupComplete', 'ScheduledForDelete', 'UpgradeRequested', 'UpgradeFailed'
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- readonly numberOfSites?: number;
+ readonly provisioningState?: KubeEnvironmentProvisioningState;
/**
- * If true, this App Service Plan owns spot instances.
+ * Any errors that occurred during deployment or deployment validation
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- isSpot?: boolean;
+ readonly deploymentErrors?: string;
/**
- * The time when the server farm expires. Valid only if it is a spot server farm.
+ * Only visible within Vnet/Subnet
*/
- spotExpirationTime?: Date;
+ internalLoadBalancerEnabled?: boolean;
/**
- * The time when the server farm free offer expires.
+ * Default Domain Name for the cluster
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
- freeOfferExpirationTime?: Date;
+ readonly defaultDomain?: string;
/**
- * Resource group of the App Service plan.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Static IP of the KubeEnvironment
*/
- readonly resourceGroup?: string;
+ staticIp?: string;
/**
- * If Linux app service plan true, false otherwise. Default value:
- * false.
+ * Cluster configuration which determines the ARC cluster
+ * components types. Eg: Choosing between BuildService kind,
+ * FrontEnd Service ArtifactsStorageType etc.
*/
- reserved?: boolean;
+ arcConfiguration?: ArcConfiguration;
/**
- * Obsolete: If Hyper-V container app service plan true, false
- * otherwise. Default value: false.
+ * Cluster configuration which enables the log daemon to export
+ * app logs to a destination. Currently only "log-analytics" is
+ * supported
*/
- isXenon?: boolean;
+ appLogsConfiguration?: AppLogsConfiguration;
+ aksResourceID?: string;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface AppServiceCertificateOrdersResendRequestEmailsOptionalParams extends msRest.RequestOptionsBase {
/**
- * If Hyper-V container app service plan true, false otherwise. Default
- * value: false.
+ * Name of the object.
*/
- hyperV?: boolean;
+ name?: string;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface CertificateOrdersDiagnosticsGetAppServiceCertificateOrderDetectorResponseOptionalParams extends msRest.RequestOptionsBase {
/**
- * Scaling worker count.
+ * The start time for detector response.
*/
- targetWorkerCount?: number;
+ startTime?: Date;
/**
- * Scaling worker size ID.
+ * The end time for the detector response.
*/
- targetWorkerSizeId?: number;
+ endTime?: Date;
/**
- * Provisioning state of the App Service Plan. Possible values include: 'Succeeded', 'Failed',
- * 'Canceled', 'InProgress', 'Deleting'
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * The time grain for the detector response.
*/
- readonly provisioningState?: ProvisioningState;
+ timeGrain?: string;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface DomainsCheckAvailabilityOptionalParams extends msRest.RequestOptionsBase {
/**
- * Specification for the Kubernetes Environment to use for the App Service plan.
+ * Name of the object.
*/
- kubeEnvironmentProfile?: KubeEnvironmentProfile;
+ name?: string;
}
/**
- * Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.
+ * Optional Parameters.
*/
-export interface HybridConnectionKey extends ProxyOnlyResource {
+export interface DomainsDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
/**
- * The name of the send key.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Specify true to delete the domain immediately. The default is false
+ * which deletes the domain after 24 hours.
*/
- readonly sendKeyName?: string;
+ forceHardDeleteDomain?: boolean;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface AppServiceEnvironmentsDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
/**
- * The value of the send key.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Specify true to force the deletion even if the App Service Environment contains
+ * resources. The default is false.
*/
- readonly sendKeyValue?: string;
+ forceDelete?: boolean;
}
/**
- * Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.
+ * Optional Parameters.
*/
-export interface HybridConnectionLimits extends ProxyOnlyResource {
+export interface AppServiceEnvironmentsListWebAppsOptionalParams extends msRest.RequestOptionsBase {
/**
- * The current number of Hybrid Connections.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Comma separated list of app properties to include.
*/
- readonly current?: number;
+ propertiesToInclude?: string;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface AppServiceEnvironmentsListUsagesOptionalParams extends msRest.RequestOptionsBase {
/**
- * The maximum number of Hybrid Connections allowed.
- * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ * Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
+ * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq
+ * 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq
+ * duration'[Hour|Minute|Day]'.
*/
- readonly maximum?: number;
+ filter?: string;
}
/**
- * Used for getting ResourceHealthCheck settings.
+ * Optional Parameters.
*/
-export interface ResourceHealthMetadata extends ProxyOnlyResource {
+export interface AppServiceEnvironmentsBeginDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
/**
- * The category that the resource matches in the RHC Policy File
+ * Specify true to force the deletion even if the App Service Environment contains
+ * resources. The default is false.
*/
- category?: string;
+ forceDelete?: boolean;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface AppServiceEnvironmentsListWebAppsNextOptionalParams extends msRest.RequestOptionsBase {
/**
- * Is there a health signal for the resource
+ * Comma separated list of app properties to include.
*/
- signalAvailability?: boolean;
+ propertiesToInclude?: string;
}
/**
* Optional Parameters.
*/
-export interface AppServiceCertificateOrdersResendRequestEmailsOptionalParams
- extends msRest.RequestOptionsBase {
+export interface AppServiceEnvironmentsListUsagesNextOptionalParams extends msRest.RequestOptionsBase {
/**
- * Name of the object.
+ * Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
+ * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq
+ * 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq
+ * duration'[Hour|Minute|Day]'.
*/
- name?: string;
+ filter?: string;
}
/**
* Optional Parameters.
*/
-export interface CertificateOrdersDiagnosticsGetAppServiceCertificateOrderDetectorResponseOptionalParams
- extends msRest.RequestOptionsBase {
+export interface AppServicePlansListOptionalParams extends msRest.RequestOptionsBase {
/**
- * The start time for detector response.
+ * Specify true to return all App Service plan properties. The default is
+ * false, which returns a subset of the properties.
+ * Retrieval of all properties may increase the API latency.
*/
- startTime?: Date;
+ detailed?: boolean;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface AppServicePlansRestartWebAppsOptionalParams extends msRest.RequestOptionsBase {
/**
- * The end time for the detector response.
+ * Specify true to perform a soft restart, applies the configuration settings and
+ * restarts the apps if necessary. The default is false, which always restarts and
+ * reprovisions the apps
*/
- endTime?: Date;
+ softRestart?: boolean;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface AppServicePlansListWebAppsOptionalParams extends msRest.RequestOptionsBase {
/**
- * The time grain for the detector response.
+ * Skip to a web app in the list of webapps associated with app service plan. If specified, the
+ * resulting list will contain web apps starting from (including) the skipToken. Otherwise, the
+ * resulting list contains web apps from the start of the list
*/
- timeGrain?: string;
+ skipToken?: string;
+ /**
+ * Supported filter: $filter=state eq running. Returns only web apps that are currently running
+ */
+ filter?: string;
+ /**
+ * List page size. If specified, results are paged.
+ */
+ top?: string;
}
/**
* Optional Parameters.
*/
-export interface DomainsCheckAvailabilityOptionalParams extends msRest.RequestOptionsBase {
+export interface AppServicePlansListUsagesOptionalParams extends msRest.RequestOptionsBase {
+ /**
+ * Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
+ * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2').
+ */
+ filter?: string;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface AppServicePlansListNextOptionalParams extends msRest.RequestOptionsBase {
+ /**
+ * Specify true to return all App Service plan properties. The default is
+ * false, which returns a subset of the properties.
+ * Retrieval of all properties may increase the API latency.
+ */
+ detailed?: boolean;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface AppServicePlansListWebAppsNextOptionalParams extends msRest.RequestOptionsBase {
+ /**
+ * Skip to a web app in the list of webapps associated with app service plan. If specified, the
+ * resulting list will contain web apps starting from (including) the skipToken. Otherwise, the
+ * resulting list contains web apps from the start of the list
+ */
+ skipToken?: string;
+ /**
+ * Supported filter: $filter=state eq running. Returns only web apps that are currently running
+ */
+ filter?: string;
/**
- * Name of the object.
+ * List page size. If specified, results are paged.
*/
- name?: string;
+ top?: string;
}
/**
* Optional Parameters.
*/
-export interface DomainsDeleteMethodOptionalParams extends msRest.RequestOptionsBase {
+export interface AppServicePlansListUsagesNextOptionalParams extends msRest.RequestOptionsBase {
/**
- * Specify true to delete the domain immediately. The default is false
- * which deletes the domain after 24 hours.
+ * Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
+ * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2').
*/
- forceHardDeleteDomain?: boolean;
+ filter?: string;
}
/**
@@ -9936,8 +10268,7 @@ export interface CertificatesListNextOptionalParams extends msRest.RequestOption
/**
* Optional Parameters.
*/
-export interface DiagnosticsGetHostingEnvironmentDetectorResponseOptionalParams
- extends msRest.RequestOptionsBase {
+export interface DiagnosticsGetHostingEnvironmentDetectorResponseOptionalParams extends msRest.RequestOptionsBase {
/**
* Start Time
*/
@@ -9955,8 +10286,7 @@ export interface DiagnosticsGetHostingEnvironmentDetectorResponseOptionalParams
/**
* Optional Parameters.
*/
-export interface DiagnosticsGetSiteDetectorResponseOptionalParams
- extends msRest.RequestOptionsBase {
+export interface DiagnosticsGetSiteDetectorResponseOptionalParams extends msRest.RequestOptionsBase {
/**
* Start Time
*/
@@ -10010,8 +10340,7 @@ export interface DiagnosticsExecuteSiteDetectorOptionalParams extends msRest.Req
/**
* Optional Parameters.
*/
-export interface DiagnosticsGetSiteDetectorResponseSlotOptionalParams
- extends msRest.RequestOptionsBase {
+export interface DiagnosticsGetSiteDetectorResponseSlotOptionalParams extends msRest.RequestOptionsBase {
/**
* Start Time
*/
@@ -10029,8 +10358,7 @@ export interface DiagnosticsGetSiteDetectorResponseSlotOptionalParams
/**
* Optional Parameters.
*/
-export interface DiagnosticsExecuteSiteAnalysisSlotOptionalParams
- extends msRest.RequestOptionsBase {
+export interface DiagnosticsExecuteSiteAnalysisSlotOptionalParams extends msRest.RequestOptionsBase {
/**
* Start Time
*/
@@ -10048,8 +10376,7 @@ export interface DiagnosticsExecuteSiteAnalysisSlotOptionalParams
/**
* Optional Parameters.
*/
-export interface DiagnosticsExecuteSiteDetectorSlotOptionalParams
- extends msRest.RequestOptionsBase {
+export interface DiagnosticsExecuteSiteDetectorSlotOptionalParams extends msRest.RequestOptionsBase {
/**
* Start Time
*/
@@ -10087,8 +10414,7 @@ export interface ProviderGetFunctionAppStacksOptionalParams extends msRest.Reque
/**
* Optional Parameters.
*/
-export interface ProviderGetFunctionAppStacksForLocationOptionalParams
- extends msRest.RequestOptionsBase {
+export interface ProviderGetFunctionAppStacksForLocationOptionalParams extends msRest.RequestOptionsBase {
/**
* Stack OS Type. Possible values include: 'Windows', 'Linux', 'All'
*/
@@ -10098,8 +10424,7 @@ export interface ProviderGetFunctionAppStacksForLocationOptionalParams
/**
* Optional Parameters.
*/
-export interface ProviderGetWebAppStacksForLocationOptionalParams
- extends msRest.RequestOptionsBase {
+export interface ProviderGetWebAppStacksForLocationOptionalParams extends msRest.RequestOptionsBase {
/**
* Stack OS Type. Possible values include: 'Windows', 'Linux', 'All'
*/
@@ -10149,8 +10474,7 @@ export interface ProviderGetFunctionAppStacksNextOptionalParams extends msRest.R
/**
* Optional Parameters.
*/
-export interface ProviderGetFunctionAppStacksForLocationNextOptionalParams
- extends msRest.RequestOptionsBase {
+export interface ProviderGetFunctionAppStacksForLocationNextOptionalParams extends msRest.RequestOptionsBase {
/**
* Stack OS Type. Possible values include: 'Windows', 'Linux', 'All'
*/
@@ -10160,8 +10484,7 @@ export interface ProviderGetFunctionAppStacksForLocationNextOptionalParams
/**
* Optional Parameters.
*/
-export interface ProviderGetWebAppStacksForLocationNextOptionalParams
- extends msRest.RequestOptionsBase {
+export interface ProviderGetWebAppStacksForLocationNextOptionalParams extends msRest.RequestOptionsBase {
/**
* Stack OS Type. Possible values include: 'Windows', 'Linux', 'All'
*/
@@ -10181,8 +10504,7 @@ export interface ProviderGetWebAppStacksNextOptionalParams extends msRest.Reques
/**
* Optional Parameters.
*/
-export interface ProviderGetAvailableStacksOnPremNextOptionalParams
- extends msRest.RequestOptionsBase {
+export interface ProviderGetAvailableStacksOnPremNextOptionalParams extends msRest.RequestOptionsBase {
/**
* Possible values include: 'Windows', 'Linux', 'WindowsFunctions', 'LinuxFunctions', 'All'
*/
@@ -10209,8 +10531,7 @@ export interface RecommendationsListOptionalParams extends msRest.RequestOptions
/**
* Optional Parameters.
*/
-export interface RecommendationsListHistoryForHostingEnvironmentOptionalParams
- extends msRest.RequestOptionsBase {
+export interface RecommendationsListHistoryForHostingEnvironmentOptionalParams extends msRest.RequestOptionsBase {
/**
* Specify false to return all recommendations. The default is true,
* which returns only expired recommendations.
@@ -10227,8 +10548,7 @@ export interface RecommendationsListHistoryForHostingEnvironmentOptionalParams
/**
* Optional Parameters.
*/
-export interface RecommendationsListRecommendedRulesForHostingEnvironmentOptionalParams
- extends msRest.RequestOptionsBase {
+export interface RecommendationsListRecommendedRulesForHostingEnvironmentOptionalParams extends msRest.RequestOptionsBase {
/**
* Specify true to return only the most critical recommendations. The default is
* false, which returns all recommendations.
@@ -10244,8 +10564,7 @@ export interface RecommendationsListRecommendedRulesForHostingEnvironmentOptiona
/**
* Optional Parameters.
*/
-export interface RecommendationsGetRuleDetailsByHostingEnvironmentOptionalParams
- extends msRest.RequestOptionsBase {
+export interface RecommendationsGetRuleDetailsByHostingEnvironmentOptionalParams extends msRest.RequestOptionsBase {
/**
* Specify true to update the last-seen timestamp of the recommendation object.
*/
@@ -10260,8 +10579,7 @@ export interface RecommendationsGetRuleDetailsByHostingEnvironmentOptionalParams
/**
* Optional Parameters.
*/
-export interface RecommendationsListHistoryForWebAppOptionalParams
- extends msRest.RequestOptionsBase {
+export interface RecommendationsListHistoryForWebAppOptionalParams extends msRest.RequestOptionsBase {
/**
* Specify false to return all recommendations. The default is true,
* which returns only expired recommendations.
@@ -10278,8 +10596,7 @@ export interface RecommendationsListHistoryForWebAppOptionalParams
/**
* Optional Parameters.
*/
-export interface RecommendationsListRecommendedRulesForWebAppOptionalParams
- extends msRest.RequestOptionsBase {
+export interface RecommendationsListRecommendedRulesForWebAppOptionalParams extends msRest.RequestOptionsBase {
/**
* Specify true to return only the most critical recommendations. The default is
* false, which returns all recommendations.
@@ -10295,8 +10612,7 @@ export interface RecommendationsListRecommendedRulesForWebAppOptionalParams
/**
* Optional Parameters.
*/
-export interface RecommendationsGetRuleDetailsByWebAppOptionalParams
- extends msRest.RequestOptionsBase {
+export interface RecommendationsGetRuleDetailsByWebAppOptionalParams extends msRest.RequestOptionsBase {
/**
* Specify true to update the last-seen timestamp of the recommendation object.
*/
@@ -10328,8 +10644,7 @@ export interface RecommendationsListNextOptionalParams extends msRest.RequestOpt
/**
* Optional Parameters.
*/
-export interface RecommendationsListHistoryForHostingEnvironmentNextOptionalParams
- extends msRest.RequestOptionsBase {
+export interface RecommendationsListHistoryForHostingEnvironmentNextOptionalParams extends msRest.RequestOptionsBase {
/**
* Specify false to return all recommendations. The default is true,
* which returns only expired recommendations.
@@ -10346,8 +10661,7 @@ export interface RecommendationsListHistoryForHostingEnvironmentNextOptionalPara
/**
* Optional Parameters.
*/
-export interface RecommendationsListRecommendedRulesForHostingEnvironmentNextOptionalParams
- extends msRest.RequestOptionsBase {
+export interface RecommendationsListRecommendedRulesForHostingEnvironmentNextOptionalParams extends msRest.RequestOptionsBase {
/**
* Specify true to return only the most critical recommendations. The default is
* false, which returns all recommendations.
@@ -10363,8 +10677,7 @@ export interface RecommendationsListRecommendedRulesForHostingEnvironmentNextOpt
/**
* Optional Parameters.
*/
-export interface RecommendationsListHistoryForWebAppNextOptionalParams
- extends msRest.RequestOptionsBase {
+export interface RecommendationsListHistoryForWebAppNextOptionalParams extends msRest.RequestOptionsBase {
/**
* Specify false to return all recommendations. The default is true,
* which returns only expired recommendations.
@@ -10381,8 +10694,7 @@ export interface RecommendationsListHistoryForWebAppNextOptionalParams
/**
* Optional Parameters.
*/
-export interface RecommendationsListRecommendedRulesForWebAppNextOptionalParams
- extends msRest.RequestOptionsBase {
+export interface RecommendationsListRecommendedRulesForWebAppNextOptionalParams extends msRest.RequestOptionsBase {
/**
* Specify true to return only the most critical recommendations. The default is
* false, which returns all recommendations.
@@ -10398,8 +10710,7 @@ export interface RecommendationsListRecommendedRulesForWebAppNextOptionalParams
/**
* Optional Parameters.
*/
-export interface WebSiteManagementClientListBillingMetersOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebSiteManagementClientListBillingMetersOptionalParams extends msRest.RequestOptionsBase {
/**
* Azure Location of billable resource
*/
@@ -10413,8 +10724,7 @@ export interface WebSiteManagementClientListBillingMetersOptionalParams
/**
* Optional Parameters.
*/
-export interface WebSiteManagementClientCheckNameAvailabilityOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebSiteManagementClientCheckNameAvailabilityOptionalParams extends msRest.RequestOptionsBase {
/**
* Is fully qualified domain name.
*/
@@ -10424,8 +10734,7 @@ export interface WebSiteManagementClientCheckNameAvailabilityOptionalParams
/**
* Optional Parameters.
*/
-export interface WebSiteManagementClientListGeoRegionsOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebSiteManagementClientListGeoRegionsOptionalParams extends msRest.RequestOptionsBase {
/**
* Name of SKU used to filter the regions. Possible values include: 'Free', 'Shared', 'Basic',
* 'Standard', 'Premium', 'Dynamic', 'Isolated', 'IsolatedV2', 'PremiumV2', 'PremiumV3',
@@ -10450,8 +10759,7 @@ export interface WebSiteManagementClientListGeoRegionsOptionalParams
/**
* Optional Parameters.
*/
-export interface WebSiteManagementClientListSiteIdentifiersAssignedToHostNameOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebSiteManagementClientListSiteIdentifiersAssignedToHostNameOptionalParams extends msRest.RequestOptionsBase {
/**
* Name of the object.
*/
@@ -10461,8 +10769,7 @@ export interface WebSiteManagementClientListSiteIdentifiersAssignedToHostNameOpt
/**
* Optional Parameters.
*/
-export interface WebSiteManagementClientListBillingMetersNextOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebSiteManagementClientListBillingMetersNextOptionalParams extends msRest.RequestOptionsBase {
/**
* Azure Location of billable resource
*/
@@ -10476,8 +10783,7 @@ export interface WebSiteManagementClientListBillingMetersNextOptionalParams
/**
* Optional Parameters.
*/
-export interface WebSiteManagementClientListGeoRegionsNextOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebSiteManagementClientListGeoRegionsNextOptionalParams extends msRest.RequestOptionsBase {
/**
* Name of SKU used to filter the regions. Possible values include: 'Free', 'Shared', 'Basic',
* 'Standard', 'Premium', 'Dynamic', 'Isolated', 'IsolatedV2', 'PremiumV2', 'PremiumV3',
@@ -10499,6 +10805,54 @@ export interface WebSiteManagementClientListGeoRegionsNextOptionalParams
linuxDynamicWorkersEnabled?: boolean;
}
+/**
+ * Optional Parameters.
+ */
+export interface StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteBuildOptionalParams extends msRest.RequestOptionsBase {
+ /**
+ * Specify true to force the update of the auth configuration on the function app
+ * even if an AzureStaticWebApps provider is already configured on the function app. The default
+ * is false.
+ */
+ isForced?: boolean;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteOptionalParams extends msRest.RequestOptionsBase {
+ /**
+ * Specify true to force the update of the auth configuration on the function app
+ * even if an AzureStaticWebApps provider is already configured on the function app. The default
+ * is false.
+ */
+ isForced?: boolean;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface StaticSitesBeginRegisterUserProvidedFunctionAppWithStaticSiteBuildOptionalParams extends msRest.RequestOptionsBase {
+ /**
+ * Specify true to force the update of the auth configuration on the function app
+ * even if an AzureStaticWebApps provider is already configured on the function app. The default
+ * is false.
+ */
+ isForced?: boolean;
+}
+
+/**
+ * Optional Parameters.
+ */
+export interface StaticSitesBeginRegisterUserProvidedFunctionAppWithStaticSiteOptionalParams extends msRest.RequestOptionsBase {
+ /**
+ * Specify true to force the update of the auth configuration on the function app
+ * even if an AzureStaticWebApps provider is already configured on the function app. The default
+ * is false.
+ */
+ isForced?: boolean;
+}
+
/**
* Optional Parameters.
*/
@@ -10556,8 +10910,7 @@ export interface WebAppsStartWebSiteNetworkTraceOptionalParams extends msRest.Re
/**
* Optional Parameters.
*/
-export interface WebAppsStartWebSiteNetworkTraceOperationOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebAppsStartWebSiteNetworkTraceOperationOptionalParams extends msRest.RequestOptionsBase {
/**
* The duration to keep capturing in seconds.
*/
@@ -10628,8 +10981,7 @@ export interface WebAppsAnalyzeCustomHostnameSlotOptionalParams extends msRest.R
/**
* Optional Parameters.
*/
-export interface WebAppsStartWebSiteNetworkTraceSlotOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebAppsStartWebSiteNetworkTraceSlotOptionalParams extends msRest.RequestOptionsBase {
/**
* The duration to keep capturing in seconds.
*/
@@ -10647,8 +10999,7 @@ export interface WebAppsStartWebSiteNetworkTraceSlotOptionalParams
/**
* Optional Parameters.
*/
-export interface WebAppsStartWebSiteNetworkTraceOperationSlotOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebAppsStartWebSiteNetworkTraceOperationSlotOptionalParams extends msRest.RequestOptionsBase {
/**
* The duration to keep capturing in seconds.
*/
@@ -10770,8 +11121,7 @@ export interface WebAppsListUsagesOptionalParams extends msRest.RequestOptionsBa
/**
* Optional Parameters.
*/
-export interface WebAppsBeginStartWebSiteNetworkTraceOperationOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebAppsBeginStartWebSiteNetworkTraceOperationOptionalParams extends msRest.RequestOptionsBase {
/**
* The duration to keep capturing in seconds.
*/
@@ -10789,8 +11139,7 @@ export interface WebAppsBeginStartWebSiteNetworkTraceOperationOptionalParams
/**
* Optional Parameters.
*/
-export interface WebAppsBeginStartWebSiteNetworkTraceOperationSlotOptionalParams
- extends msRest.RequestOptionsBase {
+export interface WebAppsBeginStartWebSiteNetworkTraceOperationSlotOptionalParams extends msRest.RequestOptionsBase {
/**
* The duration to keep capturing in seconds.
*/
@@ -10814,270 +11163,52 @@ export interface WebAppsBeginStartNetworkTraceSlotOptionalParams extends msRest.
*/
durationInSeconds?: number;
/**
- * The maximum frame length in bytes (Optional).
- */
- maxFrameLength?: number;
- /**
- * The Blob URL to store capture file.
- */
- sasUrl?: string;
-}
-
-/**
- * Optional Parameters.
- */
-export interface WebAppsBeginStartNetworkTraceOptionalParams extends msRest.RequestOptionsBase {
- /**
- * The duration to keep capturing in seconds.
- */
- durationInSeconds?: number;
- /**
- * The maximum frame length in bytes (Optional).
- */
- maxFrameLength?: number;
- /**
- * The Blob URL to store capture file.
- */
- sasUrl?: string;
-}
-
-/**
- * Optional Parameters.
- */
-export interface WebAppsListByResourceGroupNextOptionalParams extends msRest.RequestOptionsBase {
- /**
- * Specify true to include deployment slots in results. The default is false,
- * which only gives you the production slot of all apps.
- */
- includeSlots?: boolean;
-}
-
-/**
- * Optional Parameters.
- */
-export interface WebAppsListPerfMonCountersNextOptionalParams extends msRest.RequestOptionsBase {
- /**
- * Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
- * $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain
- * eq duration'[Hour|Minute|Day]'.
- */
- filter?: string;
-}
-
-/**
- * Optional Parameters.
- */
-export interface WebAppsListPerfMonCountersSlotNextOptionalParams
- extends msRest.RequestOptionsBase {
- /**
- * Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
- * $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain
- * eq duration'[Hour|Minute|Day]'.
- */
- filter?: string;
-}
-
-/**
- * Optional Parameters.
- */
-export interface WebAppsListUsagesSlotNextOptionalParams extends msRest.RequestOptionsBase {
- /**
- * Return only information specified in the filter (using OData syntax). For example:
- * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq
- * 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq
- * duration'[Hour|Minute|Day]'.
- */
- filter?: string;
-}
-
-/**
- * Optional Parameters.
- */
-export interface WebAppsListUsagesNextOptionalParams extends msRest.RequestOptionsBase {
- /**
- * Return only information specified in the filter (using OData syntax). For example:
- * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq
- * 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq
- * duration'[Hour|Minute|Day]'.
- */
- filter?: string;
-}
-
-/**
- * Optional Parameters.
- */
-export interface StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteBuildOptionalParams
- extends msRest.RequestOptionsBase {
- /**
- * Specify true to force the update of the auth configuration on the function app
- * even if an AzureStaticWebApps provider is already configured on the function app. The default
- * is false.
- */
- isForced?: boolean;
-}
-
-/**
- * Optional Parameters.
- */
-export interface StaticSitesRegisterUserProvidedFunctionAppWithStaticSiteOptionalParams
- extends msRest.RequestOptionsBase {
- /**
- * Specify true to force the update of the auth configuration on the function app
- * even if an AzureStaticWebApps provider is already configured on the function app. The default
- * is false.
- */
- isForced?: boolean;
-}
-
-/**
- * Optional Parameters.
- */
-export interface StaticSitesBeginRegisterUserProvidedFunctionAppWithStaticSiteBuildOptionalParams
- extends msRest.RequestOptionsBase {
- /**
- * Specify true to force the update of the auth configuration on the function app
- * even if an AzureStaticWebApps provider is already configured on the function app. The default
- * is false.
- */
- isForced?: boolean;
-}
-
-/**
- * Optional Parameters.
- */
-export interface StaticSitesBeginRegisterUserProvidedFunctionAppWithStaticSiteOptionalParams
- extends msRest.RequestOptionsBase {
- /**
- * Specify true to force the update of the auth configuration on the function app
- * even if an AzureStaticWebApps provider is already configured on the function app. The default
- * is false.
- */
- isForced?: boolean;
-}
-
-/**
- * Optional Parameters.
- */
-export interface AppServiceEnvironmentsDeleteMethodOptionalParams
- extends msRest.RequestOptionsBase {
- /**
- * Specify true to force the deletion even if the App Service Environment contains
- * resources. The default is false.
- */
- forceDelete?: boolean;
-}
-
-/**
- * Optional Parameters.
- */
-export interface AppServiceEnvironmentsListWebAppsOptionalParams extends msRest.RequestOptionsBase {
- /**
- * Comma separated list of app properties to include.
- */
- propertiesToInclude?: string;
-}
-
-/**
- * Optional Parameters.
- */
-export interface AppServiceEnvironmentsListUsagesOptionalParams extends msRest.RequestOptionsBase {
- /**
- * Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
- * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq
- * 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq
- * duration'[Hour|Minute|Day]'.
- */
- filter?: string;
-}
-
-/**
- * Optional Parameters.
- */
-export interface AppServiceEnvironmentsBeginDeleteMethodOptionalParams
- extends msRest.RequestOptionsBase {
- /**
- * Specify true to force the deletion even if the App Service Environment contains
- * resources. The default is false.
- */
- forceDelete?: boolean;
-}
-
-/**
- * Optional Parameters.
- */
-export interface AppServiceEnvironmentsListWebAppsNextOptionalParams
- extends msRest.RequestOptionsBase {
- /**
- * Comma separated list of app properties to include.
- */
- propertiesToInclude?: string;
-}
-
-/**
- * Optional Parameters.
- */
-export interface AppServiceEnvironmentsListUsagesNextOptionalParams
- extends msRest.RequestOptionsBase {
- /**
- * Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
- * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq
- * 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq
- * duration'[Hour|Minute|Day]'.
- */
- filter?: string;
-}
-
-/**
- * Optional Parameters.
- */
-export interface AppServicePlansListOptionalParams extends msRest.RequestOptionsBase {
+ * The maximum frame length in bytes (Optional).
+ */
+ maxFrameLength?: number;
/**
- * Specify true to return all App Service plan properties. The default is
- * false, which returns a subset of the properties.
- * Retrieval of all properties may increase the API latency.
+ * The Blob URL to store capture file.
*/
- detailed?: boolean;
+ sasUrl?: string;
}
/**
* Optional Parameters.
*/
-export interface AppServicePlansRestartWebAppsOptionalParams extends msRest.RequestOptionsBase {
+export interface WebAppsBeginStartNetworkTraceOptionalParams extends msRest.RequestOptionsBase {
/**
- * Specify true to perform a soft restart, applies the configuration settings and
- * restarts the apps if necessary. The default is false, which always restarts and
- * reprovisions the apps
+ * The duration to keep capturing in seconds.
*/
- softRestart?: boolean;
+ durationInSeconds?: number;
+ /**
+ * The maximum frame length in bytes (Optional).
+ */
+ maxFrameLength?: number;
+ /**
+ * The Blob URL to store capture file.
+ */
+ sasUrl?: string;
}
/**
* Optional Parameters.
*/
-export interface AppServicePlansListWebAppsOptionalParams extends msRest.RequestOptionsBase {
- /**
- * Skip to a web app in the list of webapps associated with app service plan. If specified, the
- * resulting list will contain web apps starting from (including) the skipToken. Otherwise, the
- * resulting list contains web apps from the start of the list
- */
- skipToken?: string;
- /**
- * Supported filter: $filter=state eq running. Returns only web apps that are currently running
- */
- filter?: string;
+export interface WebAppsListByResourceGroupNextOptionalParams extends msRest.RequestOptionsBase {
/**
- * List page size. If specified, results are paged.
+ * Specify true to include deployment slots in results. The default is false,
+ * which only gives you the production slot of all apps.
*/
- top?: string;
+ includeSlots?: boolean;
}
/**
* Optional Parameters.
*/
-export interface AppServicePlansListUsagesOptionalParams extends msRest.RequestOptionsBase {
+export interface WebAppsListPerfMonCountersNextOptionalParams extends msRest.RequestOptionsBase {
/**
* Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
- * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2').
+ * $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain
+ * eq duration'[Hour|Minute|Day]'.
*/
filter?: string;
}
@@ -11085,42 +11216,37 @@ export interface AppServicePlansListUsagesOptionalParams extends msRest.RequestO
/**
* Optional Parameters.
*/
-export interface AppServicePlansListNextOptionalParams extends msRest.RequestOptionsBase {
+export interface WebAppsListPerfMonCountersSlotNextOptionalParams extends msRest.RequestOptionsBase {
/**
- * Specify true to return all App Service plan properties. The default is
- * false, which returns a subset of the properties.
- * Retrieval of all properties may increase the API latency.
+ * Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
+ * $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain
+ * eq duration'[Hour|Minute|Day]'.
*/
- detailed?: boolean;
+ filter?: string;
}
/**
* Optional Parameters.
*/
-export interface AppServicePlansListWebAppsNextOptionalParams extends msRest.RequestOptionsBase {
- /**
- * Skip to a web app in the list of webapps associated with app service plan. If specified, the
- * resulting list will contain web apps starting from (including) the skipToken. Otherwise, the
- * resulting list contains web apps from the start of the list
- */
- skipToken?: string;
+export interface WebAppsListUsagesSlotNextOptionalParams extends msRest.RequestOptionsBase {
/**
- * Supported filter: $filter=state eq running. Returns only web apps that are currently running
+ * Return only information specified in the filter (using OData syntax). For example:
+ * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq
+ * 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq
+ * duration'[Hour|Minute|Day]'.
*/
filter?: string;
- /**
- * List page size. If specified, results are paged.
- */
- top?: string;
}
/**
* Optional Parameters.
*/
-export interface AppServicePlansListUsagesNextOptionalParams extends msRest.RequestOptionsBase {
+export interface WebAppsListUsagesNextOptionalParams extends msRest.RequestOptionsBase {
/**
- * Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example:
- * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2').
+ * Return only information specified in the filter (using OData syntax). For example:
+ * $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq
+ * 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq
+ * duration'[Hour|Minute|Day]'.
*/
filter?: string;
}
@@ -11251,10 +11377,10 @@ export interface TldLegalAgreementCollection extends Array {
/**
* @interface
- * Collection of certificates.
- * @extends Array
+ * Collection of App Service Environments.
+ * @extends Array
*/
-export interface CertificateCollection extends Array {
+export interface AppServiceEnvironmentCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11264,10 +11390,10 @@ export interface CertificateCollection extends Array {
/**
* @interface
- * Collection of deleted apps.
- * @extends Array
+ * Collection of stamp capacities.
+ * @extends Array
*/
-export interface DeletedWebAppCollection extends Array {
+export interface StampCapacityCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11277,10 +11403,10 @@ export interface DeletedWebAppCollection extends Array {
/**
* @interface
- * Collection of Diagnostic Categories
- * @extends Array
+ * Collection of App Service apps.
+ * @extends Array
*/
-export interface DiagnosticCategoryCollection extends Array {
+export interface WebAppCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11290,10 +11416,10 @@ export interface DiagnosticCategoryCollection extends Array
/**
* @interface
- * Collection of Diagnostic Analyses
- * @extends Array
+ * Collection of Inbound Environment Endpoints
+ * @extends Array
*/
-export interface DiagnosticAnalysisCollection extends Array {
+export interface InboundEnvironmentEndpointCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11303,10 +11429,10 @@ export interface DiagnosticAnalysisCollection extends Array
/**
* @interface
- * Collection of Diagnostic Detectors
- * @extends Array
+ * Collection of worker pools.
+ * @extends Array
*/
-export interface DiagnosticDetectorCollection extends Array {
+export interface WorkerPoolCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11316,10 +11442,10 @@ export interface DiagnosticDetectorCollection extends Array
/**
* @interface
- * Collection of Application Stacks
- * @extends Array
+ * Collection of metric definitions.
+ * @extends Array
*/
-export interface ApplicationStackCollection extends Array {
+export interface ResourceMetricDefinitionCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11329,10 +11455,10 @@ export interface ApplicationStackCollection extends Array
+ * Collection of SKU information.
+ * @extends Array
*/
-export interface FunctionAppStackCollection extends Array {
+export interface SkuInfoCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11342,10 +11468,10 @@ export interface FunctionAppStackCollection extends Array {
/**
* @interface
- * Collection of Web app Stacks
- * @extends Array
+ * Collection of usages.
+ * @extends Array
*/
-export interface WebAppStackCollection extends Array {
+export interface UsageCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11355,10 +11481,10 @@ export interface WebAppStackCollection extends Array {
/**
* @interface
- * Collection of recommendations.
- * @extends Array
+ * Collection of Outbound Environment Endpoints
+ * @extends Array
*/
-export interface RecommendationCollection extends Array {
+export interface OutboundEnvironmentEndpointCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11368,10 +11494,10 @@ export interface RecommendationCollection extends Array {
/**
* @interface
- * Collection of source controls.
- * @extends Array
+ * An interface representing the PrivateEndpointConnectionCollection.
+ * @extends Array
*/
-export interface SourceControlCollection extends Array {
+export interface PrivateEndpointConnectionCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11381,10 +11507,10 @@ export interface SourceControlCollection extends Array {
/**
* @interface
- * Collection of Billing Meters
- * @extends Array
+ * Collection of App Service plans.
+ * @extends Array
*/
-export interface BillingMeterCollection extends Array {
+export interface AppServicePlanCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11394,10 +11520,10 @@ export interface BillingMeterCollection extends Array {
/**
* @interface
- * Collection of geographical regions.
- * @extends Array
+ * Collection of CSM usage quotas.
+ * @extends Array
*/
-export interface GeoRegionCollection extends Array {
+export interface CsmUsageQuotaCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11407,10 +11533,10 @@ export interface GeoRegionCollection extends Array {
/**
* @interface
- * Collection of identifiers.
- * @extends Array
+ * Collection of resources.
+ * @extends Array
*/
-export interface IdentifierCollection extends Array {
+export interface ResourceCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11420,10 +11546,10 @@ export interface IdentifierCollection extends Array {
/**
* @interface
- * Collection of premier add-on offers.
- * @extends Array
+ * Collection of hostname bindings.
+ * @extends Array
*/
-export interface PremierAddOnOfferCollection extends Array {
+export interface HybridConnectionCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11433,10 +11559,10 @@ export interface PremierAddOnOfferCollection extends Array {
/**
* @interface
- * Collection of App Service apps.
- * @extends Array
+ * Collection of certificates.
+ * @extends Array
*/
-export interface WebAppCollection extends Array {
+export interface CertificateCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11446,10 +11572,10 @@ export interface WebAppCollection extends Array {
/**
* @interface
- * Collection of backup items.
- * @extends Array
+ * Collection of deleted apps.
+ * @extends Array
*/
-export interface BackupItemCollection extends Array {
+export interface DeletedWebAppCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11459,10 +11585,10 @@ export interface BackupItemCollection extends Array {
/**
* @interface
- * Collection of site configurations.
- * @extends Array
+ * Collection of Diagnostic Categories
+ * @extends Array
*/
-export interface SiteConfigResourceCollection extends Array {
+export interface DiagnosticCategoryCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11472,10 +11598,10 @@ export interface SiteConfigResourceCollection extends Array
/**
* @interface
- * An interface representing the ApiKVReferenceCollection.
- * @extends Array
+ * Collection of Diagnostic Analyses
+ * @extends Array
*/
-export interface ApiKVReferenceCollection extends Array {
+export interface DiagnosticAnalysisCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11485,11 +11611,10 @@ export interface ApiKVReferenceCollection extends Array {
/**
* @interface
- * Collection of metadata for the app configuration snapshots that can be restored.
- * @extends Array
+ * Collection of Diagnostic Detectors
+ * @extends Array
*/
-export interface SiteConfigurationSnapshotInfoCollection
- extends Array {
+export interface DiagnosticDetectorCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11499,10 +11624,10 @@ export interface SiteConfigurationSnapshotInfoCollection
/**
* @interface
- * Collection of Kudu continuous web job information elements.
- * @extends Array
+ * Collection of Application Stacks
+ * @extends Array
*/
-export interface ContinuousWebJobCollection extends Array {
+export interface ApplicationStackCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11512,10 +11637,10 @@ export interface ContinuousWebJobCollection extends Array {
/**
* @interface
- * Collection of app deployments.
- * @extends Array
+ * Collection of Function app Stacks
+ * @extends Array
*/
-export interface DeploymentCollection extends Array {
+export interface FunctionAppStackCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11525,10 +11650,10 @@ export interface DeploymentCollection extends Array {
/**
* @interface
- * Collection of Kudu function information elements.
- * @extends Array
+ * Collection of Web app Stacks
+ * @extends Array
*/
-export interface FunctionEnvelopeCollection extends Array {
+export interface WebAppStackCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11538,10 +11663,10 @@ export interface FunctionEnvelopeCollection extends Array {
/**
* @interface
- * Collection of hostname bindings.
- * @extends Array
+ * Collection of recommendations.
+ * @extends Array
*/
-export interface HostNameBindingCollection extends Array {
+export interface RecommendationCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11551,10 +11676,10 @@ export interface HostNameBindingCollection extends Array {
/**
* @interface
- * Collection of app instances.
- * @extends Array
+ * Collection of resource health metadata.
+ * @extends Array
*/
-export interface WebAppInstanceStatusCollection extends Array {
+export interface ResourceHealthMetadataCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11564,10 +11689,10 @@ export interface WebAppInstanceStatusCollection extends Array
+ * Collection of source controls.
+ * @extends Array
*/
-export interface ProcessInfoCollection extends Array {
+export interface SourceControlCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11577,10 +11702,10 @@ export interface ProcessInfoCollection extends Array {
/**
* @interface
- * Collection of Kudu thread information elements.
- * @extends Array
+ * Collection of Billing Meters
+ * @extends Array
*/
-export interface ProcessModuleInfoCollection extends Array {
+export interface BillingMeterCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11590,10 +11715,10 @@ export interface ProcessModuleInfoCollection extends Array {
/**
* @interface
- * Collection of Kudu thread information elements.
- * @extends Array
+ * Collection of geographical regions.
+ * @extends Array
*/
-export interface ProcessThreadInfoCollection extends Array {
+export interface GeoRegionCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11603,10 +11728,23 @@ export interface ProcessThreadInfoCollection extends Array {
/**
* @interface
- * Collection of performance monitor counters.
- * @extends Array
+ * Collection of identifiers.
+ * @extends Array
+ */
+export interface IdentifierCollection extends Array {
+ /**
+ * Link to next page of resources.
+ * **NOTE: This property will not be serialized. It can only be populated by the server.**
+ */
+ readonly nextLink?: string;
+}
+
+/**
+ * @interface
+ * Collection of premier add-on offers.
+ * @extends Array
*/
-export interface PerfMonCounterCollection extends Array {
+export interface PremierAddOnOfferCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11616,11 +11754,10 @@ export interface PerfMonCounterCollection extends Array {
/**
* @interface
- * An interface representing the PrivateEndpointConnectionCollection.
- * @extends Array
+ * Collection of static sites.
+ * @extends Array
*/
-export interface PrivateEndpointConnectionCollection
- extends Array {
+export interface StaticSiteCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11630,10 +11767,10 @@ export interface PrivateEndpointConnectionCollection
/**
* @interface
- * Collection of public certificates
- * @extends Array
+ * Collection of static site custom users.
+ * @extends Array
*/
-export interface PublicCertificateCollection extends Array {
+export interface StaticSiteUserCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11643,10 +11780,10 @@ export interface PublicCertificateCollection extends Array {
/**
* @interface
- * Collection of Kudu site extension information elements.
- * @extends Array
+ * Collection of static site builds.
+ * @extends Array
*/
-export interface SiteExtensionInfoCollection extends Array {
+export interface StaticSiteBuildCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11656,10 +11793,10 @@ export interface SiteExtensionInfoCollection extends Array {
/**
* @interface
- * Collection of slot differences.
- * @extends Array
+ * Collection of static site functions.
+ * @extends Array
*/
-export interface SlotDifferenceCollection extends Array {
+export interface StaticSiteFunctionOverviewCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11669,10 +11806,10 @@ export interface SlotDifferenceCollection extends Array {
/**
* @interface
- * Collection of snapshots which can be used to revert an app to a previous time.
- * @extends Array
+ * Collection of static site user provided function apps.
+ * @extends Array
*/
-export interface SnapshotCollection extends Array {
+export interface StaticSiteUserProvidedFunctionAppsCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11682,10 +11819,10 @@ export interface SnapshotCollection extends Array {
/**
* @interface
- * Collection of Kudu continuous web job information elements.
- * @extends Array
+ * Collection of static site custom domains.
+ * @extends Array
*/
-export interface TriggeredWebJobCollection extends Array {
+export interface StaticSiteCustomDomainOverviewCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11695,10 +11832,10 @@ export interface TriggeredWebJobCollection extends Array {
/**
* @interface
- * Collection of Kudu continuous web job information elements.
- * @extends Array
+ * Collection of backup items.
+ * @extends Array
*/
-export interface TriggeredJobHistoryCollection extends Array {
+export interface BackupItemCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11708,10 +11845,10 @@ export interface TriggeredJobHistoryCollection extends Array
+ * Collection of site configurations.
+ * @extends Array
*/
-export interface CsmUsageQuotaCollection extends Array {
+export interface SiteConfigResourceCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11721,10 +11858,10 @@ export interface CsmUsageQuotaCollection extends Array {
/**
* @interface
- * Collection of Kudu web job information elements.
- * @extends Array
+ * An interface representing the ApiKVReferenceCollection.
+ * @extends Array
*/
-export interface WebJobCollection extends Array {
+export interface ApiKVReferenceCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11734,10 +11871,10 @@ export interface WebJobCollection extends Array {
/**
* @interface
- * Collection of static sites.
- * @extends Array
+ * Collection of metadata for the app configuration snapshots that can be restored.
+ * @extends Array
*/
-export interface StaticSiteCollection extends Array {
+export interface SiteConfigurationSnapshotInfoCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11747,10 +11884,10 @@ export interface StaticSiteCollection extends Array {
/**
* @interface
- * Collection of static site custom users.
- * @extends Array
+ * Collection of Kudu continuous web job information elements.
+ * @extends Array
*/
-export interface StaticSiteUserCollection extends Array {
+export interface ContinuousWebJobCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11760,10 +11897,10 @@ export interface StaticSiteUserCollection extends Array
+ * Collection of app deployments.
+ * @extends Array
*/
-export interface StaticSiteBuildCollection extends Array {
+export interface DeploymentCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11773,11 +11910,10 @@ export interface StaticSiteBuildCollection extends Array
+ * Collection of Kudu function information elements.
+ * @extends Array
*/
-export interface StaticSiteFunctionOverviewCollection
- extends Array {
+export interface FunctionEnvelopeCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11787,11 +11923,10 @@ export interface StaticSiteFunctionOverviewCollection
/**
* @interface
- * Collection of static site user provided function apps.
- * @extends Array
+ * Collection of hostname bindings.
+ * @extends Array
*/
-export interface StaticSiteUserProvidedFunctionAppsCollection
- extends Array {
+export interface HostNameBindingCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11801,11 +11936,10 @@ export interface StaticSiteUserProvidedFunctionAppsCollection
/**
* @interface
- * Collection of static site custom domains.
- * @extends Array
+ * Collection of app instances.
+ * @extends Array
*/
-export interface StaticSiteCustomDomainOverviewCollection
- extends Array {
+export interface WebAppInstanceStatusCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11815,10 +11949,10 @@ export interface StaticSiteCustomDomainOverviewCollection
/**
* @interface
- * Collection of App Service Environments.
- * @extends Array
+ * Collection of Kudu process information elements.
+ * @extends Array
*/
-export interface AppServiceEnvironmentCollection extends Array {
+export interface ProcessInfoCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11828,10 +11962,10 @@ export interface AppServiceEnvironmentCollection extends Array
+ * Collection of Kudu thread information elements.
+ * @extends Array
*/
-export interface StampCapacityCollection extends Array {
+export interface ProcessModuleInfoCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11841,10 +11975,10 @@ export interface StampCapacityCollection extends Array {
/**
* @interface
- * Collection of Inbound Environment Endpoints
- * @extends Array
+ * Collection of Kudu thread information elements.
+ * @extends Array
*/
-export interface InboundEnvironmentEndpointCollection extends Array {
+export interface ProcessThreadInfoCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11854,10 +11988,10 @@ export interface InboundEnvironmentEndpointCollection extends Array
+ * Collection of performance monitor counters.
+ * @extends Array
*/
-export interface WorkerPoolCollection extends Array {
+export interface PerfMonCounterCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11867,10 +12001,10 @@ export interface WorkerPoolCollection extends Array {
/**
* @interface
- * Collection of metric definitions.
- * @extends Array
+ * Collection of public certificates
+ * @extends Array
*/
-export interface ResourceMetricDefinitionCollection extends Array {
+export interface PublicCertificateCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11880,10 +12014,10 @@ export interface ResourceMetricDefinitionCollection extends Array
+ * Collection of Kudu site extension information elements.
+ * @extends Array
*/
-export interface SkuInfoCollection extends Array {
+export interface SiteExtensionInfoCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11893,10 +12027,10 @@ export interface SkuInfoCollection extends Array {
/**
* @interface
- * Collection of usages.
- * @extends Array
+ * Collection of slot differences.
+ * @extends Array
*/
-export interface UsageCollection extends Array {
+export interface SlotDifferenceCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11906,10 +12040,10 @@ export interface UsageCollection extends Array {
/**
* @interface
- * Collection of Outbound Environment Endpoints
- * @extends Array
+ * Collection of snapshots which can be used to revert an app to a previous time.
+ * @extends Array
*/
-export interface OutboundEnvironmentEndpointCollection extends Array {
+export interface SnapshotCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11919,10 +12053,10 @@ export interface OutboundEnvironmentEndpointCollection extends Array
+ * Collection of Kudu continuous web job information elements.
+ * @extends Array
*/
-export interface AppServicePlanCollection extends Array {
+export interface TriggeredWebJobCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11932,10 +12066,10 @@ export interface AppServicePlanCollection extends Array {
/**
* @interface
- * Collection of resources.
- * @extends Array
+ * Collection of Kudu continuous web job information elements.
+ * @extends Array
*/
-export interface ResourceCollection extends Array {
+export interface TriggeredJobHistoryCollection extends Array {
/**
* Link to next page of resources.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -11945,10 +12079,10 @@ export interface ResourceCollection extends Array