models Package
Classes
ApiDefinitionInfo |
Information about the formal API definition for the app. |
ApplicationLogsConfig |
Application logs configuration. |
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. |
AzureBlobStorageApplicationLogsConfig |
Application logs azure blob storage configuration. |
AzureBlobStorageHttpLogsConfig |
Http logs to azure blob storage configuration. |
AzureTableStorageApplicationLogsConfig |
Application logs to Azure table storage configuration. All required parameters must be populated in order to send to server. |
BackupItem |
Backup description. Variables are only populated by the server, and will be ignored when sending a request. |
BackupItemCollection |
Collection of backup items. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
BackupRequest |
Description of a backup which will be performed. Variables are only populated by the server, and will be ignored when sending a request. |
BackupSchedule |
Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
CloningInfo |
Information needed for cloning operation. All required parameters must be populated in order to send to server. /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. Required. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. # pylint: disable=line-too-long :vartype traffic_manager_profile_id: str :ivar traffic_manager_profile_name: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. /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. Required. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. # pylint: disable=line-too-long :paramtype traffic_manager_profile_id: str :keyword traffic_manager_profile_name: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. |
ConnStringInfo |
Database connection string information. |
ConnStringValueTypePair |
Database connection string value to type pair. All required parameters must be populated in order to send to server. |
ConnectionStringDictionary |
String dictionary resource. Variables are only populated by the server, and will be ignored when sending a request. |
ContinuousWebJob |
Continuous Web Job Information. Variables are only populated by the server, and will be ignored when sending a request. |
ContinuousWebJobCollection |
Collection of Kudu continuous web job information elements. All required parameters must be populated in order to send to server. |
CorsSettings |
Cross-Origin Resource Sharing (CORS) settings for the app. |
CsmPublishingProfileOptions |
Publishing options for requested profile. |
CsmSlotEntity |
Deployment slot parameters. All required parameters must be populated in order to send to server. |
CsmUsageQuota |
Usage of the quota resource. |
CsmUsageQuotaCollection |
Collection of CSM usage quotas. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
CustomHostnameAnalysisResult |
Custom domain analysis. Variables are only populated by the server, and will be ignored when sending a request. |
DatabaseBackupSetting |
Database backup settings. All required parameters must be populated in order to send to server. |
Deployment |
User credentials used for publishing activity. Variables are only populated by the server, and will be ignored when sending a request. |
DeploymentCollection |
Collection of app deployments. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
EnabledConfig |
Enabled configuration. |
ErrorEntity |
Body of the error response returned from the API. |
Experiments |
Routing rules in production experiments. |
FileSystemApplicationLogsConfig |
Application logs to file system configuration. |
FileSystemHttpLogsConfig |
Http logs to file system configuration. |
FunctionEnvelope |
Web Job Information. Variables are only populated by the server, and will be ignored when sending a request. |
FunctionEnvelopeCollection |
Collection of Kudu function information elements. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
FunctionSecrets |
Function secrets. Variables are only populated by the server, and will be ignored when sending a request. |
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. |
HostNameBinding |
A hostname binding object. Variables are only populated by the server, and will be ignored when sending a request. |
HostNameBindingCollection |
Collection of hostname bindings. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
HostNameSslState |
SSL-enabled hostname. |
HostingEnvironmentProfile |
Specification for an App Service Environment to use for this resource. Variables are only populated by the server, and will be ignored when sending a request. |
HttpLogsConfig |
Http logs configuration. |
HybridConnection |
Hybrid Connection contract. This is used to configure a Hybrid Connection. Variables are only populated by the server, and will be ignored when sending a request. |
HybridConnectionKey |
Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection. Variables are only populated by the server, and will be ignored when sending a request. |
Identifier |
A domain specific resource identifier. Variables are only populated by the server, and will be ignored when sending a request. |
IdentifierCollection |
Collection of identifiers. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
IpSecurityRestriction |
IP security restriction on an app. All required parameters must be populated in order to send to server. |
LocalizableString |
Localizable string object containing the name and a localized value. |
MSDeploy |
MSDeploy ARM PUT information. Variables are only populated by the server, and will be ignored when sending a request. |
MSDeployLog |
MSDeploy log. Variables are only populated by the server, and will be ignored when sending a request. |
MSDeployLogEntry |
MSDeploy log entry. Variables are only populated by the server, and will be ignored when sending a request. |
MSDeployStatus |
MSDeploy ARM response. Variables are only populated by the server, and will be ignored when sending a request. |
ManagedServiceIdentity |
Managed service identity. Variables are only populated by the server, and will be ignored when sending a request. |
MigrateMySqlRequest |
MySQL migration request. Variables are only populated by the server, and will be ignored when sending a request. |
MigrateMySqlStatus |
MySQL migration status. Variables are only populated by the server, and will be ignored when sending a request. |
NameValuePair |
Name value pair. |
NetworkFeatures |
Full view of network features for an app (presently VNET integration and Hybrid Connections). Variables are only populated by the server, and will be ignored when sending a request. |
Operation |
An operation on a resource. |
PerfMonCounterCollection |
Collection of performance monitor counters. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
PerfMonResponse |
Performance monitor API response. |
PerfMonSample |
Performance monitor sample in a set. |
PerfMonSet |
Metric information. |
PremierAddOn |
Premier add-on. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
ProcessInfo |
Process Information. Variables are only populated by the server, and will be ignored when sending a request. |
ProcessInfoCollection |
Collection of Kudu process information elements. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
ProcessModuleInfo |
Process Module Information. Variables are only populated by the server, and will be ignored when sending a request. |
ProcessModuleInfoCollection |
Collection of Kudu thread information elements. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
ProcessThreadInfo |
Process Thread Information. Variables are only populated by the server, and will be ignored when sending a request. |
ProcessThreadInfoCollection |
Collection of Kudu thread information elements. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
ProxyOnlyResource |
Azure proxy only resource. This resource is not tracked by Azure Resource Manager. Variables are only populated by the server, and will be ignored when sending a request. |
PublicCertificate |
Public certificate object. Variables are only populated by the server, and will be ignored when sending a request. |
PublicCertificateCollection |
Collection of public certificates. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
PushSettings |
Push settings for the App. Variables are only populated by the server, and will be ignored when sending a request. |
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. |
RelayServiceConnectionEntity |
Hybrid Connection for an App Service app. Variables are only populated by the server, and will be ignored when sending a request. |
RequestsBasedTrigger |
Trigger based on total requests. |
Resource |
Azure resource. This resource is tracked in Azure Resource Manager. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
ResourceMetric |
Object representing a metric for any resource . Variables are only populated by the server, and will be ignored when sending a request. |
ResourceMetricAvailability |
Metrics availability and retention. Variables are only populated by the server, and will be ignored when sending a request. |
ResourceMetricCollection |
Collection of metric responses. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
ResourceMetricDefinition |
Metadata for the metrics. Variables are only populated by the server, and will be ignored when sending a request. |
ResourceMetricDefinitionCollection |
Collection of metric definitions. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
ResourceMetricName |
Name of a metric for any resource . Variables are only populated by the server, and will be ignored when sending a request. |
ResourceMetricProperty |
Resource metric property. |
ResourceMetricValue |
Value of resource metric. Variables are only populated by the server, and will be ignored when sending a request. |
RestoreRequest |
Description of a restore request. Variables are only populated by the server, and will be ignored when sending a request. |
RestoreResponse |
Response for an app restore request. Variables are only populated by the server, and will be ignored when sending a request. |
Site |
A web app, a mobile app backend, or an API app. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
SiteAuthSettings |
Configuration settings for the Azure App Service Authentication / Authorization feature. Variables are only populated by the server, and will be ignored when sending a request. |
SiteCloneability |
Represents whether or not an app is cloneable. |
SiteCloneabilityCriterion |
An app cloneability criterion. |
SiteConfig |
Configuration of an App Service app. Variables are only populated by the server, and will be ignored when sending a request. |
SiteConfigResource |
Web app configuration ARM resource. Variables are only populated by the server, and will be ignored when sending a request. |
SiteConfigResourceCollection |
Collection of site configurations. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
SiteConfigurationSnapshotInfo |
A snapshot of a web app configuration. Variables are only populated by the server, and will be ignored when sending a request. |
SiteConfigurationSnapshotInfoCollection |
Collection of metadata for the app configuration snapshots that can be restored. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
SiteExtensionInfo |
Site Extension Information. Variables are only populated by the server, and will be ignored when sending a request. |
SiteExtensionInfoCollection |
Collection of Kudu site extension information elements. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
SiteInstance |
Instance of an app. Variables are only populated by the server, and will be ignored when sending a request. |
SiteLimits |
Metric limits set on an app. |
SiteLogsConfig |
Configuration of App Service site logs. Variables are only populated by the server, and will be ignored when sending a request. |
SiteMachineKey |
MachineKey of an app. |
SitePatchResource |
ARM resource for a site. Variables are only populated by the server, and will be ignored when sending a request. |
SitePhpErrorLogFlag |
Used for getting PHP error logging flag. Variables are only populated by the server, and will be ignored when sending a request. |
SiteSourceControl |
Source control configuration for an app. Variables are only populated by the server, and will be ignored when sending a request. |
SlotConfigNamesResource |
Slot Config names azure resource. Variables are only populated by the server, and will be ignored when sending a request. |
SlotDifference |
A setting difference between two deployment slots of an app. Variables are only populated by the server, and will be ignored when sending a request. |
SlotDifferenceCollection |
Collection of slot differences. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
SlotSwapStatus |
The status of the last successful slot swap operation. Variables are only populated by the server, and will be ignored when sending a request. |
SlowRequestsBasedTrigger |
Trigger based on request execution time. |
Snapshot |
A snapshot of an app. Variables are only populated by the server, and will be ignored when sending a request. |
SnapshotCollection |
Collection of snapshots which can be used to revert an app to a previous time. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
SnapshotRecoveryRequest |
Details about app recovery operation. Variables are only populated by the server, and will be ignored when sending a request. |
SnapshotRecoveryTarget |
Specifies the web app that snapshot contents will be written to. /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. /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. |
StatusCodesBasedTrigger |
Trigger based on status code. |
StorageMigrationOptions |
Options for app content migration. Variables are only populated by the server, and will be ignored when sending a request. |
StorageMigrationResponse |
Response for a migration of app content request. Variables are only populated by the server, and will be ignored when sending a request. |
StringDictionary |
String dictionary resource. Variables are only populated by the server, and will be ignored when sending a request. |
TriggeredJobHistory |
Triggered Web Job History. List of Triggered Web Job Run Information elements. Variables are only populated by the server, and will be ignored when sending a request. |
TriggeredJobHistoryCollection |
Collection of Kudu continuous web job information elements. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
TriggeredJobRun |
Triggered Web Job Run Information. Variables are only populated by the server, and will be ignored when sending a request. |
TriggeredWebJob |
Triggered Web Job Information. Variables are only populated by the server, and will be ignored when sending a request. |
TriggeredWebJobCollection |
Collection of Kudu continuous web job information elements. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
User |
User credentials used for publishing activity. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualApplication |
Virtual application in an app. |
VirtualDirectory |
Directory for virtual application. |
VnetGateway |
The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package. Variables are only populated by the server, and will be ignored when sending a request. |
VnetInfo |
Virtual Network information contract. Variables are only populated by the server, and will be ignored when sending a request. |
VnetRoute |
Virtual Network route contract used to pass routing information for a Virtual Network. Variables are only populated by the server, and will be ignored when sending a request. |
WebAppCollection |
Collection of App Service apps. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
WebAppInstanceCollection |
Collection of app instances. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
WebJob |
Web Job Information. Variables are only populated by the server, and will be ignored when sending a request. |
WebJobCollection |
Collection of Kudu web job information elements. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server. |
Enums
AutoHealActionType |
Predefined action to be taken. |
AzureResourceType |
Azure resource type. |
BackupItemStatus |
Backup status. |
BackupRestoreOperationType |
Type of the backup. |
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". |
CloneAbilityResult |
Name of app. |
ConnectionStringType |
Type of database. |
ContinuousWebJobStatus |
Job status. |
CustomHostNameDnsRecordType |
Custom DNS record type. |
DatabaseType |
Database type (e.g. SqlAzure / MySql). |
DnsVerificationTestResult |
DNS verification test result. |
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). |
HostNameType |
Hostname type. |
HostType |
Indicates whether the hostname is a standard or repository hostname. |
LogLevel |
Log level. |
MSDeployLogEntryType |
Log entry type. |
MSDeployProvisioningState |
Provisioning state. |
ManagedPipelineMode |
Managed pipeline mode. |
ManagedServiceIdentityType |
Type of managed service identity. |
MySqlMigrationType |
The type of migration operation to be done. |
OperationStatus |
The current status of the operation. |
PublicCertificateLocation |
Public Certificate Location. |
PublishingProfileFormat |
Name of the format. Valid values are: FileZilla3 WebDeploy – default Ftp. |
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. |
SiteAvailabilityState |
Management information availability state for the app. |
SiteExtensionType |
Site extension type. |
SiteLoadBalancing |
Site load balancing. |
SslState |
SSL type. |
SupportedTlsVersions |
MinTlsVersion: configures the minimum version of TLS required for SSL requests. |
TriggeredWebJobStatus |
Job status. |
UnauthenticatedClientAction |
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. |
Azure SDK for Python