@kengachu-pulumi/azure-native-web
Version:
Pulumi Azure Native package for web
1,810 lines • 69.9 kB
TypeScript
/**
* The configuration settings of the Allowed Audiences validation flow.
*/
export interface AllowedAudiencesValidationResponse {
/**
* The configuration settings of the allowed list of audiences from which to validate the JWT token.
*/
allowedAudiences?: string[];
}
/**
* The configuration settings of the Azure Active Directory allowed principals.
*/
export interface AllowedPrincipalsResponse {
/**
* The list of the allowed groups.
*/
groups?: string[];
/**
* The list of the allowed identities.
*/
identities?: string[];
}
export interface ApiConnectionDefinitionResponseProperties {
api?: ApiReferenceResponse;
/**
* Timestamp of last connection change
*/
changedTime?: string;
/**
* Timestamp of the connection creation
*/
createdTime?: string;
/**
* Dictionary of custom parameter values
*/
customParameterValues?: {
[key: string]: string;
};
/**
* Display name
*/
displayName?: string;
/**
* Dictionary of nonsecret parameter values
*/
nonSecretParameterValues?: {
[key: string]: string;
};
/**
* Dictionary of parameter values
*/
parameterValues?: {
[key: string]: string;
};
/**
* Status of the connection
*/
statuses?: ConnectionStatusDefinitionResponse[];
/**
* Links to test the API connection
*/
testLinks?: ApiConnectionTestLinkResponse[];
}
/**
* API connection properties
*/
export interface ApiConnectionTestLinkResponse {
/**
* HTTP Method
*/
method?: string;
/**
* Test link request URI
*/
requestUri?: string;
}
/**
* OAuth settings for the API
*/
export interface ApiOAuthSettingsParameterResponse {
/**
* Options available to this parameter
*/
options?: any;
/**
* UI definitions per culture as caller can specify the culture
*/
uiDefinition?: any;
/**
* Value of the setting
*/
value?: string;
}
/**
* OAuth settings for the connection provider
*/
export interface ApiOAuthSettingsResponse {
/**
* Resource provider client id
*/
clientId?: string;
/**
* Client Secret needed for OAuth
*/
clientSecret?: string;
/**
* OAuth parameters key is the name of parameter
*/
customParameters?: {
[key: string]: ApiOAuthSettingsParameterResponse;
};
/**
* Identity provider
*/
identityProvider?: string;
/**
* Read only properties for this oauth setting.
*/
properties?: any;
/**
* Url
*/
redirectUrl?: string;
/**
* OAuth scopes
*/
scopes?: string[];
}
export interface ApiReferenceResponse {
/**
* Brand color
*/
brandColor?: string;
/**
* The custom API description
*/
description?: string;
/**
* The display name
*/
displayName?: string;
/**
* The icon URI
*/
iconUri?: string;
/**
* Resource reference id
*/
id?: string;
/**
* The name of the API
*/
name?: string;
/**
* The JSON representation of the swagger
*/
swagger?: any;
/**
* Resource reference type
*/
type?: string;
}
/**
* The API backend service
*/
export interface ApiResourceBackendServiceResponse {
/**
* The service URL
*/
serviceUrl?: string;
}
/**
* API Definitions
*/
export interface ApiResourceDefinitionsResponse {
/**
* The modified swagger URL
*/
modifiedSwaggerUrl?: string;
/**
* The original swagger URL
*/
originalSwaggerUrl?: string;
}
export interface AppLogsConfigurationResponse {
destination?: string;
logAnalyticsConfiguration?: LogAnalyticsConfigurationResponse;
}
/**
* The configuration settings of the app registration for providers that have app ids and app secrets
*/
export interface AppRegistrationResponse {
/**
* The App ID of the app used for login.
*/
appId?: string;
/**
* The app setting name that contains the app secret.
*/
appSecretSettingName?: string;
}
/**
* The configuration settings of the registration for the Apple provider
*/
export interface AppleRegistrationResponse {
/**
* The Client ID of the app used for login.
*/
clientId?: string;
/**
* The app setting name that contains the client secret.
*/
clientSecretSettingName?: string;
}
/**
* The configuration settings of the Apple provider.
*/
export interface AppleResponse {
/**
* <code>false</code> if the Apple provider should not be enabled despite the set registration; otherwise, <code>true</code>.
*/
enabled?: boolean;
/**
* The configuration settings of the login flow.
*/
login?: LoginScopesResponse;
/**
* The configuration settings of the Apple registration.
*/
registration?: AppleRegistrationResponse;
}
/**
* Application logs configuration.
*/
export interface ApplicationLogsConfigResponse {
/**
* Application logs to blob storage configuration.
*/
azureBlobStorage?: AzureBlobStorageApplicationLogsConfigResponse;
/**
* Application logs to azure table storage configuration.
*/
azureTableStorage?: AzureTableStorageApplicationLogsConfigResponse;
/**
* Application logs to file system configuration.
*/
fileSystem?: FileSystemApplicationLogsConfigResponse;
}
/**
* applicationLogsConfigResponseProvideDefaults sets the appropriate defaults for ApplicationLogsConfigResponse
*/
export declare function applicationLogsConfigResponseProvideDefaults(val: ApplicationLogsConfigResponse): ApplicationLogsConfigResponse;
export interface ArcConfigurationResponse {
artifactStorageAccessMode?: string;
artifactStorageClassName?: string;
artifactStorageMountPath?: string;
artifactStorageNodeName?: string;
artifactsStorageType?: string;
frontEndServiceConfiguration?: FrontEndConfigurationResponse;
}
/**
* A wrapper for an ARM resource id
*/
export interface ArmIdWrapperResponse {
id: string;
}
/**
* The plan object in Azure Resource Manager, represents a marketplace plan.
*/
export interface ArmPlanResponse {
/**
* The name.
*/
name?: string;
/**
* The product.
*/
product?: string;
/**
* The promotion code.
*/
promotionCode?: string;
/**
* The publisher.
*/
publisher?: string;
/**
* Version of product.
*/
version?: string;
}
/**
* Full view of networking configuration for an ASE.
*/
export interface AseV3NetworkingConfigurationResponse {
/**
* Property to enable and disable new private endpoint connection creation on ASE
*/
allowNewPrivateEndpointConnections?: boolean;
externalInboundIpAddresses: string[];
/**
* Property to enable and disable FTP on ASEV3
*/
ftpEnabled?: boolean;
/**
* Resource Id.
*/
id: string;
/**
* Customer provided Inbound IP Address. Only able to be set on Ase create.
*/
inboundIpAddressOverride?: string;
internalInboundIpAddresses: string[];
/**
* Kind of resource.
*/
kind?: string;
linuxOutboundIpAddresses: string[];
/**
* Resource Name.
*/
name: string;
/**
* Property to enable and disable Remote Debug on ASEV3
*/
remoteDebugEnabled?: boolean;
/**
* Resource type.
*/
type: string;
windowsOutboundIpAddresses: string[];
}
/**
* The configuration settings of the platform of App Service Authentication/Authorization.
*/
export interface AuthPlatformResponse {
/**
* 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;
/**
* <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.
*/
enabled?: boolean;
/**
* 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.
*/
runtimeVersion?: string;
}
/**
* The configuration settings of the Azure Active Directory login flow.
*/
export interface AzureActiveDirectoryLoginResponse {
/**
* <code>true</code> if the www-authenticate provider should be omitted from the request; otherwise, <code>false</code>.
*/
disableWWWAuthenticate?: boolean;
/**
* Login parameters to send to the OpenID Connect authorization endpoint when
* a user logs in. Each parameter must be in the form "key=value".
*/
loginParameters?: string[];
}
/**
* The configuration settings of the Azure Active Directory app registration.
*/
export interface AzureActiveDirectoryRegistrationResponse {
/**
* 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;
/**
* An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as
* a replacement for the Client Secret Certificate Thumbprint. It is also optional.
*/
clientSecretCertificateIssuer?: string;
/**
* An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as
* a replacement for the Client Secret Certificate Thumbprint. It is also optional.
*/
clientSecretCertificateSubjectAlternativeName?: 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.
*/
clientSecretCertificateThumbprint?: string;
/**
* The app setting name that contains the client secret of the relying party application.
*/
clientSecretSettingName?: 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://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 configuration settings of the Azure Active directory provider.
*/
export interface AzureActiveDirectoryResponse {
/**
* <code>false</code> if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, <code>true</code>.
*/
enabled?: boolean;
/**
* 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.
*/
isAutoProvisioned?: boolean;
/**
* The configuration settings of the Azure Active Directory login flow.
*/
login?: AzureActiveDirectoryLoginResponse;
/**
* The configuration settings of the Azure Active Directory app registration.
*/
registration?: AzureActiveDirectoryRegistrationResponse;
/**
* The configuration settings of the Azure Active Directory token validation flow.
*/
validation?: AzureActiveDirectoryValidationResponse;
}
/**
* The configuration settings of the Azure Active Directory token validation flow.
*/
export interface AzureActiveDirectoryValidationResponse {
/**
* The list of audiences that can make successful authentication/authorization requests.
*/
allowedAudiences?: string[];
/**
* The configuration settings of the default authorization policy.
*/
defaultAuthorizationPolicy?: DefaultAuthorizationPolicyResponse;
/**
* The configuration settings of the checks that should be made while validating the JWT Claims.
*/
jwtClaimChecks?: JwtClaimChecksResponse;
}
/**
* Application logs azure blob storage configuration.
*/
export interface AzureBlobStorageApplicationLogsConfigResponse {
/**
* Log level.
*/
level?: string;
/**
* Retention in days.
* Remove blobs older than X days.
* 0 or lower means no retention.
*/
retentionInDays?: number;
/**
* SAS url to a azure blob container with read/write/list/delete permissions.
*/
sasUrl?: string;
}
/**
* Http logs to azure blob storage configuration.
*/
export interface AzureBlobStorageHttpLogsConfigResponse {
/**
* True if configuration is enabled, false if it is disabled and null if configuration is not set.
*/
enabled?: boolean;
/**
* Retention in days.
* Remove blobs older than X days.
* 0 or lower means no retention.
*/
retentionInDays?: number;
/**
* SAS url to a azure blob container with read/write/list/delete permissions.
*/
sasUrl?: string;
}
/**
* The azure resource error info.
*/
export interface AzureResourceErrorInfoResponse {
/**
* The error code.
*/
code: string;
/**
* The error details.
*/
details?: AzureResourceErrorInfoResponse[];
/**
* The error message.
*/
message: string;
}
/**
* The configuration settings of the registration for the Azure Static Web Apps provider
*/
export interface AzureStaticWebAppsRegistrationResponse {
/**
* The Client ID of the app used for login.
*/
clientId?: string;
}
/**
* The configuration settings of the Azure Static Web Apps provider.
*/
export interface AzureStaticWebAppsResponse {
/**
* <code>false</code> if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, <code>true</code>.
*/
enabled?: boolean;
/**
* The configuration settings of the Azure Static Web Apps registration.
*/
registration?: AzureStaticWebAppsRegistrationResponse;
}
/**
* Azure Files or Blob Storage access information value for dictionary storage.
*/
export interface AzureStorageInfoValueResponse {
/**
* Access key for the storage account.
*/
accessKey?: string;
/**
* Name of the storage account.
*/
accountName?: string;
/**
* Path to mount the storage within the site's runtime environment.
*/
mountPath?: string;
/**
* Mounting protocol to use for the storage account.
*/
protocol?: string;
/**
* Name of the file share (container name, for Blob storage).
*/
shareName?: string;
/**
* State of the storage account.
*/
state: string;
/**
* Type of storage.
*/
type?: string;
}
/**
* Application logs to Azure table storage configuration.
*/
export interface AzureTableStorageApplicationLogsConfigResponse {
/**
* Log level.
*/
level?: string;
/**
* SAS URL to an Azure table with add/query/delete permissions.
*/
sasUrl: string;
}
/**
* Backup description.
*/
export interface BackupItemResponse {
/**
* Id of the backup.
*/
backupId: number;
/**
* Name of the blob which contains data for this backup.
*/
blobName: string;
/**
* Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
*/
correlationId: string;
/**
* Timestamp of the backup creation.
*/
created: string;
/**
* List of databases included in the backup.
*/
databases: DatabaseBackupSettingResponse[];
/**
* Timestamp when this backup finished.
*/
finishedTimeStamp: string;
/**
* Resource Id.
*/
id: string;
/**
* Kind of resource.
*/
kind?: string;
/**
* Timestamp of a last restore operation which used this backup.
*/
lastRestoreTimeStamp: string;
/**
* Details regarding this backup. Might contain an error message.
*/
log: string;
/**
* Resource Name.
*/
name: string;
/**
* True if this backup has been created due to a schedule being triggered.
*/
scheduled: boolean;
/**
* Size of the backup in bytes.
*/
sizeInBytes: number;
/**
* Backup status.
*/
status: string;
/**
* SAS URL for the storage account container which contains this backup.
*/
storageAccountUrl: string;
/**
* Resource type.
*/
type: string;
/**
* Size of the original web app which has been backed up.
*/
websiteSizeInBytes: number;
}
/**
* Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.
*/
export interface BackupScheduleResponse {
/**
* 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)
*/
frequencyInterval: number;
/**
* 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)
*/
frequencyUnit: string;
/**
* True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
*/
keepAtLeastOneBackup: boolean;
/**
* Last time when this schedule was triggered.
*/
lastExecutionTime: string;
/**
* After how many days backups should be deleted.
*/
retentionPeriodInDays: number;
/**
* When the schedule should start working.
*/
startTime?: string;
}
/**
* backupScheduleResponseProvideDefaults sets the appropriate defaults for BackupScheduleResponse
*/
export declare function backupScheduleResponseProvideDefaults(val: BackupScheduleResponse): BackupScheduleResponse;
/**
* The configuration settings of the storage of the tokens if blob storage is used.
*/
export interface BlobStorageTokenStoreResponse {
/**
* The name of the app setting containing the SAS URL of the blob storage containing the tokens.
*/
sasUrlSettingName?: string;
}
/**
* Describes the capabilities/features allowed for a specific SKU.
*/
export interface CapabilityResponse {
/**
* Name of the SKU capability.
*/
name?: string;
/**
* Reason of the SKU capability.
*/
reason?: string;
/**
* Value of the SKU capability.
*/
value?: string;
}
/**
* The configuration settings of the app registration for providers that have client ids and client secrets
*/
export interface ClientRegistrationResponse {
/**
* 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 ConnStringValueTypePairResponse {
/**
* Type of database.
*/
type: string;
/**
* Value of pair.
*/
value: string;
}
/**
* Connection error
*/
export interface ConnectionErrorResponse {
/**
* Code of the status
*/
code?: string;
/**
* Resource ETag
*/
etag?: string;
/**
* Resource id
*/
id: string;
/**
* Resource location
*/
location?: string;
/**
* Description of the status
*/
message?: string;
/**
* Resource name
*/
name: string;
/**
* Resource tags
*/
tags?: {
[key: string]: string;
};
/**
* Resource type
*/
type: string;
}
export interface ConnectionGatewayDefinitionResponseProperties {
/**
* The URI of the backend
*/
backendUri?: string;
/**
* The gateway installation reference
*/
connectionGatewayInstallation?: ConnectionGatewayReferenceResponse;
/**
* The gateway admin
*/
contactInformation?: string[];
/**
* The gateway description
*/
description?: string;
/**
* The gateway display name
*/
displayName?: string;
/**
* The machine name of the gateway
*/
machineName?: string;
/**
* The gateway status
*/
status?: any;
}
/**
* The gateway installation reference
*/
export interface ConnectionGatewayReferenceResponse {
/**
* Resource reference id
*/
id?: string;
/**
* Resource reference location
*/
location?: string;
/**
* Resource reference name
*/
name?: string;
/**
* Resource reference type
*/
type?: string;
}
/**
* Connection provider parameters
*/
export interface ConnectionParameterResponse {
/**
* OAuth settings for the connection provider
*/
oAuthSettings?: ApiOAuthSettingsResponse;
/**
* Type of the parameter
*/
type?: string;
}
/**
* Connection status
*/
export interface ConnectionStatusDefinitionResponse {
/**
* Connection error
*/
error?: ConnectionErrorResponse;
/**
* The gateway status
*/
status?: string;
/**
* Target of the error
*/
target?: string;
}
/**
* A consent link
*/
export interface ConsentLinkDefinitionResponse {
/**
* Display name of the parameter in the connection provider's OAuth settings
*/
displayName?: string;
/**
* URI for first party login
*/
firstPartyLoginUri?: string;
/**
* URI for the consent link
*/
link?: string;
/**
* Status of the link
*/
status?: string;
}
export interface ContainerAppsConfigurationResponse {
/**
* Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
*/
appSubnetResourceId?: string;
/**
* Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.
*/
controlPlaneSubnetResourceId?: string;
/**
* Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry
*/
daprAIInstrumentationKey?: string;
/**
* CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.
*/
dockerBridgeCidr?: string;
/**
* IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.
*/
platformReservedCidr?: string;
/**
* An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server
*/
platformReservedDnsIP?: string;
}
/**
* The configuration settings of the session cookie's expiration.
*/
export interface CookieExpirationResponse {
/**
* The convention used when determining the session cookie's expiration.
*/
convention?: string;
/**
* The time after the request is made when the session cookie should expire.
*/
timeToExpiration?: string;
}
/**
* Custom API properties
*/
export interface CustomApiPropertiesDefinitionResponse {
/**
* API Definitions
*/
apiDefinitions?: ApiResourceDefinitionsResponse;
/**
* The API type
*/
apiType?: string;
/**
* The API backend service
*/
backendService?: ApiResourceBackendServiceResponse;
/**
* Brand color
*/
brandColor?: string;
/**
* The custom API capabilities
*/
capabilities?: string[];
/**
* Connection parameters
*/
connectionParameters?: {
[key: string]: ConnectionParameterResponse;
};
/**
* The custom API description
*/
description?: string;
/**
* The display name
*/
displayName?: string;
/**
* The icon URI
*/
iconUri?: string;
/**
* Runtime URLs
*/
runtimeUrls?: string[];
/**
* The JSON representation of the swagger
*/
swagger?: any;
/**
* The WSDL definition
*/
wsdlDefinition?: WsdlDefinitionResponse;
}
/**
* Full view of the custom domain suffix configuration for ASEv3.
*/
export interface CustomDnsSuffixConfigurationResponse {
/**
* The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
*/
certificateUrl?: string;
/**
* The default custom domain suffix to use for all sites deployed on the ASE.
*/
dnsSuffix?: string;
/**
* Resource Id.
*/
id: string;
/**
* The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
*/
keyVaultReferenceIdentity?: string;
/**
* Kind of resource.
*/
kind?: string;
/**
* Resource Name.
*/
name: string;
provisioningDetails: string;
provisioningState: string;
/**
* Resource type.
*/
type: string;
}
/**
* The configuration settings of the custom Open ID Connect provider.
*/
export interface CustomOpenIdConnectProviderResponse {
/**
* <code>false</code> if the custom Open ID provider provider should not be enabled; otherwise, <code>true</code>.
*/
enabled?: boolean;
/**
* The configuration settings of the login flow of the custom Open ID Connect provider.
*/
login?: OpenIdConnectLoginResponse;
/**
* The configuration settings of the app registration for the custom Open ID Connect provider.
*/
registration?: OpenIdConnectRegistrationResponse;
}
/**
* App Dapr configuration.
*/
export interface DaprConfigResponse {
/**
* Dapr application identifier
*/
appId?: string;
/**
* Tells Dapr which port your application is listening on
*/
appPort?: number;
/**
* Enables API logging for the Dapr sidecar
*/
enableApiLogging?: boolean;
/**
* Boolean indicating if the Dapr side car is enabled
*/
enabled?: boolean;
/**
* Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB.
*/
httpMaxRequestSize?: number;
/**
* Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.
*/
httpReadBufferSize?: number;
/**
* Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
*/
logLevel?: string;
}
/**
* daprConfigResponseProvideDefaults sets the appropriate defaults for DaprConfigResponse
*/
export declare function daprConfigResponseProvideDefaults(val: DaprConfigResponse): DaprConfigResponse;
/**
* Database backup settings.
*/
export interface DatabaseBackupSettingResponse {
/**
* 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;
/**
* Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.
* This is used during restore with overwrite connection strings options.
*/
connectionStringName?: string;
/**
* Database type (e.g. SqlAzure / MySql).
*/
databaseType: string;
name?: string;
}
/**
* Static Site Database Connection overview.
*/
export interface DatabaseConnectionOverviewResponse {
/**
* A list of configuration files associated with this database connection.
*/
configurationFiles: StaticSiteDatabaseConnectionConfigurationFileOverviewResponse[];
/**
* If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
*/
connectionIdentity: string;
/**
* If present, the name of this database connection resource.
*/
name: string;
/**
* The region of the database resource.
*/
region: string;
/**
* The resource id of the database.
*/
resourceId: string;
}
/**
* The configuration settings of the Azure Active Directory default authorization policy.
*/
export interface DefaultAuthorizationPolicyResponse {
/**
* The configuration settings of the Azure Active Directory allowed applications.
*/
allowedApplications?: string[];
/**
* The configuration settings of the Azure Active Directory allowed principals.
*/
allowedPrincipals?: AllowedPrincipalsResponse;
}
/**
* Enabled configuration.
*/
export interface EnabledConfigResponse {
/**
* True if configuration is enabled, false if it is disabled and null if configuration is not set.
*/
enabled?: boolean;
}
export interface EnvironmentVariableResponse {
/**
* Environment variable name
*/
name: string;
/**
* 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;
}
/**
* Body of the error response returned from the API.
*/
export interface ErrorEntityResponse {
/**
* Basic error code.
*/
code?: string;
/**
* Error Details.
*/
details?: ErrorEntityResponse[];
/**
* Type of error.
*/
extendedCode?: string;
/**
* Inner errors.
*/
innerErrors?: ErrorEntityResponse[];
/**
* Any details of the error.
*/
message?: string;
/**
* Message template.
*/
messageTemplate?: string;
/**
* Parameters for the template.
*/
parameters?: string[];
/**
* The error target.
*/
target?: string;
}
/**
* The expression.
*/
export interface ExpressionResponse {
/**
* The azure resource error info.
*/
error?: AzureResourceErrorInfoResponse;
/**
* The sub expressions.
*/
subexpressions?: ExpressionResponse[];
/**
* The text.
*/
text?: string;
value?: any;
}
/**
* The expression root.
*/
export interface ExpressionRootResponse {
/**
* The azure resource error info.
*/
error?: AzureResourceErrorInfoResponse;
/**
* The path.
*/
path?: string;
/**
* The sub expressions.
*/
subexpressions?: ExpressionResponse[];
/**
* The text.
*/
text?: string;
value?: any;
}
/**
* Extended Location.
*/
export interface ExtendedLocationResponse {
/**
* Name of extended location.
*/
name?: string;
/**
* Type of extended location.
*/
type: string;
}
/**
* The configuration settings of the Facebook provider.
*/
export interface FacebookResponse {
/**
* <code>false</code> if the Facebook provider should not be enabled despite the set registration; otherwise, <code>true</code>.
*/
enabled?: boolean;
/**
* The version of the Facebook api to be used while logging in.
*/
graphApiVersion?: string;
/**
* The configuration settings of the login flow.
*/
login?: LoginScopesResponse;
/**
* The configuration settings of the app registration for the Facebook provider.
*/
registration?: AppRegistrationResponse;
}
/**
* Application logs to file system configuration.
*/
export interface FileSystemApplicationLogsConfigResponse {
/**
* Log level.
*/
level?: string;
}
/**
* fileSystemApplicationLogsConfigResponseProvideDefaults sets the appropriate defaults for FileSystemApplicationLogsConfigResponse
*/
export declare function fileSystemApplicationLogsConfigResponseProvideDefaults(val: FileSystemApplicationLogsConfigResponse): FileSystemApplicationLogsConfigResponse;
/**
* Http logs to file system configuration.
*/
export interface FileSystemHttpLogsConfigResponse {
/**
* True if configuration is enabled, false if it is disabled and null if configuration is not set.
*/
enabled?: boolean;
/**
* Retention in days.
* Remove files older than X days.
* 0 or lower means no retention.
*/
retentionInDays?: number;
/**
* 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.
*/
retentionInMb?: number;
}
/**
* The configuration settings of the storage of the tokens if a file system is used.
*/
export interface FileSystemTokenStoreResponse {
/**
* The directory in which the tokens will be stored.
*/
directory?: string;
}
/**
* The configuration settings of a forward proxy used to make the requests.
*/
export interface ForwardProxyResponse {
/**
* The convention used to determine the url of the request made.
*/
convention?: string;
/**
* The name of the header containing the host of the request.
*/
customHostHeaderName?: string;
/**
* The name of the header containing the scheme of the request.
*/
customProtoHeaderName?: string;
}
export interface FrontEndConfigurationResponse {
kind?: string;
}
/**
* Function app configuration.
*/
export interface FunctionAppConfigResponse {
/**
* Function app deployment configuration.
*/
deployment?: FunctionsDeploymentResponse;
/**
* Function app runtime settings.
*/
runtime?: FunctionsRuntimeResponse;
/**
* Function app scale and concurrency settings.
*/
scaleAndConcurrency?: FunctionsScaleAndConcurrencyResponse;
}
/**
* Sets the number of 'Always Ready' instances for a function group or a specific function.
*/
export interface FunctionsAlwaysReadyConfigResponse {
/**
* Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready.
*/
instanceCount?: number;
/**
* Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready.
*/
name?: string;
}
/**
* Configuration section for the function app deployment.
*/
export interface FunctionsDeploymentResponse {
/**
* Storage for deployed package used by the function app.
*/
storage?: FunctionsDeploymentResponseStorage;
}
/**
* Authentication method to access the storage account for deployment.
*/
export interface FunctionsDeploymentResponseAuthentication {
/**
* Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type.
*/
storageAccountConnectionStringName?: string;
/**
* Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.
*/
type?: string;
/**
* Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type.
*/
userAssignedIdentityResourceId?: string;
}
/**
* Storage for deployed package used by the function app.
*/
export interface FunctionsDeploymentResponseStorage {
/**
* Authentication method to access the storage account for deployment.
*/
authentication?: FunctionsDeploymentResponseAuthentication;
/**
* Property to select Azure Storage type. Available options: blobContainer.
*/
type?: string;
/**
* Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>.
*/
value?: string;
}
/**
* Function app runtime name and version.
*/
export interface FunctionsRuntimeResponse {
/**
* Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom
*/
name?: string;
/**
* Function app runtime version. Example: 8 (for dotnet-isolated)
*/
version?: string;
}
/**
* Scale and concurrency settings for the function app.
*/
export interface FunctionsScaleAndConcurrencyResponse {
/**
* 'Always Ready' configuration for the function app.
*/
alwaysReady?: FunctionsAlwaysReadyConfigResponse[];
/**
* Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally.
*/
instanceMemoryMB?: number;
/**
* The maximum number of instances for the function app.
*/
maximumInstanceCount?: number;
/**
* Scale and concurrency settings for the function app triggers.
*/
triggers?: FunctionsScaleAndConcurrencyResponseTriggers;
}
/**
* Scale and concurrency settings for the HTTP trigger.
*/
export interface FunctionsScaleAndConcurrencyResponseHttp {
/**
* The maximum number of concurrent HTTP trigger invocations per instance.
*/
perInstanceConcurrency?: number;
}
/**
* Scale and concurrency settings for the function app triggers.
*/
export interface FunctionsScaleAndConcurrencyResponseTriggers {
/**
* Scale and concurrency settings for the HTTP trigger.
*/
http?: FunctionsScaleAndConcurrencyResponseHttp;
}
/**
* The GitHub action code configuration.
*/
export interface GitHubActionCodeConfigurationResponse {
/**
* Runtime stack is used to determine the workflow file content for code base apps.
*/
runtimeStack?: string;
/**
* Runtime version is used to determine what build version to set in the workflow file.
*/
runtimeVersion?: string;
}
/**
* The GitHub action configuration.
*/
export interface GitHubActionConfigurationResponse {
/**
* GitHub Action code configuration.
*/
codeConfiguration?: GitHubActionCodeConfigurationResponse;
/**
* GitHub Action container configuration.
*/
containerConfiguration?: GitHubActionContainerConfigurationResponse;
/**
* Workflow option to determine whether the workflow file should be generated and written to the repository.
*/
generateWorkflowFile?: boolean;
/**
* This will help determine the workflow configuration to select.
*/
isLinux?: boolean;
}
/**
* The GitHub action container configuration.
*/
export interface GitHubActionContainerConfigurationResponse {
/**
* The image name for the build.
*/
imageName?: string;
/**
* The password used to upload the image to the container registry.
*/
password?: string;
/**
* The server URL for the container registry where the build will be hosted.
*/
serverUrl?: string;
/**
* The username used to upload the image to the container registry.
*/
username?: string;
}
/**
* The configuration settings of the GitHub provider.
*/
export interface GitHubResponse {
/**
* <code>false</code> if the GitHub provider should not be enabled despite the set registration; otherwise, <code>true</code>.
*/
enabled?: boolean;
/**
* The configuration settings of the login flow.
*/
login?: LoginScopesResponse;
/**
* The configuration settings of the app registration for the GitHub provider.
*/
registration?: ClientRegistrationResponse;
}
/**
* The configuration settings that determines the validation flow of users using App Service Authentication/Authorization.
*/
export interface GlobalValidationResponse {
/**
* The paths for which unauthenticated flow would not be redirected to the login page.
*/
excludedPaths?: 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".
*/
redirectToProvider?: string;
/**
* <code>true</code> if the authentication flow is required any request is made; otherwise, <code>false</code>.
*/
requireAuthentication?: boolean;
/**
* The action to take when an unauthenticated client attempts to access the app.
*/
unauthenticatedClientAction?: string;
}
/**
* The configuration settings of the Google provider.
*/
export interface GoogleResponse {
/**
* <code>false</code> if the Google provider should not be enabled despite the set registration; otherwise, <code>true</code>.
*/
enabled?: boolean;
/**
* The configuration settings of the login flow.
*/
login?: LoginScopesResponse;
/**
* The configuration settings of the app registration for the Google provider.
*/
registration?: ClientRegistrationResponse;
/**
* The configuration settings of the Azure Active Directory token validation flow.
*/
validation?: AllowedAudiencesValidationResponse;
}
/**
* SSL-enabled hostname.
*/
export interface HostNameSslStateResponse {
/**
* Indicates whether the hostname is a standard or repository hostname.
*/
hostType?: string;
/**
* Hostname.
*/
name?: string;
/**
* SSL type.
*/
sslState?: string;
/**
* SSL certificate thumbprint.
*/
thumbprint?: string;
/**
* Set to <code>true</code> to update existing hostname.
*/
toUpdate?: boolean;
/**
* Virtual IP address assigned to the hostname if IP based SSL is enabled.
*/
virtualIP?: string;
}
/**
* Specification for an App Service Environment to use for this resource.
*/
export interface HostingEnvironmentProfileResponse {
/**
* Resource ID of the App Service Environment.
*/
id?: string;
/**
* Name of the App Service Environment.
*/
name: string;
/**
* Resource type of the App Service Environment.
*/
type: string;
}
/**
* Http logs configuration.
*/
export interface HttpLogsConfigResponse {
/**
* Http logs to azure blob storage configuration.
*/
azureBlobStorage?: AzureBlobStorageHttpLogsConfigResponse;
/**
* Http logs to file system configuration.
*/
fileSystem?: FileSystemHttpLogsConfigResponse;
}
/**
* The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization.
*/
export interface HttpSettingsResponse {
/**
* The configuration settings of a forward proxy used to make the requests.
*/
forwardProxy?: ForwardProxyResponse;
/**
* <code>false</code> if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, <code>true</code>.
*/
requireHttps?: boolean;
/**
* The configuration settings of the paths HTTP requests.
*/
routes?: HttpSettingsRoutesResponse;
}
/**
* The configuration settings of the paths HTTP requests.
*/
export interface HttpSettingsRoutesResponse {
/**
* The prefix that should precede all the authentication/authorization paths.
*/
apiPrefix?: string;
}
/**
* A domain specific resource identifier.
*/
export interface IdentifierResponse {
/**
* Resource Id.
*/
id: string;
/**
* Kind of resource.
*/
kind?: string;
/**
* Resource Name.
*/
name: string;
/**
* Resource type.
*/
type: string;
/**
* String representation of the identity.
*/
value?: string;
}
/**
* The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization.
*/
export interface IdentityProvidersResponse {
/**
* The configuration settings of the Apple provider.
*/
apple?: AppleResponse;
/**
* The configuration settings of the Azure Active directory provider.
*/
azureActiveDirectory?: AzureActiveDirectoryResponse;
/**
* The configuration settings of the Azure Static Web Apps provider.
*/
azureStaticWebApps?: AzureStaticWebAppsResponse;
/**
* 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.
*/
customOpenIdConnectProviders?: {
[key: string]: CustomOpenIdConnectProviderResponse;
};
/**
* The configuration settings of the Facebook provider.
*/
facebook?: FacebookResponse;
/**
* The configuration settings of the GitHub provider.
*/
gitHub?: GitHubResponse;
/**
* The configuration settings of the Google provider.
*/
google?: GoogleResponse;
/**
* The configuration settings of the legacy Microsoft Account provider.
*/
legacyMicrosoftAccount?: LegacyMicrosoftAccountResponse;
/**
* The configuration settings of the Twitter provider.
*/
twitter?: TwitterResponse;
}
/**
* The configuration settings of the checks that should be made while validating the JWT Claims.
*/
export interface JwtClaimChecksResponse {
/**
* The list of the allowed client applications.
*/
allowedClientApplications?: string[];
/**
* The list of the allowed groups.
*/
allowedGroups?: string[];
}
/**
* Specification for a Kubernetes Environment to use for this resource.
*/
export interface KubeEnvironmentProfileResponse {
/**
* Resource ID of the Kubernetes Environment.
*/
id?: string;
/**
* Name of the Kubernetes Environment.
*/
name: string;
/**
* Resource type of the Kubernetes Environment.
*/
type: string;
}
/**
* The configuration settings of the legacy Microsoft Account provider.
*/
export interface LegacyMicrosoftAccountResponse {
/**
* <code>false</code> if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, <code>true</code>.
*/
enabled?: boolean;
/**
* The configuration settings of the login flow.
*/
login?: LoginScopesResponse;
/**
* The configuration settings of the app registration for the legacy Microsoft Account provider.
*/
registration?: ClientRegistrationResponse;
/**
* The configuration settings of the legacy Microsoft Account provider token validation flow.
*/
validation?: AllowedAudiencesValidationResponse;
}
export interface LogAnalyticsConfigurationResponse {
customerId?: string;
}
/**
* The configuration settings of the login flow of users using App Service Authentication/Authorization.
*/
export interface LoginResponse {
/**
* 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.
*/
allowedExternalRedirectUrls?: string[];
/**
* The configuration settings of the session cookie's expiration.
*/
cookieExpiration?: CookieExpirationResponse;
/**
* The configuration settings of the nonce used in the login flow.
*/
nonce?: NonceResponse;
/**
* <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>.
*/
preserveUrlFragmentsForLogins?: boolean;
/**
* The routes that specify the endpoints used for login and logout requests.
*/
routes?: LoginRoutesResponse;
/**
* The configuration settings of the token store.
*/
tokenStore?: TokenStoreResponse;
}
/**
* The routes that specify the endpoints used for login and logout requests.
*/
export interface LoginRoutesResponse {
/**
* The endpoint at which a logout request should be made.
*/
logoutEndpoint?: string;
}
/**
* The configuration settings of the login flow, including the scopes that should be requested.
*/
export interface LoginScopesResponse {
/**
* A list of the scopes that should be requested while authenticating.
*/
scopes?: string[];
}
/**
* Managed service identity.
*/
export interface ManagedServiceIdentityResponse {
/**
* Principal Id of managed service identity.
*/
principalId: string;
/**
* Tenant of man