Azure.ResourceManager.AppService.Models Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| AbnormalTimePeriod |
Class representing Abnormal Time Period identified in diagnosis. |
| Address |
Address information for domain registration. |
| AddressResponse |
Describes main public IP address and any extra virtual IPs. |
| AllowedPrincipals |
The configuration settings of the Azure Active Directory allowed principals. |
| AnalysisData |
Class Representing Detector Evidence used for analysis. |
| AppInsightsWebAppStackSettings |
App Insights Web App stack settings. |
| Apple |
The configuration settings of the Apple provider. |
| AppleRegistration |
The configuration settings of the registration for the Apple provider. |
| ApplicationLogsConfig |
Application logs configuration. |
| ApplicationStack |
Application stack. |
| ApplicationStackResource |
ARM resource for a ApplicationStack. |
| AppLogsConfiguration |
The AppLogsConfiguration. |
| AppRegistration |
The configuration settings of the app registration for providers that have app ids and app secrets. |
| AppServiceCertificate |
Key Vault container for a certificate that is purchased through Azure. |
| AppServiceCertificateOrderPatch |
ARM resource for a certificate order that is purchased through Azure. |
| AppServiceCertificateResourcePatch |
Key Vault container ARM resource for a certificate that is purchased through Azure. |
| AppServiceDomainPatch |
ARM resource for a domain. |
| AppServiceEnvironmentAutoGenerated |
Description of an App Service Environment. |
| AppServiceEnvironmentPatch |
ARM resource for a app service environment. |
| AppServicePlanPatch |
ARM resource for a app service plan. |
| AppServicePrivateLinkResource |
A private link resource. |
| AppServicePrivateLinkResourceProperties |
Properties of a private link resource. |
| AppServiceRecommendation |
Represents a recommendation result generated by the recommendation engine. |
| AppServiceUsage |
Usage of the quota resource. |
| ArcConfiguration |
The ArcConfiguration. |
| ArmPlan |
The plan object in Azure Resource Manager, represents a marketplace plan. |
| AuthPlatform |
The configuration settings of the platform of App Service Authentication/Authorization. |
| AutoHealActions |
Actions which to take by the auto-heal module when a rule is triggered. |
| AutoHealCustomAction |
Custom action to be executed when an auto heal rule is triggered. |
| AutoHealRules |
Rules that can be defined for auto-heal. |
| AutoHealTriggers |
Triggers for auto-heal. |
| AzureActiveDirectory |
The configuration settings of the Azure Active directory provider. |
| AzureActiveDirectoryLogin |
The configuration settings of the Azure Active Directory login flow. |
| AzureActiveDirectoryRegistration |
The configuration settings of the Azure Active Directory app registration. |
| AzureActiveDirectoryValidation |
The configuration settings of the Azure Active Directory token validation flow. |
| AzureBlobStorageApplicationLogsConfig |
Application logs azure blob storage configuration. |
| AzureBlobStorageHttpLogsConfig |
Http logs to azure blob storage configuration. |
| AzureStaticWebApps |
The configuration settings of the Azure Static Web Apps provider. |
| AzureStorageInfoValue |
Azure Files or Blob Storage access information value for dictionary storage. |
| AzureStoragePropertyDictionaryResource |
AzureStorageInfo dictionary resource. |
| AzureTableStorageApplicationLogsConfig |
Application logs to Azure table storage configuration. |
| BackupRequest |
Description of a backup which will be performed. |
| BackupSchedule |
Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. |
| BillingMeter |
App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services. |
| Capability |
Describes the capabilities/features allowed for a specific SKU. |
| CertificateDetails |
SSL certificate details. |
| CertificateEmail |
SSL certificate email. |
| CertificateOrderAction |
Certificate order action. |
| CertificateOrderContact |
The CertificateOrderContact. |
| CertificatePatch |
ARM resource for a certificate. |
| ClientRegistration |
The configuration settings of the app registration for providers that have client ids and client secrets. |
| CloningInfo |
Information needed for cloning operation. |
| ConnectionStringDictionary |
String dictionary resource. |
| ConnStringInfo |
Database connection string information. |
| ConnStringValueTypePair |
Database connection string value to type pair. |
| ContactInformation |
Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements. |
| ContainerCpuStatistics |
The ContainerCpuStatistics. |
| ContainerCpuUsage |
The ContainerCpuUsage. |
| ContainerInfo |
The ContainerInfo. |
| ContainerMemoryStatistics |
The ContainerMemoryStatistics. |
| ContainerNetworkInterfaceStatistics |
The ContainerNetworkInterfaceStatistics. |
| ContainerThrottlingData |
The ContainerThrottlingData. |
| CookieExpiration |
The configuration settings of the session cookie's expiration. |
| CorsSettings |
Cross-Origin Resource Sharing (CORS) settings for the app. |
| CsmMoveResourceEnvelope |
Object with a list of the resources that need to be moved and the resource group they should be moved to. |
| CsmOperationDescription |
Description of an operation available for Microsoft.Web resource provider. |
| CsmOperationDisplay |
Meta data about operation used for display in portal. |
| CsmPublishingProfileOptions |
Publishing options for requested profile. |
| CsmSlotEntity |
Deployment slot parameters. |
| CsmUsageQuota |
Usage of the quota resource. |
| CustomHostnameAnalysisResult |
Custom domain analysis. |
| CustomOpenIdConnectProvider |
The configuration settings of the custom Open ID Connect provider. |
| DatabaseBackupSetting |
Database backup settings. |
| DataProviderMetadata |
Additional configuration for a data providers. |
| DataSource |
Class representing data source used by the detectors. |
| DataTableResponseColumn |
Column definition. |
| DataTableResponseObject |
Data Table which defines columns and raw row values. |
| DefaultAuthorizationPolicy |
The configuration settings of the Azure Active Directory default authorization policy. |
| DeletedAppRestoreRequest |
Details about restoring a deleted app. |
| DeploymentLocations |
List of available locations (regions or App Service Environments) for deployment of App Service resources. |
| DetectorAbnormalTimePeriod |
Class representing Abnormal Time Period detected. |
| DetectorDefinition |
Class representing detector definition. |
| DetectorInfo |
Definition of Detector. |
| DiagnosticAnalysis |
Class representing a diagnostic analysis done on an application. |
| DiagnosticData |
Set of data with rendering instructions. |
| DiagnosticDetectorResponse |
Class representing Response from Diagnostic Detectors. |
| DiagnosticMetricSample |
Class representing Diagnostic Metric. |
| DiagnosticMetricSet |
Class representing Diagnostic Metric information. |
| Dimension |
Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app, where instance name is dimension of the metric HTTP request |
| DomainAvailabilityCheckResult |
Domain availability check result. |
| DomainControlCenterSsoRequest |
Single sign-on request information for domain management. |
| DomainPurchaseConsent |
Domain purchase consent object, representing acceptance of applicable legal agreements. |
| DomainRecommendationSearchContent |
Domain recommendation search parameters. |
| EndpointDependency |
A domain name that a service is reached at, including details of the current connection status. |
| EndpointDetail |
Current TCP connectivity information from the App Service Environment to a single endpoint. |
|
The configuration settings of the Facebook provider. |
|
| FileSystemHttpLogsConfig |
Http logs to file system configuration. |
| ForwardProxy |
The configuration settings of a forward proxy used to make the requests. |
| FunctionAppMajorVersion |
Function App stack major version. |
| FunctionAppMinorVersion |
Function App stack minor version. |
| FunctionAppRuntimes |
Function App stack runtimes. |
| FunctionAppRuntimeSettings |
Function App runtime settings. |
| FunctionAppStack |
Function App Stack. |
| FunctionSecrets |
Function secrets. |
| GeoRegion |
Geographical region. |
| GitHub |
The configuration settings of the GitHub provider. |
| GitHubActionCodeConfiguration |
The GitHub action code configuration. |
| GitHubActionConfiguration |
The GitHub action configuration. |
| GitHubActionContainerConfiguration |
The GitHub action container configuration. |
| GitHubActionWebAppStackSettings |
GitHub Actions Web App stack settings. |
| GlobalCsmSkuDescription |
A Global SKU Description. |
| GlobalValidation |
The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. |
|
The configuration settings of the Google provider. |
|
| HandlerMapping |
The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension. |
| HostingEnvironmentDeploymentInfo |
Information needed to create resources on an App Service Environment. |
| HostingEnvironmentDiagnostics |
Diagnostics for an App Service Environment. |
| HostingEnvironmentProfile |
Specification for an App Service Environment to use for this resource. |
| HostKeys |
Functions host level keys. |
| HostName |
Details of a hostname derived from a domain. |
| HostNameSslState |
SSL-enabled hostname. |
| HttpLogsConfig |
Http logs configuration. |
| HttpSettings |
The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. |
| HybridConnectionKey |
Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection. |
| IdentityProviders |
The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. |
| InboundEnvironmentEndpoint |
The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment. |
| IPSecurityRestriction |
IP security restriction on an app. |
| JwtClaimChecks |
The configuration settings of the checks that should be made while validating the JWT Claims. |
| KeyInfo |
Function key info. |
| KeyValuePairStringObject |
The KeyValuePairStringObject. |
| KubeEnvironmentPatch |
ARM resource for a KubeEnvironment when patching. |
| KubeEnvironmentProfile |
Specification for a Kubernetes Environment to use for this resource. |
| LegacyMicrosoftAccount |
The configuration settings of the legacy Microsoft Account provider. |
| LinuxJavaContainerSettings |
Linux Java Container settings. |
| LocalizableString |
Localizable string object containing the name and a localized value. |
| LogAnalyticsConfiguration |
The LogAnalyticsConfiguration. |
| LoginInformation |
The configuration settings of the login flow of users using App Service Authentication/Authorization. |
| LogSpecification |
Log Definition of a single resource metric. |
| MetricAvailability |
Retention policy of a resource metric. |
| MetricSpecification |
Definition of a single resource metric. |
| MigrateMySqlContent |
MySQL migration request. |
| MsDeploy |
MSDeploy ARM PUT information. |
| MsDeployLog |
MSDeploy log. |
| MsDeployLogEntry |
MSDeploy log entry. |
| NameIdentifier |
Identifies an object. |
| NameValuePair |
Name value pair. |
| NetworkTrace |
Network trace. |
| Nonce |
The configuration settings of the nonce used in the login flow. |
| OpenIdConnectClientCredential |
The authentication client credentials of the custom Open ID Connect provider. |
| OpenIdConnectConfig |
The configuration settings of the endpoints used for the custom Open ID Connect provider. |
| OpenIdConnectLogin |
The configuration settings of the login flow of the custom Open ID Connect provider. |
| OpenIdConnectRegistration |
The configuration settings of the app registration for the custom Open ID Connect provider. |
| OperationInformation |
An operation on a resource. |
| OperationStatusAutoGenerated |
Identify the status of the most severe insight generated by the detector. |
| OutboundEnvironmentEndpoint |
Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to. |
| PerfMonResponse |
Performance monitor API response. |
| PerfMonSample |
Performance monitor sample in a set. |
| PerfMonSet |
Metric information. |
| PremierAddOnOffer |
Premier add-on offer. |
| PremierAddOnPatchResource |
ARM resource for a PremierAddOn. |
| PrivateAccessSubnet |
Description of a Virtual Network subnet that is useable for private site access. |
| PrivateAccessVirtualNetwork |
Description of a Virtual Network that is useable for private site access. |
| PrivateLinkConnectionApprovalRequestResource |
Private Endpoint Connection Approval ARM resource. |
| PrivateLinkConnectionState |
The state of a private link connection. |
| ProcessThreadInfo |
Process Thread Information. |
| PushSettings |
Push settings for the App. |
| QueryUtterancesResult |
Result for utterances query. |
| QueryUtterancesResults |
Suggested utterances where the detector can be applicable. |
| RampUpRule |
Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. |
| ReissueCertificateOrderContent |
Class representing certificate reissue request. |
| RemotePrivateEndpointConnection |
A remote private endpoint connection. |
| Rendering |
Instructions for rendering the data. |
| RenewCertificateOrderContent |
Class representing certificate renew request. |
| RequestsBasedTrigger |
Trigger based on total requests. |
| ResourceMetricAvailability |
Metrics availability and retention. |
| ResourceMetricDefinition |
Metadata for the metrics. |
| ResourceNameAvailability |
Information regarding availability of a resource name. |
| ResourceNameAvailabilityContent |
Resource name availability request content. |
| ResponseMessageEnvelopeRemotePrivateEndpointConnection |
Message envelope that contains the common Azure resource manager properties and the resource provider specific content. |
| RestoreRequest |
Description of a restore request. |
| SampleUtterance |
Sample utterance. |
| ServiceSpecification |
Resource metrics service provided by Microsoft.Insights resource provider. |
| SiteAuthSettings |
Configuration settings for the Azure App Service Authentication / Authorization feature. |
| SiteAuthSettingsV2 |
Configuration settings for the Azure App Service Authentication / Authorization V2 feature. |
| SiteCloneability |
Represents whether or not an app is cloneable. |
| SiteCloneabilityCriterion |
An app cloneability criterion. |
| SiteConfigProperties |
Configuration of an App Service app. |
| SiteConfigPropertiesDictionary |
Site config properties dictionary. |
| SiteConfigurationSnapshotInfo |
A snapshot of a web app configuration. |
| SiteLimits |
Metric limits set on an app. |
| SiteMachineKey |
MachineKey of an app. |
| SitePatchResource |
ARM resource for a site. |
| SitePhpErrorLogFlag |
Used for getting PHP error logging flag. |
| SiteSeal |
Site seal. |
| SiteSealContent |
Site seal request. |
| SkuCapacity |
Description of the App Service plan scale options. |
| SkuDescription |
Description of a SKU for a scalable resource. |
| SkuInfo |
SKU discovery information. |
| SkuInfos |
Collection of SKU information. |
| SlotDifference |
A setting difference between two deployment slots of an app. |
| SlotSwapStatus |
The status of the last successful slot swap operation. |
| SlowRequestsBasedTrigger |
Trigger based on request execution time. |
| Snapshot |
A snapshot of an app. |
| SnapshotRecoverySource |
Specifies the web app that snapshot contents will be retrieved from. |
| SnapshotRestoreRequest |
Details about app recovery operation. |
| Solution |
Class Representing Solution for problems detected. |
| StackMajorVersion |
Application stack major version. |
| StackMinorVersion |
Application stack minor version. |
| StampCapacity |
Stamp capacity information. |
| StaticSiteARMResourcePatch |
ARM resource for a static site when patching. |
| StaticSiteBuildProperties |
Build properties for the static site. |
| StaticSiteCustomDomainRequestPropertiesARMResource |
Static Site Custom Domain Request Properties ARM resource. |
| StaticSiteFunctionOverviewARMResource |
Static Site Function Overview ARM resource. |
| StaticSiteResetPropertiesARMResource |
Static Site Reset Properties ARM resource. |
| StaticSitesWorkflowPreview |
Preview for the Static Site Workflow to be generated. |
| StaticSitesWorkflowPreviewContent |
Request entity for previewing the Static Site workflow. |
| StaticSiteTemplateOptions |
Template Options for the static site. |
| StaticSiteUserARMResource |
Static Site User ARM resource. |
| StaticSiteUserInvitationRequestResource |
Static sites user roles invitation resource. |
| StaticSiteUserInvitationResponseResource |
Static sites user roles invitation link resource. |
| StaticSiteUserProvidedFunctionApp |
A static site user provided function. |
| StaticSiteZipDeploymentARMResource |
Static site zip deployment ARM resource. |
| StatusCodesBasedTrigger |
Trigger based on status code. |
| StatusCodesRangeBasedTrigger |
Trigger based on range of status codes. |
| StorageMigrationContent |
Options for app content migration. |
| StorageMigrationResponse |
Response for a migration of app content request. |
| StringDictionary |
String dictionary resource. |
| StringList |
String list resource. |
| SupportTopic |
Defines a unique Support Topic. |
| TldLegalAgreement |
Legal agreement for a top level domain. |
| TokenStore |
The configuration settings of the token store. |
| TopLevelDomainAgreementOption |
Options for retrieving the list of top level domain legal agreements. |
| TriggeredJobRun |
Triggered Web Job Run Information. |
|
The configuration settings of the Twitter provider. |
|
| TwitterRegistration |
The configuration settings of the app registration for the Twitter provider. |
| ValidateContent |
Resource validation request content. |
| ValidateResponse |
Describes the result of resource validation. |
| ValidateResponseError |
Error details for when validation fails. |
| VirtualApplication |
Virtual application in an app. |
| VirtualDirectory |
Directory for virtual application. |
| VirtualIPMapping |
Virtual IP mapping. |
| VirtualNetworkProfile |
Specification for using a Virtual Network. |
| VnetContent |
The required set of inputs to validate a VNET. |
| VnetInfo |
Virtual Network information contract. |
| VnetRoute |
Virtual Network route contract used to pass routing information for a Virtual Network. |
| VnetValidationFailureDetails |
A class that describes the reason for a validation failure. |
| VnetValidationTestFailure |
A class that describes a test that failed during NSG and UDR validation. |
| WebAppMajorVersion |
Web App stack major version. |
| WebAppMinorVersion |
Web App stack minor version. |
| WebAppRuntimes |
Web App stack runtimes. |
| WebAppRuntimeSettings |
Web App runtime settings. |
| WebAppStack |
Web App stack. |
| WindowsJavaContainerSettings |
Windows Java Container settings. |
Structs
| AppServiceCertificateNotRenewableReason |
The AppServiceCertificateNotRenewableReason. |
| AppServiceDomainPropertiesDomainNotRenewableReasonsItem |
The AppServiceDomainPropertiesDomainNotRenewableReasonsItem. |
| AppServiceSkuName |
The AppServiceSkuName. |
| BuildStatus |
The status of the static site build. |
| CheckNameResourceType |
Resource type used for verification. |
| ClientCredentialMethod |
The method that should be used to authenticate the user. |
| ConfigReferenceSource |
The ConfigReferenceSource. |
| CustomDomainStatus |
The status of the custom domain. |
| DatabaseType |
Database type (e.g. SqlAzure / MySql). |
| DomainNotRenewableReason |
The DomainNotRenewableReason. |
| FtpsState |
State of FTP / FTPS service. |
| InAvailabilityReasonType |
<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. |
| IPFilterTag |
Defines what this IP filter will be used for. This is to support IP filtering on proxies. |
| LoadBalancingMode |
Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. |
| ProviderOSTypeSelected |
The ProviderOSTypeSelected. |
| ProviderStackOSType |
The ProviderStackOSType. |
| PublishingProfileFormat |
Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp |
| ResourceScopeType |
Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. |
| RouteType |
The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only These values will be used for syncing an app's routes with those from a Virtual Network. |
| ScmType |
SCM type. |
| SupportedTlsVersion |
MinTlsVersion: configures the minimum version of TLS required for SSL requests. |
| TriggerType |
The trigger type of the function. |
| ValidateResourceType |
Resource type used for verification. |
Enums
| AppServicePlanRestriction |
App Service plans this offer is restricted to. |
| AutoHealActionType |
Predefined action to be taken. |
| AzureResourceType |
Type of the Azure resource the hostname is assigned to. |
| AzureStorageState |
State of the storage account. |
| AzureStorageType |
Type of storage. |
| BackupItemStatus |
Backup status. |
| BackupRestoreOperationType |
Operation type. |
| BuiltInAuthenticationProvider |
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". |
| CertificateOrderActionType |
Action type. |
| CertificateOrderStatus |
Current order status. |
| CertificateProductType |
Certificate product type. |
| Channel |
List of channels that this recommendation can apply. |
| ClientCertMode |
This composes with ClientCertEnabled setting.
|
| CloneAbilityResult |
Name of app. |
| ComputeModeOption |
Shared/dedicated workers. |
| ConnectionStringType |
Type of database. |
| ContinuousWebJobStatus |
Job status. |
| CookieExpirationConvention |
The convention used when determining the session cookie's expiration. |
| CustomHostNameDnsRecordType |
Type of the DNS record. |
| DetectorType |
Whether this detector is an Analysis Detector or not. |
| DnsType |
Current DNS type. |
| DnsVerificationTestResult |
DNS verification test result. |
| DomainStatus |
Domain registration status. |
| DomainType |
Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything. |
| ForwardProxyConvention |
The convention used to determine the url of the request made. |
| FrequencyUnit |
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). |
| FrontEndServiceType |
The FrontEndServiceType. |
| HostingEnvironmentStatus |
Current status of the App Service Environment. |
| HostNameType |
Type of the hostname. |
| HostType |
Indicates whether the hostname is a standard or repository hostname. |
| InsightStatus |
Level of the most severe insight generated by the detector. |
| IssueType |
Represents the type of the Detector. |
| KeyVaultSecretStatus |
Status of the Key Vault secret. |
| KubeEnvironmentProvisioningState |
Provisioning state of the Kubernetes Environment. |
| LogLevel |
Log level. |
| ManagedPipelineMode |
Managed pipeline mode. |
| MSDeployLogEntryType |
Log entry type. |
| MSDeployProvisioningState |
Provisioning state. |
| MySqlMigrationType |
The type of migration operation to be done. |
| NotificationLevel |
Level indicating how critical this recommendation can impact. |
| OperationStatus |
The current status of the operation. |
| ProvisioningState |
Status of certificate order. |
| PublicCertificateLocation |
Public Certificate Location. |
| RedundancyMode |
Site redundancy mode. |
| RenderingType |
Rendering Type. |
| ResolveStatus |
The ResolveStatus. |
| SiteAvailabilityState |
Management information availability state for the app. |
| SiteExtensionType |
Site extension type. |
| SiteLoadBalancing |
Site load balancing. |
| SiteRuntimeState |
The SiteRuntimeState. |
| SolutionType |
Type of Solution. |
| SslState |
SSL type. |
| StackPreferredOS |
Function App stack preferred OS. |
| StagingEnvironmentPolicy |
State indicating whether staging environments are allowed or not allowed for a static web app. |
| StatusOption |
App Service plan status. |
| StorageType |
The StorageType. |
| TriggeredWebJobStatus |
Job status. |
| UnauthenticatedClientAction |
The action to take when an unauthenticated client attempts to access the app. |
| UnauthenticatedClientActionV2 |
The action to take when an unauthenticated client attempts to access the app. |
| UsageState |
State indicating whether the app has exceeded its quota usage. Read-only. |
| WebJobType |
Job type. |
| WorkerSizeOption |
Size of the machines. |
Feedback
Submit and view feedback for