@azure/arm-appservice 16.0.1-alpha.20250619.1 → 17.0.0

package/dist/esm/models/index.d.ts

@@ -812,6 +812,19 @@ export interface SiteDnsConfig {
      */
     readonly dnsLegacySortOrder?: boolean;
 }
+/** Outbound traffic options over virtual network. */
+export interface OutboundVnetRouting {
+    /** Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. */
+    allTraffic?: boolean;
+    /** This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. */
+    applicationTraffic?: boolean;
+    /** Enables accessing content over virtual network. Previously called VnetContentShareEnabled */
+    contentShareTraffic?: boolean;
+    /** Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. */
+    imagePullTraffic?: boolean;
+    /** Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled */
+    backupRestoreTraffic?: boolean;
+}
 /** Configuration of an App Service app. */
 export interface SiteConfig {
     /** Number of workers. */
@@ -852,11 +865,11 @@ export interface SiteConfig {
     detailedErrorLoggingEnabled?: boolean;
     /** Publishing user name. */
     publishingUsername?: string;
-    /** Application settings. */
+    /** Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. */
     appSettings?: NameValuePair[];
     /** Application metadata. This property cannot be retrieved, since it may contain secrets. */
     metadata?: NameValuePair[];
-    /** Connection strings. */
+    /** Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. */
     connectionStrings?: ConnStringInfo[];
     /**
      * Site MachineKey.
@@ -935,6 +948,8 @@ export interface SiteConfig {
     scmIpSecurityRestrictionsUseMain?: boolean;
     /** Http20Enabled: configures a web site to allow clients to connect over http2.0 */
     http20Enabled?: boolean;
+    /** Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. */
+    http20ProxyFlag?: number;
     /** MinTlsVersion: configures the minimum version of TLS required for SSL requests */
     minTlsVersion?: SupportedTlsVersions;
     /** The minimum strength TLS cipher suite allowed for an application */
@@ -1053,10 +1068,7 @@ export interface RampUpRule {
     minReroutePercentage?: number;
     /** Specifies upper boundary below which ReroutePercentage will stay. */
     maxReroutePercentage?: number;
-    /**
-     * Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.
-     * https://www.siteextensions.net/packages/TiPCallback/
-     */
+    /** Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. */
     changeDecisionCallbackUrl?: string;
     /** Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. */
     name?: string;
@@ -2622,6 +2634,29 @@ export interface IdentifierCollection {
      */
     readonly nextLink?: string;
 }
+export interface DnlResourceNameAvailabilityRequest {
+    /** Resource group name */
+    resourceGroupName?: string;
+    /**
+     * Indicates the endpoint name reuse scope.The default value is TenantReuse.
+     * Supported values are TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse
+     */
+    autoGeneratedDomainNameLabelScope?: string;
+    /** Resource name to verify. */
+    name: string;
+    /** Resource type used for verification. */
+    type: CheckNameResourceTypes;
+}
+/** Information regarding availability of a resource name for DNL apps with regionalized default hostnames. */
+export interface DnlResourceNameAvailability {
+    hostName?: string;
+    /** <code>true</code> indicates name is valid and available. <code>false</code> indicates the name is invalid, unavailable, or both. */
+    nameAvailable?: boolean;
+    /** <code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable. */
+    reason?: InAvailabilityReasonType;
+    /** 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. */
+    message?: string;
+}
 /** Collection of premier add-on offers. */
 export interface PremierAddOnOfferCollection {
     /** Collection of resources. */
@@ -3099,7 +3134,7 @@ export interface AzureActiveDirectory {
 export interface AzureActiveDirectoryRegistration {
     /**
      * 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}/.
+     * 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
      */
@@ -3841,7 +3876,7 @@ export interface VolumeMount {
 export interface EnvironmentVariable {
     /** Environment variable name */
     name: string;
-    /** Environment variable value */
+    /** The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. */
     value: string;
 }
 /** Collection of Kudu site extension information elements. */
@@ -4661,6 +4696,17 @@ export interface AppserviceGithubTokenRequest {
     /** State string used for verification. */
     state: string;
 }
+/** A custom error page for a specific status returned by a web app. */
+export interface ErrorPage {
+    /** The status code for which the error page will be used */
+    statusCode?: number;
+    /** The content of the error page. There is a 10kb limit imposed on custom error page content. */
+    content?: string;
+    /** The content type of the error page. For example, 'text/html' */
+    contentType?: string;
+    /** If true, the error page will be shown for all requests with a matching status code, regardless of whether they failed on the App Service FrontEnd load balancer or on the app itself. */
+    alwaysUse?: boolean;
+}
 /** The workflow filter. */
 export interface WorkflowFilter {
     /** The state of workflows. */
@@ -4980,15 +5026,9 @@ export interface Site extends Resource {
     readonly lastModifiedTimeUtc?: Date;
     /** Property to configure various DNS related settings for a site. */
     dnsConfiguration?: SiteDnsConfig;
-    /** Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. */
-    vnetRouteAllEnabled?: boolean;
-    /** To enable pulling image over Virtual Network */
-    vnetImagePullEnabled?: boolean;
-    /** To enable accessing content over virtual network */
-    vnetContentShareEnabled?: boolean;
-    /** To enable Backup and Restore operations over virtual network */
-    vnetBackupRestoreEnabled?: boolean;
-    /** Configuration of the app. */
+    /** Property to configure various outbound traffic routing options over virtual network for a site */
+    outboundVnetRouting?: OutboundVnetRouting;
+    /** Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. */
     siteConfig?: SiteConfig;
     /** Configuration specific of the Azure Function app. */
     functionAppConfig?: FunctionAppConfig;
@@ -5014,6 +5054,10 @@ export interface Site extends Resource {
     hostingEnvironmentProfile?: HostingEnvironmentProfile;
     /** <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. */
     clientAffinityEnabled?: boolean;
+    /** <code>true</code> to enable client affinity partitioning using CHIPS cookies, this will add the <code>partitioned</code> property to the affinity cookies; <code>false</code> to stop sending partitioned affinity cookies. Default is <code>false</code>. */
+    clientAffinityPartitioningEnabled?: boolean;
+    /** <code>true</code> to override client affinity cookie domain with X-Forwarded-Host request header. <code>false</code> to use default domain. Default is <code>false</code>. */
+    clientAffinityProxyEnabled?: boolean;
     /** <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. */
     clientCertEnabled?: boolean;
     /**
@@ -5029,6 +5073,8 @@ export interface Site extends Resource {
     ipMode?: IPMode;
     /** Whether to use end to end encryption between the FrontEnd and the Worker */
     endToEndEncryptionEnabled?: boolean;
+    /** Whether to enable ssh access. */
+    sshEnabled?: boolean;
     /**
      * <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.
      *  If <code>true</code>, the app is only accessible via API management process.
@@ -5198,6 +5244,11 @@ export interface AppServicePlan extends Resource {
      * If <code>false</code>, this App Service Plan will not perform availability zone balancing.
      */
     zoneRedundant?: boolean;
+    /**
+     * If <code>true</code>, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously.
+     * If <code>false</code>, this App Service Plan will only attempt sync scaling.
+     */
+    asyncScalingEnabled?: boolean;
 }
 /** SSL certificate for an app. */
 export interface Certificate extends Resource {
@@ -5267,16 +5318,16 @@ export interface Certificate extends Resource {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly hostingEnvironmentProfile?: HostingEnvironmentProfile;
-    /** Key Vault Csm resource Id. */
+    /** Azure Key Vault Csm resource Id. */
     keyVaultId?: string;
-    /** Key Vault secret name. */
+    /** Azure Key Vault secret name. */
     keyVaultSecretName?: string;
     /**
      * Status of the Key Vault secret.
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly keyVaultSecretStatus?: KeyVaultSecretStatus;
-    /** Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". */
+    /** Resource ID of the associated App Service plan. */
     serverFarmId?: string;
     /** CNAME of the certificate to be issued via free certificate */
     canonicalName?: string;
@@ -6999,6 +7050,8 @@ export interface SitePatchResource extends ProxyOnlyResource {
     hostingEnvironmentProfile?: HostingEnvironmentProfile;
     /** <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. */
     clientAffinityEnabled?: boolean;
+    /** <code>true</code> to override client affinity cookie domain with X-Forwarded-Host request header. <code>false</code> to use default domain. Default is <code>false</code>. */
+    clientAffinityProxyEnabled?: boolean;
     /** <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. */
     clientCertEnabled?: boolean;
     /**
@@ -7288,11 +7341,11 @@ export interface SiteConfigResource extends ProxyOnlyResource {
     detailedErrorLoggingEnabled?: boolean;
     /** Publishing user name. */
     publishingUsername?: string;
-    /** Application settings. */
+    /** Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. */
     appSettings?: NameValuePair[];
     /** Application metadata. This property cannot be retrieved, since it may contain secrets. */
     metadata?: NameValuePair[];
-    /** Connection strings. */
+    /** Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. */
     connectionStrings?: ConnStringInfo[];
     /**
      * Site MachineKey.
@@ -7371,6 +7424,8 @@ export interface SiteConfigResource extends ProxyOnlyResource {
     scmIpSecurityRestrictionsUseMain?: boolean;
     /** Http20Enabled: configures a web site to allow clients to connect over http2.0 */
     http20Enabled?: boolean;
+    /** Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. */
+    http20ProxyFlag?: number;
     /** MinTlsVersion: configures the minimum version of TLS required for SSL requests */
     minTlsVersion?: SupportedTlsVersions;
     /** The minimum strength TLS cipher suite allowed for an application */
@@ -7472,7 +7527,7 @@ export interface SiteAuthSettings extends ProxyOnlyResource {
     clientSecretCertificateThumbprint?: string;
     /**
      * 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}/.
+     * 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
      */
@@ -8212,6 +8267,8 @@ export interface SiteContainer extends ProxyOnlyResource {
     readonly lastModifiedTime?: Date;
     /** List of volume mounts */
     volumeMounts?: VolumeMount[];
+    /** <code>true</code> if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; <code>false</code> otherwise. */
+    inheritAppSettingsAndConnectionStrings?: boolean;
     /** List of environment variables */
     environmentVariables?: EnvironmentVariable[];
 }
@@ -11614,6 +11671,18 @@ export interface ListSiteIdentifiersAssignedToHostNameOptionalParams extends cor
 /** Contains response data for the listSiteIdentifiersAssignedToHostName operation. */
 export type ListSiteIdentifiersAssignedToHostNameResponse = IdentifierCollection;
 /** Optional parameters. */
+export interface RegionalCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+    /** Resource group name */
+    resourceGroupName?: string;
+    /**
+     * Indicates the endpoint name reuse scope.The default value is TenantReuse.
+     * Supported values are TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse
+     */
+    autoGeneratedDomainNameLabelScope?: string;
+}
+/** Contains response data for the regionalCheckNameAvailability operation. */
+export type RegionalCheckNameAvailabilityResponse = DnlResourceNameAvailability;
+/** Optional parameters. */
 export interface ListPremierAddOnOffersOptionalParams extends coreClient.OperationOptions {
 }
 /** Contains response data for the listPremierAddOnOffers operation. */
@@ -11685,6 +11754,62 @@ export interface GetUsagesInLocationListNextOptionalParams extends coreClient.Op
 /** Contains response data for the listNext operation. */
 export type GetUsagesInLocationListNextResponse = CsmUsageQuotaCollection;
 /** Optional parameters. */
+export interface SiteCertificatesListOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the list operation. */
+export type SiteCertificatesListResponse = CertificateCollection;
+/** Optional parameters. */
+export interface SiteCertificatesGetOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the get operation. */
+export type SiteCertificatesGetResponse = Certificate;
+/** Optional parameters. */
+export interface SiteCertificatesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the createOrUpdate operation. */
+export type SiteCertificatesCreateOrUpdateResponse = Certificate;
+/** Optional parameters. */
+export interface SiteCertificatesDeleteOptionalParams extends coreClient.OperationOptions {
+}
+/** Optional parameters. */
+export interface SiteCertificatesUpdateOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the update operation. */
+export type SiteCertificatesUpdateResponse = Certificate;
+/** Optional parameters. */
+export interface SiteCertificatesListSlotOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the listSlot operation. */
+export type SiteCertificatesListSlotResponse = CertificateCollection;
+/** Optional parameters. */
+export interface SiteCertificatesGetSlotOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the getSlot operation. */
+export type SiteCertificatesGetSlotResponse = Certificate;
+/** Optional parameters. */
+export interface SiteCertificatesCreateOrUpdateSlotOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the createOrUpdateSlot operation. */
+export type SiteCertificatesCreateOrUpdateSlotResponse = Certificate;
+/** Optional parameters. */
+export interface SiteCertificatesDeleteSlotOptionalParams extends coreClient.OperationOptions {
+}
+/** Optional parameters. */
+export interface SiteCertificatesUpdateSlotOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the updateSlot operation. */
+export type SiteCertificatesUpdateSlotResponse = Certificate;
+/** Optional parameters. */
+export interface SiteCertificatesListNextOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the listNext operation. */
+export type SiteCertificatesListNextResponse = CertificateCollection;
+/** Optional parameters. */
+export interface SiteCertificatesListSlotNextOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the listSlotNext operation. */
+export type SiteCertificatesListSlotNextResponse = CertificateCollection;
+/** Optional parameters. */
 export interface StaticSitesPreviewWorkflowOptionalParams extends coreClient.OperationOptions {
 }
 /** Contains response data for the previewWorkflow operation. */