swagger: '2.0' info: title: Azure Functions Management API description: REST API for managing Azure Function Apps and Azure Functions resources. version: '2022-09-01' host: management.azure.com schemes: - https basePath: / consumes: - application/json produces: - application/json paths: /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites: get: description: Description for Get all apps for a subscription. operationId: WebApps_List parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: description: Collection of App Service apps. properties: nextLink: description: Link to next page of resources. readOnly: true type: string value: description: Collection of resources. items: allOf: - description: Azure resource. This resource is tracked in Azure Resource Manager properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string location: description: Resource Location. type: string name: description: Resource Name. readOnly: true type: string tags: additionalProperties: type: string description: Resource tags. type: object type: description: Resource type. readOnly: true type: string required: - location x-ms-azure-resource: true description: A web app, a mobile app backend, or an API app. properties: identity: description: Managed service identity. properties: principalId: description: Principal Id of managed service identity. readOnly: true type: string tenantId: description: Tenant of managed service identity. readOnly: true type: string type: description: Type of managed service identity. enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: modelAsString: false name: ManagedServiceIdentityType userAssignedIdentities: additionalProperties: properties: clientId: description: Client Id of user assigned identity readOnly: true type: string principalId: description: Principal Id of user assigned identity readOnly: true type: string type: object description: "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" type: object type: object properties: description: Site resource specific properties properties: availabilityState: description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode readOnly: true type: string x-ms-enum: modelAsString: false name: SiteAvailabilityState clientAffinityEnabled: description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. type: boolean clientCertEnabled: description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. type: boolean clientCertExclusionPaths: description: client certificate authentication comma-separated exclusion paths type: string cloningInfo: description: Information needed for cloning operation. properties: appSettingsOverrides: additionalProperties: type: string description: "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained." type: object cloneCustomHostNames: description: true to clone custom hostnames from source app; otherwise, false. type: boolean cloneSourceControl: description: true to clone source control from source app; otherwise, false. type: boolean configureLoadBalancing: description: true to configure load balancing for source and destination app. type: boolean correlationId: description: "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot." example: 00000000-0000-0000-0000-000000000000 format: uuid type: string hostingEnvironment: description: App Service Environment. type: string overwrite: description: true to overwrite destination app; otherwise, false. type: boolean sourceWebAppId: description: "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots." type: string sourceWebAppLocation: description: 'Location of source app ex: West US or North Europe' type: string trafficManagerProfileId: description: "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}." type: string trafficManagerProfileName: description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. type: string required: - sourceWebAppId type: object containerSize: description: Size of the function container. format: int32 type: integer dailyMemoryTimeQuota: description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). format: int32 type: integer defaultHostName: description: Default hostname of the app. Read-only. readOnly: true type: string enabled: description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). type: boolean enabledHostNames: description: "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames." items: type: string readOnly: true type: array hostNameSslStates: description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. items: description: SSL-enabled hostname. properties: hostType: description: Indicates whether the hostname is a standard or repository hostname. enum: - Standard - Repository type: string x-ms-enum: modelAsString: false name: HostType name: description: Hostname. type: string sslState: description: SSL type. enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: modelAsString: false name: SslState thumbprint: description: SSL certificate thumbprint. type: string toUpdate: description: Set to true to update existing hostname. type: boolean virtualIP: description: Virtual IP address assigned to the hostname if IP based SSL is enabled. type: string type: object type: array hostNames: description: Hostnames associated with the app. items: type: string readOnly: true type: array hostNamesDisabled: description: "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process." type: boolean hostingEnvironmentProfile: description: Specification for an App Service Environment to use for this resource. properties: id: description: Resource ID of the App Service Environment. type: string name: description: Name of the App Service Environment. readOnly: true type: string type: description: Resource type of the App Service Environment. readOnly: true type: string type: object httpsOnly: description: "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests" type: boolean hyperV: default: false description: Hyper-V sandbox. type: boolean x-ms-mutability: - create - read inProgressOperationId: description: Specifies an operation id if this site has a pending operation. example: 00000000-0000-0000-0000-000000000000 format: uuid readOnly: true type: string isDefaultContainer: description: true if the app is a default container; otherwise, false. readOnly: true type: boolean isXenon: default: false description: 'Obsolete: Hyper-V sandbox.' type: boolean x-ms-mutability: - create - read lastModifiedTimeUtc: description: Last time the app was modified, in UTC. Read-only. format: date-time readOnly: true type: string maxNumberOfWorkers: description: "Maximum number of workers.\nThis only applies to Functions container." format: int32 readOnly: true type: integer outboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. readOnly: true type: string possibleOutboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. readOnly: true type: string redundancyMode: description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant type: string x-ms-enum: modelAsString: false name: RedundancyMode repositorySiteName: description: Name of the repository site. readOnly: true type: string reserved: default: false description: true if reserved; otherwise, false. type: boolean x-ms-mutability: - create - read resourceGroup: description: Name of the resource group the app belongs to. Read-only. readOnly: true type: string scmSiteAlsoStopped: default: false description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. type: boolean serverFarmId: description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' type: string siteConfig: description: Configuration of an App Service app. properties: alwaysOn: description: true if Always On is enabled; otherwise, false. type: boolean apiDefinition: description: Information about the formal API definition for the app. properties: url: description: The URL of the API definition. type: string type: object apiManagementConfig: description: Azure API management (APIM) configuration linked to the app. properties: id: description: APIM-Api Identifier. type: string type: object appCommandLine: description: App command line to launch. type: string appSettings: description: Application settings. items: description: Name value pair. properties: name: description: Pair name. type: string value: description: Pair value. type: string type: object type: array autoHealEnabled: description: true if Auto Heal is enabled; otherwise, false. type: boolean autoHealRules: description: Rules that can be defined for auto-heal. properties: actions: description: Actions which to take by the auto-heal module when a rule is triggered. properties: actionType: description: Predefined action to be taken. enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: modelAsString: false name: AutoHealActionType customAction: description: "Custom action to be executed\nwhen an auto heal rule is triggered." properties: exe: description: Executable to be run. type: string parameters: description: Parameters for the executable. type: string type: object minProcessExecutionTime: description: "Minimum time the process must execute\nbefore taking the action" type: string type: object triggers: description: Triggers for auto-heal. properties: privateBytesInKB: description: A rule based on private bytes. format: int32 type: integer requests: description: Trigger based on total requests. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string type: object slowRequests: description: Trigger based on request execution time. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string timeTaken: description: Time taken. type: string type: object statusCodes: description: A rule based on status codes. items: description: Trigger based on status code. properties: count: description: Request Count. format: int32 type: integer status: description: HTTP status code. format: int32 type: integer subStatus: description: Request Sub Status. format: int32 type: integer timeInterval: description: Time interval. type: string win32Status: description: Win32 error code. format: int32 type: integer type: object type: array type: object type: object autoSwapSlotName: description: Auto-swap slot name. type: string connectionStrings: description: Connection strings. items: description: Database connection string information. properties: connectionString: description: Connection string value. type: string name: description: Name of connection string. type: string type: description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL type: string x-ms-enum: modelAsString: false name: ConnectionStringType type: object type: array cors: description: Cross-Origin Resource Sharing (CORS) settings for the app. properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all." items: type: string type: array supportCredentials: description: "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\n\ for more details." type: boolean type: object defaultDocuments: description: Default documents. items: type: string type: array detailedErrorLoggingEnabled: description: true if detailed error logging is enabled; otherwise, false. type: boolean documentRoot: description: Document root. type: string experiments: description: Routing rules in production experiments. properties: rampUpRules: description: List of ramp-up rules. items: description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. properties: actionHostName: description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. type: string changeDecisionCallbackUrl: description: "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/" type: string changeIntervalInMinutes: description: Specifies interval in minutes to reevaluate ReroutePercentage. format: int32 type: integer changeStep: description: "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or\ \ \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \n\ can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl." format: double type: number maxReroutePercentage: description: Specifies upper boundary below which ReroutePercentage will stay. format: double type: number minReroutePercentage: description: Specifies lower boundary above which ReroutePercentage will stay. format: double type: number name: description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string reroutePercentage: description: Percentage of the traffic which will be redirected to ActionHostName. format: double type: number type: object type: array type: object ftpsState: description: State of FTP / FTPS service enum: - AllAllowed - FtpsOnly - Disabled type: string x-ms-enum: modelAsString: true name: FtpsState handlerMappings: description: Handler mappings. items: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." properties: arguments: description: Command-line arguments to be passed to the script processor. type: string extension: description: Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string type: object type: array healthCheckPath: description: Health check path type: string http20Enabled: default: true description: 'Http20Enabled: configures a web site to allow clients to connect over http2.0' type: boolean httpLoggingEnabled: description: true if HTTP logging is enabled; otherwise, false. type: boolean ipSecurityRestrictions: description: IP security restrictions for main. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array javaContainer: description: Java container. type: string javaContainerVersion: description: Java container version. type: string javaVersion: description: Java version. type: string limits: description: Metric limits set on an app. properties: maxDiskSizeInMb: description: Maximum allowed disk size usage in MB. format: int64 type: integer maxMemoryInMb: description: Maximum allowed memory usage in MB. format: int64 type: integer maxPercentageCpu: description: Maximum allowed CPU usage percentage. format: double type: number type: object linuxFxVersion: description: Linux App Framework and version type: string loadBalancing: description: Site load balancing. enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: modelAsString: false name: SiteLoadBalancing localMySqlEnabled: default: false description: true to enable local MySQL; otherwise, false. type: boolean logsDirectorySizeLimit: description: HTTP logs directory size limit. format: int32 type: integer machineKey: description: MachineKey of an app. properties: decryption: description: Algorithm used for decryption. type: string decryptionKey: description: Decryption key. type: string validation: description: MachineKey validation. type: string validationKey: description: Validation key. type: string type: object managedPipelineMode: description: Managed pipeline mode. enum: - Integrated - Classic type: string x-ms-enum: modelAsString: false name: ManagedPipelineMode managedServiceIdentityId: description: Managed Service Identity Id format: int32 type: integer minTlsVersion: description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' enum: - '1.0' - '1.1' - '1.2' type: string x-ms-enum: modelAsString: true name: SupportedTlsVersions netFrameworkVersion: default: v4.6 description: .NET Framework version. type: string nodeVersion: description: Version of Node.js. type: string numberOfWorkers: description: Number of workers. format: int32 type: integer phpVersion: description: Version of PHP. type: string preWarmedInstanceCount: description: "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans" format: int32 maximum: 10 minimum: 0 type: integer publishingUsername: description: Publishing user name. type: string push: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object pythonVersion: description: Version of Python. type: string remoteDebuggingEnabled: description: true if remote debugging is enabled; otherwise, false. type: boolean remoteDebuggingVersion: description: Remote debugging version. type: string requestTracingEnabled: description: true if request tracing is enabled; otherwise, false. type: boolean requestTracingExpirationTime: description: Request tracing expiration time. format: date-time type: string scmIpSecurityRestrictions: description: IP security restrictions for scm. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array scmIpSecurityRestrictionsUseMain: description: IP security restrictions for scm to use main. type: boolean scmType: description: SCM type. enum: - None - Dropbox - Tfs - LocalGit - GitHub - CodePlexGit - CodePlexHg - BitbucketGit - BitbucketHg - ExternalGit - ExternalHg - OneDrive - VSO - VSTSRM type: string x-ms-enum: modelAsString: true name: ScmType tracingOptions: description: Tracing options. type: string use32BitWorkerProcess: description: true to use 32-bit worker process; otherwise, false. type: boolean virtualApplications: description: Virtual applications. items: description: Virtual application in an app. properties: physicalPath: description: Physical path. type: string preloadEnabled: description: true if preloading is enabled; otherwise, false. type: boolean virtualDirectories: description: Virtual directories for virtual application. items: description: Directory for virtual application. properties: physicalPath: description: Physical path. type: string virtualPath: description: Path to virtual application. type: string type: object type: array virtualPath: description: Virtual path. type: string type: object type: array vnetName: description: Virtual Network name. type: string x-ms-mutability: - create - read webSocketsEnabled: description: true if WebSocket is enabled; otherwise, false. type: boolean windowsFxVersion: description: Xenon App Framework and version type: string xManagedServiceIdentityId: description: Explicit Managed Service Identity Id format: int32 type: integer type: object slotSwapStatus: description: The status of the last successful slot swap operation. properties: destinationSlotName: description: The destination slot of the last swap operation. readOnly: true type: string sourceSlotName: description: The source slot of the last swap operation. readOnly: true type: string timestampUtc: description: The time the last successful slot swap completed. format: date-time readOnly: true type: string type: object state: description: Current state of the app. readOnly: true type: string suspendedTill: description: App suspended till in case memory-time quota is exceeded. format: date-time readOnly: true type: string targetSwapSlot: description: Specifies which deployment slot this app will swap into. Read-only. readOnly: true type: string trafficManagerHostNames: description: Azure Traffic Manager hostnames associated with the app. Read-only. items: type: string readOnly: true type: array usageState: description: State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded readOnly: true type: string x-ms-enum: modelAsString: false name: UsageState x-ms-client-flatten: true type: object type: array required: - value type: object default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Get All Apps for a Subscription. tags: - WebApps x-ms-pageable: nextLinkName: nextLink x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites: get: description: Description for Gets all web, mobile, and API apps in the specified resource group. operationId: WebApps_ListByResourceGroup parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Specify true to include deployment slots in results. The default is false, which only gives you the production slot of all apps. in: query name: includeSlots type: boolean example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: description: Collection of App Service apps. properties: nextLink: description: Link to next page of resources. readOnly: true type: string value: description: Collection of resources. items: allOf: - description: Azure resource. This resource is tracked in Azure Resource Manager properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string location: description: Resource Location. type: string name: description: Resource Name. readOnly: true type: string tags: additionalProperties: type: string description: Resource tags. type: object type: description: Resource type. readOnly: true type: string required: - location x-ms-azure-resource: true description: A web app, a mobile app backend, or an API app. properties: identity: description: Managed service identity. properties: principalId: description: Principal Id of managed service identity. readOnly: true type: string tenantId: description: Tenant of managed service identity. readOnly: true type: string type: description: Type of managed service identity. enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: modelAsString: false name: ManagedServiceIdentityType userAssignedIdentities: additionalProperties: properties: clientId: description: Client Id of user assigned identity readOnly: true type: string principalId: description: Principal Id of user assigned identity readOnly: true type: string type: object description: "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" type: object type: object properties: description: Site resource specific properties properties: availabilityState: description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode readOnly: true type: string x-ms-enum: modelAsString: false name: SiteAvailabilityState clientAffinityEnabled: description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. type: boolean clientCertEnabled: description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. type: boolean clientCertExclusionPaths: description: client certificate authentication comma-separated exclusion paths type: string cloningInfo: description: Information needed for cloning operation. properties: appSettingsOverrides: additionalProperties: type: string description: "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained." type: object cloneCustomHostNames: description: true to clone custom hostnames from source app; otherwise, false. type: boolean cloneSourceControl: description: true to clone source control from source app; otherwise, false. type: boolean configureLoadBalancing: description: true to configure load balancing for source and destination app. type: boolean correlationId: description: "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot." example: 00000000-0000-0000-0000-000000000000 format: uuid type: string hostingEnvironment: description: App Service Environment. type: string overwrite: description: true to overwrite destination app; otherwise, false. type: boolean sourceWebAppId: description: "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots." type: string sourceWebAppLocation: description: 'Location of source app ex: West US or North Europe' type: string trafficManagerProfileId: description: "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}." type: string trafficManagerProfileName: description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. type: string required: - sourceWebAppId type: object containerSize: description: Size of the function container. format: int32 type: integer dailyMemoryTimeQuota: description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). format: int32 type: integer defaultHostName: description: Default hostname of the app. Read-only. readOnly: true type: string enabled: description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). type: boolean enabledHostNames: description: "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames." items: type: string readOnly: true type: array hostNameSslStates: description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. items: description: SSL-enabled hostname. properties: hostType: description: Indicates whether the hostname is a standard or repository hostname. enum: - Standard - Repository type: string x-ms-enum: modelAsString: false name: HostType name: description: Hostname. type: string sslState: description: SSL type. enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: modelAsString: false name: SslState thumbprint: description: SSL certificate thumbprint. type: string toUpdate: description: Set to true to update existing hostname. type: boolean virtualIP: description: Virtual IP address assigned to the hostname if IP based SSL is enabled. type: string type: object type: array hostNames: description: Hostnames associated with the app. items: type: string readOnly: true type: array hostNamesDisabled: description: "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process." type: boolean hostingEnvironmentProfile: description: Specification for an App Service Environment to use for this resource. properties: id: description: Resource ID of the App Service Environment. type: string name: description: Name of the App Service Environment. readOnly: true type: string type: description: Resource type of the App Service Environment. readOnly: true type: string type: object httpsOnly: description: "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests" type: boolean hyperV: default: false description: Hyper-V sandbox. type: boolean x-ms-mutability: - create - read inProgressOperationId: description: Specifies an operation id if this site has a pending operation. example: 00000000-0000-0000-0000-000000000000 format: uuid readOnly: true type: string isDefaultContainer: description: true if the app is a default container; otherwise, false. readOnly: true type: boolean isXenon: default: false description: 'Obsolete: Hyper-V sandbox.' type: boolean x-ms-mutability: - create - read lastModifiedTimeUtc: description: Last time the app was modified, in UTC. Read-only. format: date-time readOnly: true type: string maxNumberOfWorkers: description: "Maximum number of workers.\nThis only applies to Functions container." format: int32 readOnly: true type: integer outboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. readOnly: true type: string possibleOutboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. readOnly: true type: string redundancyMode: description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant type: string x-ms-enum: modelAsString: false name: RedundancyMode repositorySiteName: description: Name of the repository site. readOnly: true type: string reserved: default: false description: true if reserved; otherwise, false. type: boolean x-ms-mutability: - create - read resourceGroup: description: Name of the resource group the app belongs to. Read-only. readOnly: true type: string scmSiteAlsoStopped: default: false description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. type: boolean serverFarmId: description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' type: string siteConfig: description: Configuration of an App Service app. properties: alwaysOn: description: true if Always On is enabled; otherwise, false. type: boolean apiDefinition: description: Information about the formal API definition for the app. properties: url: description: The URL of the API definition. type: string type: object apiManagementConfig: description: Azure API management (APIM) configuration linked to the app. properties: id: description: APIM-Api Identifier. type: string type: object appCommandLine: description: App command line to launch. type: string appSettings: description: Application settings. items: description: Name value pair. properties: name: description: Pair name. type: string value: description: Pair value. type: string type: object type: array autoHealEnabled: description: true if Auto Heal is enabled; otherwise, false. type: boolean autoHealRules: description: Rules that can be defined for auto-heal. properties: actions: description: Actions which to take by the auto-heal module when a rule is triggered. properties: actionType: description: Predefined action to be taken. enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: modelAsString: false name: AutoHealActionType customAction: description: "Custom action to be executed\nwhen an auto heal rule is triggered." properties: exe: description: Executable to be run. type: string parameters: description: Parameters for the executable. type: string type: object minProcessExecutionTime: description: "Minimum time the process must execute\nbefore taking the action" type: string type: object triggers: description: Triggers for auto-heal. properties: privateBytesInKB: description: A rule based on private bytes. format: int32 type: integer requests: description: Trigger based on total requests. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string type: object slowRequests: description: Trigger based on request execution time. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string timeTaken: description: Time taken. type: string type: object statusCodes: description: A rule based on status codes. items: description: Trigger based on status code. properties: count: description: Request Count. format: int32 type: integer status: description: HTTP status code. format: int32 type: integer subStatus: description: Request Sub Status. format: int32 type: integer timeInterval: description: Time interval. type: string win32Status: description: Win32 error code. format: int32 type: integer type: object type: array type: object type: object autoSwapSlotName: description: Auto-swap slot name. type: string connectionStrings: description: Connection strings. items: description: Database connection string information. properties: connectionString: description: Connection string value. type: string name: description: Name of connection string. type: string type: description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL type: string x-ms-enum: modelAsString: false name: ConnectionStringType type: object type: array cors: description: Cross-Origin Resource Sharing (CORS) settings for the app. properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all." items: type: string type: array supportCredentials: description: "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\n\ for more details." type: boolean type: object defaultDocuments: description: Default documents. items: type: string type: array detailedErrorLoggingEnabled: description: true if detailed error logging is enabled; otherwise, false. type: boolean documentRoot: description: Document root. type: string experiments: description: Routing rules in production experiments. properties: rampUpRules: description: List of ramp-up rules. items: description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. properties: actionHostName: description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. type: string changeDecisionCallbackUrl: description: "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/" type: string changeIntervalInMinutes: description: Specifies interval in minutes to reevaluate ReroutePercentage. format: int32 type: integer changeStep: description: "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or\ \ \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \n\ can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl." format: double type: number maxReroutePercentage: description: Specifies upper boundary below which ReroutePercentage will stay. format: double type: number minReroutePercentage: description: Specifies lower boundary above which ReroutePercentage will stay. format: double type: number name: description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string reroutePercentage: description: Percentage of the traffic which will be redirected to ActionHostName. format: double type: number type: object type: array type: object ftpsState: description: State of FTP / FTPS service enum: - AllAllowed - FtpsOnly - Disabled type: string x-ms-enum: modelAsString: true name: FtpsState handlerMappings: description: Handler mappings. items: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." properties: arguments: description: Command-line arguments to be passed to the script processor. type: string extension: description: Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string type: object type: array healthCheckPath: description: Health check path type: string http20Enabled: default: true description: 'Http20Enabled: configures a web site to allow clients to connect over http2.0' type: boolean httpLoggingEnabled: description: true if HTTP logging is enabled; otherwise, false. type: boolean ipSecurityRestrictions: description: IP security restrictions for main. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array javaContainer: description: Java container. type: string javaContainerVersion: description: Java container version. type: string javaVersion: description: Java version. type: string limits: description: Metric limits set on an app. properties: maxDiskSizeInMb: description: Maximum allowed disk size usage in MB. format: int64 type: integer maxMemoryInMb: description: Maximum allowed memory usage in MB. format: int64 type: integer maxPercentageCpu: description: Maximum allowed CPU usage percentage. format: double type: number type: object linuxFxVersion: description: Linux App Framework and version type: string loadBalancing: description: Site load balancing. enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: modelAsString: false name: SiteLoadBalancing localMySqlEnabled: default: false description: true to enable local MySQL; otherwise, false. type: boolean logsDirectorySizeLimit: description: HTTP logs directory size limit. format: int32 type: integer machineKey: description: MachineKey of an app. properties: decryption: description: Algorithm used for decryption. type: string decryptionKey: description: Decryption key. type: string validation: description: MachineKey validation. type: string validationKey: description: Validation key. type: string type: object managedPipelineMode: description: Managed pipeline mode. enum: - Integrated - Classic type: string x-ms-enum: modelAsString: false name: ManagedPipelineMode managedServiceIdentityId: description: Managed Service Identity Id format: int32 type: integer minTlsVersion: description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' enum: - '1.0' - '1.1' - '1.2' type: string x-ms-enum: modelAsString: true name: SupportedTlsVersions netFrameworkVersion: default: v4.6 description: .NET Framework version. type: string nodeVersion: description: Version of Node.js. type: string numberOfWorkers: description: Number of workers. format: int32 type: integer phpVersion: description: Version of PHP. type: string preWarmedInstanceCount: description: "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans" format: int32 maximum: 10 minimum: 0 type: integer publishingUsername: description: Publishing user name. type: string push: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object pythonVersion: description: Version of Python. type: string remoteDebuggingEnabled: description: true if remote debugging is enabled; otherwise, false. type: boolean remoteDebuggingVersion: description: Remote debugging version. type: string requestTracingEnabled: description: true if request tracing is enabled; otherwise, false. type: boolean requestTracingExpirationTime: description: Request tracing expiration time. format: date-time type: string scmIpSecurityRestrictions: description: IP security restrictions for scm. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array scmIpSecurityRestrictionsUseMain: description: IP security restrictions for scm to use main. type: boolean scmType: description: SCM type. enum: - None - Dropbox - Tfs - LocalGit - GitHub - CodePlexGit - CodePlexHg - BitbucketGit - BitbucketHg - ExternalGit - ExternalHg - OneDrive - VSO - VSTSRM type: string x-ms-enum: modelAsString: true name: ScmType tracingOptions: description: Tracing options. type: string use32BitWorkerProcess: description: true to use 32-bit worker process; otherwise, false. type: boolean virtualApplications: description: Virtual applications. items: description: Virtual application in an app. properties: physicalPath: description: Physical path. type: string preloadEnabled: description: true if preloading is enabled; otherwise, false. type: boolean virtualDirectories: description: Virtual directories for virtual application. items: description: Directory for virtual application. properties: physicalPath: description: Physical path. type: string virtualPath: description: Path to virtual application. type: string type: object type: array virtualPath: description: Virtual path. type: string type: object type: array vnetName: description: Virtual Network name. type: string x-ms-mutability: - create - read webSocketsEnabled: description: true if WebSocket is enabled; otherwise, false. type: boolean windowsFxVersion: description: Xenon App Framework and version type: string xManagedServiceIdentityId: description: Explicit Managed Service Identity Id format: int32 type: integer type: object slotSwapStatus: description: The status of the last successful slot swap operation. properties: destinationSlotName: description: The destination slot of the last swap operation. readOnly: true type: string sourceSlotName: description: The source slot of the last swap operation. readOnly: true type: string timestampUtc: description: The time the last successful slot swap completed. format: date-time readOnly: true type: string type: object state: description: Current state of the app. readOnly: true type: string suspendedTill: description: App suspended till in case memory-time quota is exceeded. format: date-time readOnly: true type: string targetSwapSlot: description: Specifies which deployment slot this app will swap into. Read-only. readOnly: true type: string trafficManagerHostNames: description: Azure Traffic Manager hostnames associated with the app. Read-only. items: type: string readOnly: true type: array usageState: description: State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded readOnly: true type: string x-ms-enum: modelAsString: false name: UsageState x-ms-client-flatten: true type: object type: array required: - value type: object default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets All Web, Mobile, and API Apps in the Specified Resource Group. tags: - WebApps x-ms-pageable: nextLinkName: nextLink x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}: delete: description: Description for Deletes a web, mobile, or API app, or one of the deployment slots. operationId: WebApps_Delete parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app to delete. in: path name: name required: true type: string example: example-value - description: If true, web app metrics are also deleted. in: query name: deleteMetrics type: boolean example: example-value - description: Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted. in: query name: deleteEmptyServerFarm type: boolean example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted web app. '204': description: Successfully deleted web app. '404': description: Web app not found. default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Deletes a Web, Mobile, or API App, or One of the Deployment Slots. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: Description for Gets the details of a web, mobile, or API app. operationId: WebApps_Get parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: allOf: - description: Azure resource. This resource is tracked in Azure Resource Manager properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string location: description: Resource Location. type: string name: description: Resource Name. readOnly: true type: string tags: additionalProperties: type: string description: Resource tags. type: object type: description: Resource type. readOnly: true type: string required: - location x-ms-azure-resource: true description: A web app, a mobile app backend, or an API app. properties: identity: description: Managed service identity. properties: principalId: description: Principal Id of managed service identity. readOnly: true type: string tenantId: description: Tenant of managed service identity. readOnly: true type: string type: description: Type of managed service identity. enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: modelAsString: false name: ManagedServiceIdentityType userAssignedIdentities: additionalProperties: properties: clientId: description: Client Id of user assigned identity readOnly: true type: string principalId: description: Principal Id of user assigned identity readOnly: true type: string type: object description: "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" type: object type: object properties: description: Site resource specific properties properties: availabilityState: description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode readOnly: true type: string x-ms-enum: modelAsString: false name: SiteAvailabilityState clientAffinityEnabled: description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. type: boolean clientCertEnabled: description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. type: boolean clientCertExclusionPaths: description: client certificate authentication comma-separated exclusion paths type: string cloningInfo: description: Information needed for cloning operation. properties: appSettingsOverrides: additionalProperties: type: string description: "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained." type: object cloneCustomHostNames: description: true to clone custom hostnames from source app; otherwise, false. type: boolean cloneSourceControl: description: true to clone source control from source app; otherwise, false. type: boolean configureLoadBalancing: description: true to configure load balancing for source and destination app. type: boolean correlationId: description: "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot." example: 00000000-0000-0000-0000-000000000000 format: uuid type: string hostingEnvironment: description: App Service Environment. type: string overwrite: description: true to overwrite destination app; otherwise, false. type: boolean sourceWebAppId: description: "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots." type: string sourceWebAppLocation: description: 'Location of source app ex: West US or North Europe' type: string trafficManagerProfileId: description: "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}." type: string trafficManagerProfileName: description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. type: string required: - sourceWebAppId type: object containerSize: description: Size of the function container. format: int32 type: integer dailyMemoryTimeQuota: description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). format: int32 type: integer defaultHostName: description: Default hostname of the app. Read-only. readOnly: true type: string enabled: description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). type: boolean enabledHostNames: description: "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames." items: type: string readOnly: true type: array hostNameSslStates: description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. items: description: SSL-enabled hostname. properties: hostType: description: Indicates whether the hostname is a standard or repository hostname. enum: - Standard - Repository type: string x-ms-enum: modelAsString: false name: HostType name: description: Hostname. type: string sslState: description: SSL type. enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: modelAsString: false name: SslState thumbprint: description: SSL certificate thumbprint. type: string toUpdate: description: Set to true to update existing hostname. type: boolean virtualIP: description: Virtual IP address assigned to the hostname if IP based SSL is enabled. type: string type: object type: array hostNames: description: Hostnames associated with the app. items: type: string readOnly: true type: array hostNamesDisabled: description: "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process." type: boolean hostingEnvironmentProfile: description: Specification for an App Service Environment to use for this resource. properties: id: description: Resource ID of the App Service Environment. type: string name: description: Name of the App Service Environment. readOnly: true type: string type: description: Resource type of the App Service Environment. readOnly: true type: string type: object httpsOnly: description: "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests" type: boolean hyperV: default: false description: Hyper-V sandbox. type: boolean x-ms-mutability: - create - read inProgressOperationId: description: Specifies an operation id if this site has a pending operation. example: 00000000-0000-0000-0000-000000000000 format: uuid readOnly: true type: string isDefaultContainer: description: true if the app is a default container; otherwise, false. readOnly: true type: boolean isXenon: default: false description: 'Obsolete: Hyper-V sandbox.' type: boolean x-ms-mutability: - create - read lastModifiedTimeUtc: description: Last time the app was modified, in UTC. Read-only. format: date-time readOnly: true type: string maxNumberOfWorkers: description: "Maximum number of workers.\nThis only applies to Functions container." format: int32 readOnly: true type: integer outboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. readOnly: true type: string possibleOutboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. readOnly: true type: string redundancyMode: description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant type: string x-ms-enum: modelAsString: false name: RedundancyMode repositorySiteName: description: Name of the repository site. readOnly: true type: string reserved: default: false description: true if reserved; otherwise, false. type: boolean x-ms-mutability: - create - read resourceGroup: description: Name of the resource group the app belongs to. Read-only. readOnly: true type: string scmSiteAlsoStopped: default: false description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. type: boolean serverFarmId: description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' type: string siteConfig: description: Configuration of an App Service app. properties: alwaysOn: description: true if Always On is enabled; otherwise, false. type: boolean apiDefinition: description: Information about the formal API definition for the app. properties: url: description: The URL of the API definition. type: string type: object apiManagementConfig: description: Azure API management (APIM) configuration linked to the app. properties: id: description: APIM-Api Identifier. type: string type: object appCommandLine: description: App command line to launch. type: string appSettings: description: Application settings. items: description: Name value pair. properties: name: description: Pair name. type: string value: description: Pair value. type: string type: object type: array autoHealEnabled: description: true if Auto Heal is enabled; otherwise, false. type: boolean autoHealRules: description: Rules that can be defined for auto-heal. properties: actions: description: Actions which to take by the auto-heal module when a rule is triggered. properties: actionType: description: Predefined action to be taken. enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: modelAsString: false name: AutoHealActionType customAction: description: "Custom action to be executed\nwhen an auto heal rule is triggered." properties: exe: description: Executable to be run. type: string parameters: description: Parameters for the executable. type: string type: object minProcessExecutionTime: description: "Minimum time the process must execute\nbefore taking the action" type: string type: object triggers: description: Triggers for auto-heal. properties: privateBytesInKB: description: A rule based on private bytes. format: int32 type: integer requests: description: Trigger based on total requests. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string type: object slowRequests: description: Trigger based on request execution time. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string timeTaken: description: Time taken. type: string type: object statusCodes: description: A rule based on status codes. items: description: Trigger based on status code. properties: count: description: Request Count. format: int32 type: integer status: description: HTTP status code. format: int32 type: integer subStatus: description: Request Sub Status. format: int32 type: integer timeInterval: description: Time interval. type: string win32Status: description: Win32 error code. format: int32 type: integer type: object type: array type: object type: object autoSwapSlotName: description: Auto-swap slot name. type: string connectionStrings: description: Connection strings. items: description: Database connection string information. properties: connectionString: description: Connection string value. type: string name: description: Name of connection string. type: string type: description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL type: string x-ms-enum: modelAsString: false name: ConnectionStringType type: object type: array cors: description: Cross-Origin Resource Sharing (CORS) settings for the app. properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all." items: type: string type: array supportCredentials: description: "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details." type: boolean type: object defaultDocuments: description: Default documents. items: type: string type: array detailedErrorLoggingEnabled: description: true if detailed error logging is enabled; otherwise, false. type: boolean documentRoot: description: Document root. type: string experiments: description: Routing rules in production experiments. properties: rampUpRules: description: List of ramp-up rules. items: description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. properties: actionHostName: description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. type: string changeDecisionCallbackUrl: description: "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\n\ https://www.siteextensions.net/packages/TiPCallback/" type: string changeIntervalInMinutes: description: Specifies interval in minutes to reevaluate ReroutePercentage. format: int32 type: integer changeStep: description: "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl." format: double type: number maxReroutePercentage: description: Specifies upper boundary below which ReroutePercentage will stay. format: double type: number minReroutePercentage: description: Specifies lower boundary above which ReroutePercentage will stay. format: double type: number name: description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string reroutePercentage: description: Percentage of the traffic which will be redirected to ActionHostName. format: double type: number type: object type: array type: object ftpsState: description: State of FTP / FTPS service enum: - AllAllowed - FtpsOnly - Disabled type: string x-ms-enum: modelAsString: true name: FtpsState handlerMappings: description: Handler mappings. items: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." properties: arguments: description: Command-line arguments to be passed to the script processor. type: string extension: description: Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string type: object type: array healthCheckPath: description: Health check path type: string http20Enabled: default: true description: 'Http20Enabled: configures a web site to allow clients to connect over http2.0' type: boolean httpLoggingEnabled: description: true if HTTP logging is enabled; otherwise, false. type: boolean ipSecurityRestrictions: description: IP security restrictions for main. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array javaContainer: description: Java container. type: string javaContainerVersion: description: Java container version. type: string javaVersion: description: Java version. type: string limits: description: Metric limits set on an app. properties: maxDiskSizeInMb: description: Maximum allowed disk size usage in MB. format: int64 type: integer maxMemoryInMb: description: Maximum allowed memory usage in MB. format: int64 type: integer maxPercentageCpu: description: Maximum allowed CPU usage percentage. format: double type: number type: object linuxFxVersion: description: Linux App Framework and version type: string loadBalancing: description: Site load balancing. enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: modelAsString: false name: SiteLoadBalancing localMySqlEnabled: default: false description: true to enable local MySQL; otherwise, false. type: boolean logsDirectorySizeLimit: description: HTTP logs directory size limit. format: int32 type: integer machineKey: description: MachineKey of an app. properties: decryption: description: Algorithm used for decryption. type: string decryptionKey: description: Decryption key. type: string validation: description: MachineKey validation. type: string validationKey: description: Validation key. type: string type: object managedPipelineMode: description: Managed pipeline mode. enum: - Integrated - Classic type: string x-ms-enum: modelAsString: false name: ManagedPipelineMode managedServiceIdentityId: description: Managed Service Identity Id format: int32 type: integer minTlsVersion: description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' enum: - '1.0' - '1.1' - '1.2' type: string x-ms-enum: modelAsString: true name: SupportedTlsVersions netFrameworkVersion: default: v4.6 description: .NET Framework version. type: string nodeVersion: description: Version of Node.js. type: string numberOfWorkers: description: Number of workers. format: int32 type: integer phpVersion: description: Version of PHP. type: string preWarmedInstanceCount: description: "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans" format: int32 maximum: 10 minimum: 0 type: integer publishingUsername: description: Publishing user name. type: string push: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object pythonVersion: description: Version of Python. type: string remoteDebuggingEnabled: description: true if remote debugging is enabled; otherwise, false. type: boolean remoteDebuggingVersion: description: Remote debugging version. type: string requestTracingEnabled: description: true if request tracing is enabled; otherwise, false. type: boolean requestTracingExpirationTime: description: Request tracing expiration time. format: date-time type: string scmIpSecurityRestrictions: description: IP security restrictions for scm. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array scmIpSecurityRestrictionsUseMain: description: IP security restrictions for scm to use main. type: boolean scmType: description: SCM type. enum: - None - Dropbox - Tfs - LocalGit - GitHub - CodePlexGit - CodePlexHg - BitbucketGit - BitbucketHg - ExternalGit - ExternalHg - OneDrive - VSO - VSTSRM type: string x-ms-enum: modelAsString: true name: ScmType tracingOptions: description: Tracing options. type: string use32BitWorkerProcess: description: true to use 32-bit worker process; otherwise, false. type: boolean virtualApplications: description: Virtual applications. items: description: Virtual application in an app. properties: physicalPath: description: Physical path. type: string preloadEnabled: description: true if preloading is enabled; otherwise, false. type: boolean virtualDirectories: description: Virtual directories for virtual application. items: description: Directory for virtual application. properties: physicalPath: description: Physical path. type: string virtualPath: description: Path to virtual application. type: string type: object type: array virtualPath: description: Virtual path. type: string type: object type: array vnetName: description: Virtual Network name. type: string x-ms-mutability: - create - read webSocketsEnabled: description: true if WebSocket is enabled; otherwise, false. type: boolean windowsFxVersion: description: Xenon App Framework and version type: string xManagedServiceIdentityId: description: Explicit Managed Service Identity Id format: int32 type: integer type: object slotSwapStatus: description: The status of the last successful slot swap operation. properties: destinationSlotName: description: The destination slot of the last swap operation. readOnly: true type: string sourceSlotName: description: The source slot of the last swap operation. readOnly: true type: string timestampUtc: description: The time the last successful slot swap completed. format: date-time readOnly: true type: string type: object state: description: Current state of the app. readOnly: true type: string suspendedTill: description: App suspended till in case memory-time quota is exceeded. format: date-time readOnly: true type: string targetSwapSlot: description: Specifies which deployment slot this app will swap into. Read-only. readOnly: true type: string trafficManagerHostNames: description: Azure Traffic Manager hostnames associated with the app. Read-only. items: type: string readOnly: true type: array usageState: description: State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded readOnly: true type: string x-ms-enum: modelAsString: false name: UsageState x-ms-client-flatten: true type: object '404': description: Not found. default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Details of a Web, Mobile, or API App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: description: Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. operationId: WebApps_Update parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. in: path name: name required: true type: string example: example-value - description: A JSON representation of the app properties. See example. in: body name: siteEnvelope required: true schema: $ref: '#/definitions/SitePatchResource' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: allOf: - description: Azure resource. This resource is tracked in Azure Resource Manager properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string location: description: Resource Location. type: string name: description: Resource Name. readOnly: true type: string tags: additionalProperties: type: string description: Resource tags. type: object type: description: Resource type. readOnly: true type: string required: - location x-ms-azure-resource: true description: A web app, a mobile app backend, or an API app. properties: identity: description: Managed service identity. properties: principalId: description: Principal Id of managed service identity. readOnly: true type: string tenantId: description: Tenant of managed service identity. readOnly: true type: string type: description: Type of managed service identity. enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: modelAsString: false name: ManagedServiceIdentityType userAssignedIdentities: additionalProperties: properties: clientId: description: Client Id of user assigned identity readOnly: true type: string principalId: description: Principal Id of user assigned identity readOnly: true type: string type: object description: "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" type: object type: object properties: description: Site resource specific properties properties: availabilityState: description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode readOnly: true type: string x-ms-enum: modelAsString: false name: SiteAvailabilityState clientAffinityEnabled: description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. type: boolean clientCertEnabled: description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. type: boolean clientCertExclusionPaths: description: client certificate authentication comma-separated exclusion paths type: string cloningInfo: description: Information needed for cloning operation. properties: appSettingsOverrides: additionalProperties: type: string description: "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained." type: object cloneCustomHostNames: description: true to clone custom hostnames from source app; otherwise, false. type: boolean cloneSourceControl: description: true to clone source control from source app; otherwise, false. type: boolean configureLoadBalancing: description: true to configure load balancing for source and destination app. type: boolean correlationId: description: "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot." example: 00000000-0000-0000-0000-000000000000 format: uuid type: string hostingEnvironment: description: App Service Environment. type: string overwrite: description: true to overwrite destination app; otherwise, false. type: boolean sourceWebAppId: description: "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots." type: string sourceWebAppLocation: description: 'Location of source app ex: West US or North Europe' type: string trafficManagerProfileId: description: "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}." type: string trafficManagerProfileName: description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. type: string required: - sourceWebAppId type: object containerSize: description: Size of the function container. format: int32 type: integer dailyMemoryTimeQuota: description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). format: int32 type: integer defaultHostName: description: Default hostname of the app. Read-only. readOnly: true type: string enabled: description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). type: boolean enabledHostNames: description: "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames." items: type: string readOnly: true type: array hostNameSslStates: description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. items: description: SSL-enabled hostname. properties: hostType: description: Indicates whether the hostname is a standard or repository hostname. enum: - Standard - Repository type: string x-ms-enum: modelAsString: false name: HostType name: description: Hostname. type: string sslState: description: SSL type. enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: modelAsString: false name: SslState thumbprint: description: SSL certificate thumbprint. type: string toUpdate: description: Set to true to update existing hostname. type: boolean virtualIP: description: Virtual IP address assigned to the hostname if IP based SSL is enabled. type: string type: object type: array hostNames: description: Hostnames associated with the app. items: type: string readOnly: true type: array hostNamesDisabled: description: "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process." type: boolean hostingEnvironmentProfile: description: Specification for an App Service Environment to use for this resource. properties: id: description: Resource ID of the App Service Environment. type: string name: description: Name of the App Service Environment. readOnly: true type: string type: description: Resource type of the App Service Environment. readOnly: true type: string type: object httpsOnly: description: "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests" type: boolean hyperV: default: false description: Hyper-V sandbox. type: boolean x-ms-mutability: - create - read inProgressOperationId: description: Specifies an operation id if this site has a pending operation. example: 00000000-0000-0000-0000-000000000000 format: uuid readOnly: true type: string isDefaultContainer: description: true if the app is a default container; otherwise, false. readOnly: true type: boolean isXenon: default: false description: 'Obsolete: Hyper-V sandbox.' type: boolean x-ms-mutability: - create - read lastModifiedTimeUtc: description: Last time the app was modified, in UTC. Read-only. format: date-time readOnly: true type: string maxNumberOfWorkers: description: "Maximum number of workers.\nThis only applies to Functions container." format: int32 readOnly: true type: integer outboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. readOnly: true type: string possibleOutboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. readOnly: true type: string redundancyMode: description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant type: string x-ms-enum: modelAsString: false name: RedundancyMode repositorySiteName: description: Name of the repository site. readOnly: true type: string reserved: default: false description: true if reserved; otherwise, false. type: boolean x-ms-mutability: - create - read resourceGroup: description: Name of the resource group the app belongs to. Read-only. readOnly: true type: string scmSiteAlsoStopped: default: false description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. type: boolean serverFarmId: description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' type: string siteConfig: description: Configuration of an App Service app. properties: alwaysOn: description: true if Always On is enabled; otherwise, false. type: boolean apiDefinition: description: Information about the formal API definition for the app. properties: url: description: The URL of the API definition. type: string type: object apiManagementConfig: description: Azure API management (APIM) configuration linked to the app. properties: id: description: APIM-Api Identifier. type: string type: object appCommandLine: description: App command line to launch. type: string appSettings: description: Application settings. items: description: Name value pair. properties: name: description: Pair name. type: string value: description: Pair value. type: string type: object type: array autoHealEnabled: description: true if Auto Heal is enabled; otherwise, false. type: boolean autoHealRules: description: Rules that can be defined for auto-heal. properties: actions: description: Actions which to take by the auto-heal module when a rule is triggered. properties: actionType: description: Predefined action to be taken. enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: modelAsString: false name: AutoHealActionType customAction: description: "Custom action to be executed\nwhen an auto heal rule is triggered." properties: exe: description: Executable to be run. type: string parameters: description: Parameters for the executable. type: string type: object minProcessExecutionTime: description: "Minimum time the process must execute\nbefore taking the action" type: string type: object triggers: description: Triggers for auto-heal. properties: privateBytesInKB: description: A rule based on private bytes. format: int32 type: integer requests: description: Trigger based on total requests. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string type: object slowRequests: description: Trigger based on request execution time. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string timeTaken: description: Time taken. type: string type: object statusCodes: description: A rule based on status codes. items: description: Trigger based on status code. properties: count: description: Request Count. format: int32 type: integer status: description: HTTP status code. format: int32 type: integer subStatus: description: Request Sub Status. format: int32 type: integer timeInterval: description: Time interval. type: string win32Status: description: Win32 error code. format: int32 type: integer type: object type: array type: object type: object autoSwapSlotName: description: Auto-swap slot name. type: string connectionStrings: description: Connection strings. items: description: Database connection string information. properties: connectionString: description: Connection string value. type: string name: description: Name of connection string. type: string type: description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL type: string x-ms-enum: modelAsString: false name: ConnectionStringType type: object type: array cors: description: Cross-Origin Resource Sharing (CORS) settings for the app. properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all." items: type: string type: array supportCredentials: description: "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details." type: boolean type: object defaultDocuments: description: Default documents. items: type: string type: array detailedErrorLoggingEnabled: description: true if detailed error logging is enabled; otherwise, false. type: boolean documentRoot: description: Document root. type: string experiments: description: Routing rules in production experiments. properties: rampUpRules: description: List of ramp-up rules. items: description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. properties: actionHostName: description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. type: string changeDecisionCallbackUrl: description: "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\n\ https://www.siteextensions.net/packages/TiPCallback/" type: string changeIntervalInMinutes: description: Specifies interval in minutes to reevaluate ReroutePercentage. format: int32 type: integer changeStep: description: "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl." format: double type: number maxReroutePercentage: description: Specifies upper boundary below which ReroutePercentage will stay. format: double type: number minReroutePercentage: description: Specifies lower boundary above which ReroutePercentage will stay. format: double type: number name: description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string reroutePercentage: description: Percentage of the traffic which will be redirected to ActionHostName. format: double type: number type: object type: array type: object ftpsState: description: State of FTP / FTPS service enum: - AllAllowed - FtpsOnly - Disabled type: string x-ms-enum: modelAsString: true name: FtpsState handlerMappings: description: Handler mappings. items: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." properties: arguments: description: Command-line arguments to be passed to the script processor. type: string extension: description: Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string type: object type: array healthCheckPath: description: Health check path type: string http20Enabled: default: true description: 'Http20Enabled: configures a web site to allow clients to connect over http2.0' type: boolean httpLoggingEnabled: description: true if HTTP logging is enabled; otherwise, false. type: boolean ipSecurityRestrictions: description: IP security restrictions for main. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array javaContainer: description: Java container. type: string javaContainerVersion: description: Java container version. type: string javaVersion: description: Java version. type: string limits: description: Metric limits set on an app. properties: maxDiskSizeInMb: description: Maximum allowed disk size usage in MB. format: int64 type: integer maxMemoryInMb: description: Maximum allowed memory usage in MB. format: int64 type: integer maxPercentageCpu: description: Maximum allowed CPU usage percentage. format: double type: number type: object linuxFxVersion: description: Linux App Framework and version type: string loadBalancing: description: Site load balancing. enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: modelAsString: false name: SiteLoadBalancing localMySqlEnabled: default: false description: true to enable local MySQL; otherwise, false. type: boolean logsDirectorySizeLimit: description: HTTP logs directory size limit. format: int32 type: integer machineKey: description: MachineKey of an app. properties: decryption: description: Algorithm used for decryption. type: string decryptionKey: description: Decryption key. type: string validation: description: MachineKey validation. type: string validationKey: description: Validation key. type: string type: object managedPipelineMode: description: Managed pipeline mode. enum: - Integrated - Classic type: string x-ms-enum: modelAsString: false name: ManagedPipelineMode managedServiceIdentityId: description: Managed Service Identity Id format: int32 type: integer minTlsVersion: description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' enum: - '1.0' - '1.1' - '1.2' type: string x-ms-enum: modelAsString: true name: SupportedTlsVersions netFrameworkVersion: default: v4.6 description: .NET Framework version. type: string nodeVersion: description: Version of Node.js. type: string numberOfWorkers: description: Number of workers. format: int32 type: integer phpVersion: description: Version of PHP. type: string preWarmedInstanceCount: description: "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans" format: int32 maximum: 10 minimum: 0 type: integer publishingUsername: description: Publishing user name. type: string push: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object pythonVersion: description: Version of Python. type: string remoteDebuggingEnabled: description: true if remote debugging is enabled; otherwise, false. type: boolean remoteDebuggingVersion: description: Remote debugging version. type: string requestTracingEnabled: description: true if request tracing is enabled; otherwise, false. type: boolean requestTracingExpirationTime: description: Request tracing expiration time. format: date-time type: string scmIpSecurityRestrictions: description: IP security restrictions for scm. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array scmIpSecurityRestrictionsUseMain: description: IP security restrictions for scm to use main. type: boolean scmType: description: SCM type. enum: - None - Dropbox - Tfs - LocalGit - GitHub - CodePlexGit - CodePlexHg - BitbucketGit - BitbucketHg - ExternalGit - ExternalHg - OneDrive - VSO - VSTSRM type: string x-ms-enum: modelAsString: true name: ScmType tracingOptions: description: Tracing options. type: string use32BitWorkerProcess: description: true to use 32-bit worker process; otherwise, false. type: boolean virtualApplications: description: Virtual applications. items: description: Virtual application in an app. properties: physicalPath: description: Physical path. type: string preloadEnabled: description: true if preloading is enabled; otherwise, false. type: boolean virtualDirectories: description: Virtual directories for virtual application. items: description: Directory for virtual application. properties: physicalPath: description: Physical path. type: string virtualPath: description: Path to virtual application. type: string type: object type: array virtualPath: description: Virtual path. type: string type: object type: array vnetName: description: Virtual Network name. type: string x-ms-mutability: - create - read webSocketsEnabled: description: true if WebSocket is enabled; otherwise, false. type: boolean windowsFxVersion: description: Xenon App Framework and version type: string xManagedServiceIdentityId: description: Explicit Managed Service Identity Id format: int32 type: integer type: object slotSwapStatus: description: The status of the last successful slot swap operation. properties: destinationSlotName: description: The destination slot of the last swap operation. readOnly: true type: string sourceSlotName: description: The source slot of the last swap operation. readOnly: true type: string timestampUtc: description: The time the last successful slot swap completed. format: date-time readOnly: true type: string type: object state: description: Current state of the app. readOnly: true type: string suspendedTill: description: App suspended till in case memory-time quota is exceeded. format: date-time readOnly: true type: string targetSwapSlot: description: Specifies which deployment slot this app will swap into. Read-only. readOnly: true type: string trafficManagerHostNames: description: Azure Traffic Manager hostnames associated with the app. Read-only. items: type: string readOnly: true type: array usageState: description: State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded readOnly: true type: string x-ms-enum: modelAsString: false name: UsageState x-ms-client-flatten: true type: object '202': description: Asynchronous operation in progress. schema: allOf: - description: Azure resource. This resource is tracked in Azure Resource Manager properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string location: description: Resource Location. type: string name: description: Resource Name. readOnly: true type: string tags: additionalProperties: type: string description: Resource tags. type: object type: description: Resource type. readOnly: true type: string required: - location x-ms-azure-resource: true description: A web app, a mobile app backend, or an API app. properties: identity: description: Managed service identity. properties: principalId: description: Principal Id of managed service identity. readOnly: true type: string tenantId: description: Tenant of managed service identity. readOnly: true type: string type: description: Type of managed service identity. enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: modelAsString: false name: ManagedServiceIdentityType userAssignedIdentities: additionalProperties: properties: clientId: description: Client Id of user assigned identity readOnly: true type: string principalId: description: Principal Id of user assigned identity readOnly: true type: string type: object description: "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" type: object type: object properties: description: Site resource specific properties properties: availabilityState: description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode readOnly: true type: string x-ms-enum: modelAsString: false name: SiteAvailabilityState clientAffinityEnabled: description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. type: boolean clientCertEnabled: description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. type: boolean clientCertExclusionPaths: description: client certificate authentication comma-separated exclusion paths type: string cloningInfo: description: Information needed for cloning operation. properties: appSettingsOverrides: additionalProperties: type: string description: "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained." type: object cloneCustomHostNames: description: true to clone custom hostnames from source app; otherwise, false. type: boolean cloneSourceControl: description: true to clone source control from source app; otherwise, false. type: boolean configureLoadBalancing: description: true to configure load balancing for source and destination app. type: boolean correlationId: description: "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot." example: 00000000-0000-0000-0000-000000000000 format: uuid type: string hostingEnvironment: description: App Service Environment. type: string overwrite: description: true to overwrite destination app; otherwise, false. type: boolean sourceWebAppId: description: "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots." type: string sourceWebAppLocation: description: 'Location of source app ex: West US or North Europe' type: string trafficManagerProfileId: description: "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}." type: string trafficManagerProfileName: description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. type: string required: - sourceWebAppId type: object containerSize: description: Size of the function container. format: int32 type: integer dailyMemoryTimeQuota: description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). format: int32 type: integer defaultHostName: description: Default hostname of the app. Read-only. readOnly: true type: string enabled: description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). type: boolean enabledHostNames: description: "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames." items: type: string readOnly: true type: array hostNameSslStates: description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. items: description: SSL-enabled hostname. properties: hostType: description: Indicates whether the hostname is a standard or repository hostname. enum: - Standard - Repository type: string x-ms-enum: modelAsString: false name: HostType name: description: Hostname. type: string sslState: description: SSL type. enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: modelAsString: false name: SslState thumbprint: description: SSL certificate thumbprint. type: string toUpdate: description: Set to true to update existing hostname. type: boolean virtualIP: description: Virtual IP address assigned to the hostname if IP based SSL is enabled. type: string type: object type: array hostNames: description: Hostnames associated with the app. items: type: string readOnly: true type: array hostNamesDisabled: description: "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process." type: boolean hostingEnvironmentProfile: description: Specification for an App Service Environment to use for this resource. properties: id: description: Resource ID of the App Service Environment. type: string name: description: Name of the App Service Environment. readOnly: true type: string type: description: Resource type of the App Service Environment. readOnly: true type: string type: object httpsOnly: description: "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests" type: boolean hyperV: default: false description: Hyper-V sandbox. type: boolean x-ms-mutability: - create - read inProgressOperationId: description: Specifies an operation id if this site has a pending operation. example: 00000000-0000-0000-0000-000000000000 format: uuid readOnly: true type: string isDefaultContainer: description: true if the app is a default container; otherwise, false. readOnly: true type: boolean isXenon: default: false description: 'Obsolete: Hyper-V sandbox.' type: boolean x-ms-mutability: - create - read lastModifiedTimeUtc: description: Last time the app was modified, in UTC. Read-only. format: date-time readOnly: true type: string maxNumberOfWorkers: description: "Maximum number of workers.\nThis only applies to Functions container." format: int32 readOnly: true type: integer outboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. readOnly: true type: string possibleOutboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. readOnly: true type: string redundancyMode: description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant type: string x-ms-enum: modelAsString: false name: RedundancyMode repositorySiteName: description: Name of the repository site. readOnly: true type: string reserved: default: false description: true if reserved; otherwise, false. type: boolean x-ms-mutability: - create - read resourceGroup: description: Name of the resource group the app belongs to. Read-only. readOnly: true type: string scmSiteAlsoStopped: default: false description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. type: boolean serverFarmId: description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' type: string siteConfig: description: Configuration of an App Service app. properties: alwaysOn: description: true if Always On is enabled; otherwise, false. type: boolean apiDefinition: description: Information about the formal API definition for the app. properties: url: description: The URL of the API definition. type: string type: object apiManagementConfig: description: Azure API management (APIM) configuration linked to the app. properties: id: description: APIM-Api Identifier. type: string type: object appCommandLine: description: App command line to launch. type: string appSettings: description: Application settings. items: description: Name value pair. properties: name: description: Pair name. type: string value: description: Pair value. type: string type: object type: array autoHealEnabled: description: true if Auto Heal is enabled; otherwise, false. type: boolean autoHealRules: description: Rules that can be defined for auto-heal. properties: actions: description: Actions which to take by the auto-heal module when a rule is triggered. properties: actionType: description: Predefined action to be taken. enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: modelAsString: false name: AutoHealActionType customAction: description: "Custom action to be executed\nwhen an auto heal rule is triggered." properties: exe: description: Executable to be run. type: string parameters: description: Parameters for the executable. type: string type: object minProcessExecutionTime: description: "Minimum time the process must execute\nbefore taking the action" type: string type: object triggers: description: Triggers for auto-heal. properties: privateBytesInKB: description: A rule based on private bytes. format: int32 type: integer requests: description: Trigger based on total requests. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string type: object slowRequests: description: Trigger based on request execution time. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string timeTaken: description: Time taken. type: string type: object statusCodes: description: A rule based on status codes. items: description: Trigger based on status code. properties: count: description: Request Count. format: int32 type: integer status: description: HTTP status code. format: int32 type: integer subStatus: description: Request Sub Status. format: int32 type: integer timeInterval: description: Time interval. type: string win32Status: description: Win32 error code. format: int32 type: integer type: object type: array type: object type: object autoSwapSlotName: description: Auto-swap slot name. type: string connectionStrings: description: Connection strings. items: description: Database connection string information. properties: connectionString: description: Connection string value. type: string name: description: Name of connection string. type: string type: description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL type: string x-ms-enum: modelAsString: false name: ConnectionStringType type: object type: array cors: description: Cross-Origin Resource Sharing (CORS) settings for the app. properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all." items: type: string type: array supportCredentials: description: "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details." type: boolean type: object defaultDocuments: description: Default documents. items: type: string type: array detailedErrorLoggingEnabled: description: true if detailed error logging is enabled; otherwise, false. type: boolean documentRoot: description: Document root. type: string experiments: description: Routing rules in production experiments. properties: rampUpRules: description: List of ramp-up rules. items: description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. properties: actionHostName: description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. type: string changeDecisionCallbackUrl: description: "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\n\ https://www.siteextensions.net/packages/TiPCallback/" type: string changeIntervalInMinutes: description: Specifies interval in minutes to reevaluate ReroutePercentage. format: int32 type: integer changeStep: description: "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl." format: double type: number maxReroutePercentage: description: Specifies upper boundary below which ReroutePercentage will stay. format: double type: number minReroutePercentage: description: Specifies lower boundary above which ReroutePercentage will stay. format: double type: number name: description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string reroutePercentage: description: Percentage of the traffic which will be redirected to ActionHostName. format: double type: number type: object type: array type: object ftpsState: description: State of FTP / FTPS service enum: - AllAllowed - FtpsOnly - Disabled type: string x-ms-enum: modelAsString: true name: FtpsState handlerMappings: description: Handler mappings. items: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." properties: arguments: description: Command-line arguments to be passed to the script processor. type: string extension: description: Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string type: object type: array healthCheckPath: description: Health check path type: string http20Enabled: default: true description: 'Http20Enabled: configures a web site to allow clients to connect over http2.0' type: boolean httpLoggingEnabled: description: true if HTTP logging is enabled; otherwise, false. type: boolean ipSecurityRestrictions: description: IP security restrictions for main. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array javaContainer: description: Java container. type: string javaContainerVersion: description: Java container version. type: string javaVersion: description: Java version. type: string limits: description: Metric limits set on an app. properties: maxDiskSizeInMb: description: Maximum allowed disk size usage in MB. format: int64 type: integer maxMemoryInMb: description: Maximum allowed memory usage in MB. format: int64 type: integer maxPercentageCpu: description: Maximum allowed CPU usage percentage. format: double type: number type: object linuxFxVersion: description: Linux App Framework and version type: string loadBalancing: description: Site load balancing. enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: modelAsString: false name: SiteLoadBalancing localMySqlEnabled: default: false description: true to enable local MySQL; otherwise, false. type: boolean logsDirectorySizeLimit: description: HTTP logs directory size limit. format: int32 type: integer machineKey: description: MachineKey of an app. properties: decryption: description: Algorithm used for decryption. type: string decryptionKey: description: Decryption key. type: string validation: description: MachineKey validation. type: string validationKey: description: Validation key. type: string type: object managedPipelineMode: description: Managed pipeline mode. enum: - Integrated - Classic type: string x-ms-enum: modelAsString: false name: ManagedPipelineMode managedServiceIdentityId: description: Managed Service Identity Id format: int32 type: integer minTlsVersion: description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' enum: - '1.0' - '1.1' - '1.2' type: string x-ms-enum: modelAsString: true name: SupportedTlsVersions netFrameworkVersion: default: v4.6 description: .NET Framework version. type: string nodeVersion: description: Version of Node.js. type: string numberOfWorkers: description: Number of workers. format: int32 type: integer phpVersion: description: Version of PHP. type: string preWarmedInstanceCount: description: "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans" format: int32 maximum: 10 minimum: 0 type: integer publishingUsername: description: Publishing user name. type: string push: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object pythonVersion: description: Version of Python. type: string remoteDebuggingEnabled: description: true if remote debugging is enabled; otherwise, false. type: boolean remoteDebuggingVersion: description: Remote debugging version. type: string requestTracingEnabled: description: true if request tracing is enabled; otherwise, false. type: boolean requestTracingExpirationTime: description: Request tracing expiration time. format: date-time type: string scmIpSecurityRestrictions: description: IP security restrictions for scm. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array scmIpSecurityRestrictionsUseMain: description: IP security restrictions for scm to use main. type: boolean scmType: description: SCM type. enum: - None - Dropbox - Tfs - LocalGit - GitHub - CodePlexGit - CodePlexHg - BitbucketGit - BitbucketHg - ExternalGit - ExternalHg - OneDrive - VSO - VSTSRM type: string x-ms-enum: modelAsString: true name: ScmType tracingOptions: description: Tracing options. type: string use32BitWorkerProcess: description: true to use 32-bit worker process; otherwise, false. type: boolean virtualApplications: description: Virtual applications. items: description: Virtual application in an app. properties: physicalPath: description: Physical path. type: string preloadEnabled: description: true if preloading is enabled; otherwise, false. type: boolean virtualDirectories: description: Virtual directories for virtual application. items: description: Directory for virtual application. properties: physicalPath: description: Physical path. type: string virtualPath: description: Path to virtual application. type: string type: object type: array virtualPath: description: Virtual path. type: string type: object type: array vnetName: description: Virtual Network name. type: string x-ms-mutability: - create - read webSocketsEnabled: description: true if WebSocket is enabled; otherwise, false. type: boolean windowsFxVersion: description: Xenon App Framework and version type: string xManagedServiceIdentityId: description: Explicit Managed Service Identity Id format: int32 type: integer type: object slotSwapStatus: description: The status of the last successful slot swap operation. properties: destinationSlotName: description: The destination slot of the last swap operation. readOnly: true type: string sourceSlotName: description: The source slot of the last swap operation. readOnly: true type: string timestampUtc: description: The time the last successful slot swap completed. format: date-time readOnly: true type: string type: object state: description: Current state of the app. readOnly: true type: string suspendedTill: description: App suspended till in case memory-time quota is exceeded. format: date-time readOnly: true type: string targetSwapSlot: description: Specifies which deployment slot this app will swap into. Read-only. readOnly: true type: string trafficManagerHostNames: description: Azure Traffic Manager hostnames associated with the app. Read-only. items: type: string readOnly: true type: array usageState: description: State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded readOnly: true type: string x-ms-enum: modelAsString: false name: UsageState x-ms-client-flatten: true type: object default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Creates a New Web, Mobile, or API App in an Existing Resource Group, or Updates an Existing App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. operationId: WebApps_CreateOrUpdate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. in: path name: name required: true type: string example: example-value - description: A JSON representation of the app properties. See example. in: body name: siteEnvelope required: true schema: allOf: - description: Azure resource. This resource is tracked in Azure Resource Manager properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string location: description: Resource Location. type: string name: description: Resource Name. readOnly: true type: string tags: additionalProperties: type: string description: Resource tags. type: object type: description: Resource type. readOnly: true type: string required: - location x-ms-azure-resource: true description: A web app, a mobile app backend, or an API app. properties: identity: description: Managed service identity. properties: principalId: description: Principal Id of managed service identity. readOnly: true type: string tenantId: description: Tenant of managed service identity. readOnly: true type: string type: description: Type of managed service identity. enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: modelAsString: false name: ManagedServiceIdentityType userAssignedIdentities: additionalProperties: properties: clientId: description: Client Id of user assigned identity readOnly: true type: string principalId: description: Principal Id of user assigned identity readOnly: true type: string type: object description: "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" type: object type: object properties: description: Site resource specific properties properties: availabilityState: description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode readOnly: true type: string x-ms-enum: modelAsString: false name: SiteAvailabilityState clientAffinityEnabled: description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. type: boolean clientCertEnabled: description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. type: boolean clientCertExclusionPaths: description: client certificate authentication comma-separated exclusion paths type: string cloningInfo: description: Information needed for cloning operation. properties: appSettingsOverrides: additionalProperties: type: string description: "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained." type: object cloneCustomHostNames: description: true to clone custom hostnames from source app; otherwise, false. type: boolean cloneSourceControl: description: true to clone source control from source app; otherwise, false. type: boolean configureLoadBalancing: description: true to configure load balancing for source and destination app. type: boolean correlationId: description: "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot." example: 00000000-0000-0000-0000-000000000000 format: uuid type: string hostingEnvironment: description: App Service Environment. type: string overwrite: description: true to overwrite destination app; otherwise, false. type: boolean sourceWebAppId: description: "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots." type: string sourceWebAppLocation: description: 'Location of source app ex: West US or North Europe' type: string trafficManagerProfileId: description: "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}." type: string trafficManagerProfileName: description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. type: string required: - sourceWebAppId type: object containerSize: description: Size of the function container. format: int32 type: integer dailyMemoryTimeQuota: description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). format: int32 type: integer defaultHostName: description: Default hostname of the app. Read-only. readOnly: true type: string enabled: description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). type: boolean enabledHostNames: description: "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames." items: type: string readOnly: true type: array hostNameSslStates: description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. items: description: SSL-enabled hostname. properties: hostType: description: Indicates whether the hostname is a standard or repository hostname. enum: - Standard - Repository type: string x-ms-enum: modelAsString: false name: HostType name: description: Hostname. type: string sslState: description: SSL type. enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: modelAsString: false name: SslState thumbprint: description: SSL certificate thumbprint. type: string toUpdate: description: Set to true to update existing hostname. type: boolean virtualIP: description: Virtual IP address assigned to the hostname if IP based SSL is enabled. type: string type: object type: array hostNames: description: Hostnames associated with the app. items: type: string readOnly: true type: array hostNamesDisabled: description: "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process." type: boolean hostingEnvironmentProfile: description: Specification for an App Service Environment to use for this resource. properties: id: description: Resource ID of the App Service Environment. type: string name: description: Name of the App Service Environment. readOnly: true type: string type: description: Resource type of the App Service Environment. readOnly: true type: string type: object httpsOnly: description: "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests" type: boolean hyperV: default: false description: Hyper-V sandbox. type: boolean x-ms-mutability: - create - read inProgressOperationId: description: Specifies an operation id if this site has a pending operation. example: 00000000-0000-0000-0000-000000000000 format: uuid readOnly: true type: string isDefaultContainer: description: true if the app is a default container; otherwise, false. readOnly: true type: boolean isXenon: default: false description: 'Obsolete: Hyper-V sandbox.' type: boolean x-ms-mutability: - create - read lastModifiedTimeUtc: description: Last time the app was modified, in UTC. Read-only. format: date-time readOnly: true type: string maxNumberOfWorkers: description: "Maximum number of workers.\nThis only applies to Functions container." format: int32 readOnly: true type: integer outboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. readOnly: true type: string possibleOutboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. readOnly: true type: string redundancyMode: description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant type: string x-ms-enum: modelAsString: false name: RedundancyMode repositorySiteName: description: Name of the repository site. readOnly: true type: string reserved: default: false description: true if reserved; otherwise, false. type: boolean x-ms-mutability: - create - read resourceGroup: description: Name of the resource group the app belongs to. Read-only. readOnly: true type: string scmSiteAlsoStopped: default: false description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. type: boolean serverFarmId: description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' type: string siteConfig: description: Configuration of an App Service app. properties: alwaysOn: description: true if Always On is enabled; otherwise, false. type: boolean apiDefinition: description: Information about the formal API definition for the app. properties: url: description: The URL of the API definition. type: string type: object apiManagementConfig: description: Azure API management (APIM) configuration linked to the app. properties: id: description: APIM-Api Identifier. type: string type: object appCommandLine: description: App command line to launch. type: string appSettings: description: Application settings. items: description: Name value pair. properties: name: description: Pair name. type: string value: description: Pair value. type: string type: object type: array autoHealEnabled: description: true if Auto Heal is enabled; otherwise, false. type: boolean autoHealRules: description: Rules that can be defined for auto-heal. properties: actions: description: Actions which to take by the auto-heal module when a rule is triggered. properties: actionType: description: Predefined action to be taken. enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: modelAsString: false name: AutoHealActionType customAction: description: "Custom action to be executed\nwhen an auto heal rule is triggered." properties: exe: description: Executable to be run. type: string parameters: description: Parameters for the executable. type: string type: object minProcessExecutionTime: description: "Minimum time the process must execute\nbefore taking the action" type: string type: object triggers: description: Triggers for auto-heal. properties: privateBytesInKB: description: A rule based on private bytes. format: int32 type: integer requests: description: Trigger based on total requests. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string type: object slowRequests: description: Trigger based on request execution time. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string timeTaken: description: Time taken. type: string type: object statusCodes: description: A rule based on status codes. items: description: Trigger based on status code. properties: count: description: Request Count. format: int32 type: integer status: description: HTTP status code. format: int32 type: integer subStatus: description: Request Sub Status. format: int32 type: integer timeInterval: description: Time interval. type: string win32Status: description: Win32 error code. format: int32 type: integer type: object type: array type: object type: object autoSwapSlotName: description: Auto-swap slot name. type: string connectionStrings: description: Connection strings. items: description: Database connection string information. properties: connectionString: description: Connection string value. type: string name: description: Name of connection string. type: string type: description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL type: string x-ms-enum: modelAsString: false name: ConnectionStringType type: object type: array cors: description: Cross-Origin Resource Sharing (CORS) settings for the app. properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all." items: type: string type: array supportCredentials: description: "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details." type: boolean type: object defaultDocuments: description: Default documents. items: type: string type: array detailedErrorLoggingEnabled: description: true if detailed error logging is enabled; otherwise, false. type: boolean documentRoot: description: Document root. type: string experiments: description: Routing rules in production experiments. properties: rampUpRules: description: List of ramp-up rules. items: description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. properties: actionHostName: description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. type: string changeDecisionCallbackUrl: description: "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\n\ https://www.siteextensions.net/packages/TiPCallback/" type: string changeIntervalInMinutes: description: Specifies interval in minutes to reevaluate ReroutePercentage. format: int32 type: integer changeStep: description: "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl." format: double type: number maxReroutePercentage: description: Specifies upper boundary below which ReroutePercentage will stay. format: double type: number minReroutePercentage: description: Specifies lower boundary above which ReroutePercentage will stay. format: double type: number name: description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string reroutePercentage: description: Percentage of the traffic which will be redirected to ActionHostName. format: double type: number type: object type: array type: object ftpsState: description: State of FTP / FTPS service enum: - AllAllowed - FtpsOnly - Disabled type: string x-ms-enum: modelAsString: true name: FtpsState handlerMappings: description: Handler mappings. items: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." properties: arguments: description: Command-line arguments to be passed to the script processor. type: string extension: description: Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string type: object type: array healthCheckPath: description: Health check path type: string http20Enabled: default: true description: 'Http20Enabled: configures a web site to allow clients to connect over http2.0' type: boolean httpLoggingEnabled: description: true if HTTP logging is enabled; otherwise, false. type: boolean ipSecurityRestrictions: description: IP security restrictions for main. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array javaContainer: description: Java container. type: string javaContainerVersion: description: Java container version. type: string javaVersion: description: Java version. type: string limits: description: Metric limits set on an app. properties: maxDiskSizeInMb: description: Maximum allowed disk size usage in MB. format: int64 type: integer maxMemoryInMb: description: Maximum allowed memory usage in MB. format: int64 type: integer maxPercentageCpu: description: Maximum allowed CPU usage percentage. format: double type: number type: object linuxFxVersion: description: Linux App Framework and version type: string loadBalancing: description: Site load balancing. enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: modelAsString: false name: SiteLoadBalancing localMySqlEnabled: default: false description: true to enable local MySQL; otherwise, false. type: boolean logsDirectorySizeLimit: description: HTTP logs directory size limit. format: int32 type: integer machineKey: description: MachineKey of an app. properties: decryption: description: Algorithm used for decryption. type: string decryptionKey: description: Decryption key. type: string validation: description: MachineKey validation. type: string validationKey: description: Validation key. type: string type: object managedPipelineMode: description: Managed pipeline mode. enum: - Integrated - Classic type: string x-ms-enum: modelAsString: false name: ManagedPipelineMode managedServiceIdentityId: description: Managed Service Identity Id format: int32 type: integer minTlsVersion: description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' enum: - '1.0' - '1.1' - '1.2' type: string x-ms-enum: modelAsString: true name: SupportedTlsVersions netFrameworkVersion: default: v4.6 description: .NET Framework version. type: string nodeVersion: description: Version of Node.js. type: string numberOfWorkers: description: Number of workers. format: int32 type: integer phpVersion: description: Version of PHP. type: string preWarmedInstanceCount: description: "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans" format: int32 maximum: 10 minimum: 0 type: integer publishingUsername: description: Publishing user name. type: string push: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object pythonVersion: description: Version of Python. type: string remoteDebuggingEnabled: description: true if remote debugging is enabled; otherwise, false. type: boolean remoteDebuggingVersion: description: Remote debugging version. type: string requestTracingEnabled: description: true if request tracing is enabled; otherwise, false. type: boolean requestTracingExpirationTime: description: Request tracing expiration time. format: date-time type: string scmIpSecurityRestrictions: description: IP security restrictions for scm. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array scmIpSecurityRestrictionsUseMain: description: IP security restrictions for scm to use main. type: boolean scmType: description: SCM type. enum: - None - Dropbox - Tfs - LocalGit - GitHub - CodePlexGit - CodePlexHg - BitbucketGit - BitbucketHg - ExternalGit - ExternalHg - OneDrive - VSO - VSTSRM type: string x-ms-enum: modelAsString: true name: ScmType tracingOptions: description: Tracing options. type: string use32BitWorkerProcess: description: true to use 32-bit worker process; otherwise, false. type: boolean virtualApplications: description: Virtual applications. items: description: Virtual application in an app. properties: physicalPath: description: Physical path. type: string preloadEnabled: description: true if preloading is enabled; otherwise, false. type: boolean virtualDirectories: description: Virtual directories for virtual application. items: description: Directory for virtual application. properties: physicalPath: description: Physical path. type: string virtualPath: description: Path to virtual application. type: string type: object type: array virtualPath: description: Virtual path. type: string type: object type: array vnetName: description: Virtual Network name. type: string x-ms-mutability: - create - read webSocketsEnabled: description: true if WebSocket is enabled; otherwise, false. type: boolean windowsFxVersion: description: Xenon App Framework and version type: string xManagedServiceIdentityId: description: Explicit Managed Service Identity Id format: int32 type: integer type: object slotSwapStatus: description: The status of the last successful slot swap operation. properties: destinationSlotName: description: The destination slot of the last swap operation. readOnly: true type: string sourceSlotName: description: The source slot of the last swap operation. readOnly: true type: string timestampUtc: description: The time the last successful slot swap completed. format: date-time readOnly: true type: string type: object state: description: Current state of the app. readOnly: true type: string suspendedTill: description: App suspended till in case memory-time quota is exceeded. format: date-time readOnly: true type: string targetSwapSlot: description: Specifies which deployment slot this app will swap into. Read-only. readOnly: true type: string trafficManagerHostNames: description: Azure Traffic Manager hostnames associated with the app. Read-only. items: type: string readOnly: true type: array usageState: description: State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded readOnly: true type: string x-ms-enum: modelAsString: false name: UsageState x-ms-client-flatten: true type: object example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: allOf: - description: Azure resource. This resource is tracked in Azure Resource Manager properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string location: description: Resource Location. type: string name: description: Resource Name. readOnly: true type: string tags: additionalProperties: type: string description: Resource tags. type: object type: description: Resource type. readOnly: true type: string required: - location x-ms-azure-resource: true description: A web app, a mobile app backend, or an API app. properties: identity: description: Managed service identity. properties: principalId: description: Principal Id of managed service identity. readOnly: true type: string tenantId: description: Tenant of managed service identity. readOnly: true type: string type: description: Type of managed service identity. enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: modelAsString: false name: ManagedServiceIdentityType userAssignedIdentities: additionalProperties: properties: clientId: description: Client Id of user assigned identity readOnly: true type: string principalId: description: Principal Id of user assigned identity readOnly: true type: string type: object description: "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" type: object type: object properties: description: Site resource specific properties properties: availabilityState: description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode readOnly: true type: string x-ms-enum: modelAsString: false name: SiteAvailabilityState clientAffinityEnabled: description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. type: boolean clientCertEnabled: description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. type: boolean clientCertExclusionPaths: description: client certificate authentication comma-separated exclusion paths type: string cloningInfo: description: Information needed for cloning operation. properties: appSettingsOverrides: additionalProperties: type: string description: "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained." type: object cloneCustomHostNames: description: true to clone custom hostnames from source app; otherwise, false. type: boolean cloneSourceControl: description: true to clone source control from source app; otherwise, false. type: boolean configureLoadBalancing: description: true to configure load balancing for source and destination app. type: boolean correlationId: description: "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot." example: 00000000-0000-0000-0000-000000000000 format: uuid type: string hostingEnvironment: description: App Service Environment. type: string overwrite: description: true to overwrite destination app; otherwise, false. type: boolean sourceWebAppId: description: "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots." type: string sourceWebAppLocation: description: 'Location of source app ex: West US or North Europe' type: string trafficManagerProfileId: description: "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}." type: string trafficManagerProfileName: description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. type: string required: - sourceWebAppId type: object containerSize: description: Size of the function container. format: int32 type: integer dailyMemoryTimeQuota: description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). format: int32 type: integer defaultHostName: description: Default hostname of the app. Read-only. readOnly: true type: string enabled: description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). type: boolean enabledHostNames: description: "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames." items: type: string readOnly: true type: array hostNameSslStates: description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. items: description: SSL-enabled hostname. properties: hostType: description: Indicates whether the hostname is a standard or repository hostname. enum: - Standard - Repository type: string x-ms-enum: modelAsString: false name: HostType name: description: Hostname. type: string sslState: description: SSL type. enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: modelAsString: false name: SslState thumbprint: description: SSL certificate thumbprint. type: string toUpdate: description: Set to true to update existing hostname. type: boolean virtualIP: description: Virtual IP address assigned to the hostname if IP based SSL is enabled. type: string type: object type: array hostNames: description: Hostnames associated with the app. items: type: string readOnly: true type: array hostNamesDisabled: description: "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process." type: boolean hostingEnvironmentProfile: description: Specification for an App Service Environment to use for this resource. properties: id: description: Resource ID of the App Service Environment. type: string name: description: Name of the App Service Environment. readOnly: true type: string type: description: Resource type of the App Service Environment. readOnly: true type: string type: object httpsOnly: description: "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests" type: boolean hyperV: default: false description: Hyper-V sandbox. type: boolean x-ms-mutability: - create - read inProgressOperationId: description: Specifies an operation id if this site has a pending operation. example: 00000000-0000-0000-0000-000000000000 format: uuid readOnly: true type: string isDefaultContainer: description: true if the app is a default container; otherwise, false. readOnly: true type: boolean isXenon: default: false description: 'Obsolete: Hyper-V sandbox.' type: boolean x-ms-mutability: - create - read lastModifiedTimeUtc: description: Last time the app was modified, in UTC. Read-only. format: date-time readOnly: true type: string maxNumberOfWorkers: description: "Maximum number of workers.\nThis only applies to Functions container." format: int32 readOnly: true type: integer outboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. readOnly: true type: string possibleOutboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. readOnly: true type: string redundancyMode: description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant type: string x-ms-enum: modelAsString: false name: RedundancyMode repositorySiteName: description: Name of the repository site. readOnly: true type: string reserved: default: false description: true if reserved; otherwise, false. type: boolean x-ms-mutability: - create - read resourceGroup: description: Name of the resource group the app belongs to. Read-only. readOnly: true type: string scmSiteAlsoStopped: default: false description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. type: boolean serverFarmId: description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' type: string siteConfig: description: Configuration of an App Service app. properties: alwaysOn: description: true if Always On is enabled; otherwise, false. type: boolean apiDefinition: description: Information about the formal API definition for the app. properties: url: description: The URL of the API definition. type: string type: object apiManagementConfig: description: Azure API management (APIM) configuration linked to the app. properties: id: description: APIM-Api Identifier. type: string type: object appCommandLine: description: App command line to launch. type: string appSettings: description: Application settings. items: description: Name value pair. properties: name: description: Pair name. type: string value: description: Pair value. type: string type: object type: array autoHealEnabled: description: true if Auto Heal is enabled; otherwise, false. type: boolean autoHealRules: description: Rules that can be defined for auto-heal. properties: actions: description: Actions which to take by the auto-heal module when a rule is triggered. properties: actionType: description: Predefined action to be taken. enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: modelAsString: false name: AutoHealActionType customAction: description: "Custom action to be executed\nwhen an auto heal rule is triggered." properties: exe: description: Executable to be run. type: string parameters: description: Parameters for the executable. type: string type: object minProcessExecutionTime: description: "Minimum time the process must execute\nbefore taking the action" type: string type: object triggers: description: Triggers for auto-heal. properties: privateBytesInKB: description: A rule based on private bytes. format: int32 type: integer requests: description: Trigger based on total requests. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string type: object slowRequests: description: Trigger based on request execution time. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string timeTaken: description: Time taken. type: string type: object statusCodes: description: A rule based on status codes. items: description: Trigger based on status code. properties: count: description: Request Count. format: int32 type: integer status: description: HTTP status code. format: int32 type: integer subStatus: description: Request Sub Status. format: int32 type: integer timeInterval: description: Time interval. type: string win32Status: description: Win32 error code. format: int32 type: integer type: object type: array type: object type: object autoSwapSlotName: description: Auto-swap slot name. type: string connectionStrings: description: Connection strings. items: description: Database connection string information. properties: connectionString: description: Connection string value. type: string name: description: Name of connection string. type: string type: description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL type: string x-ms-enum: modelAsString: false name: ConnectionStringType type: object type: array cors: description: Cross-Origin Resource Sharing (CORS) settings for the app. properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all." items: type: string type: array supportCredentials: description: "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details." type: boolean type: object defaultDocuments: description: Default documents. items: type: string type: array detailedErrorLoggingEnabled: description: true if detailed error logging is enabled; otherwise, false. type: boolean documentRoot: description: Document root. type: string experiments: description: Routing rules in production experiments. properties: rampUpRules: description: List of ramp-up rules. items: description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. properties: actionHostName: description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. type: string changeDecisionCallbackUrl: description: "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\n\ https://www.siteextensions.net/packages/TiPCallback/" type: string changeIntervalInMinutes: description: Specifies interval in minutes to reevaluate ReroutePercentage. format: int32 type: integer changeStep: description: "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl." format: double type: number maxReroutePercentage: description: Specifies upper boundary below which ReroutePercentage will stay. format: double type: number minReroutePercentage: description: Specifies lower boundary above which ReroutePercentage will stay. format: double type: number name: description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string reroutePercentage: description: Percentage of the traffic which will be redirected to ActionHostName. format: double type: number type: object type: array type: object ftpsState: description: State of FTP / FTPS service enum: - AllAllowed - FtpsOnly - Disabled type: string x-ms-enum: modelAsString: true name: FtpsState handlerMappings: description: Handler mappings. items: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." properties: arguments: description: Command-line arguments to be passed to the script processor. type: string extension: description: Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string type: object type: array healthCheckPath: description: Health check path type: string http20Enabled: default: true description: 'Http20Enabled: configures a web site to allow clients to connect over http2.0' type: boolean httpLoggingEnabled: description: true if HTTP logging is enabled; otherwise, false. type: boolean ipSecurityRestrictions: description: IP security restrictions for main. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array javaContainer: description: Java container. type: string javaContainerVersion: description: Java container version. type: string javaVersion: description: Java version. type: string limits: description: Metric limits set on an app. properties: maxDiskSizeInMb: description: Maximum allowed disk size usage in MB. format: int64 type: integer maxMemoryInMb: description: Maximum allowed memory usage in MB. format: int64 type: integer maxPercentageCpu: description: Maximum allowed CPU usage percentage. format: double type: number type: object linuxFxVersion: description: Linux App Framework and version type: string loadBalancing: description: Site load balancing. enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: modelAsString: false name: SiteLoadBalancing localMySqlEnabled: default: false description: true to enable local MySQL; otherwise, false. type: boolean logsDirectorySizeLimit: description: HTTP logs directory size limit. format: int32 type: integer machineKey: description: MachineKey of an app. properties: decryption: description: Algorithm used for decryption. type: string decryptionKey: description: Decryption key. type: string validation: description: MachineKey validation. type: string validationKey: description: Validation key. type: string type: object managedPipelineMode: description: Managed pipeline mode. enum: - Integrated - Classic type: string x-ms-enum: modelAsString: false name: ManagedPipelineMode managedServiceIdentityId: description: Managed Service Identity Id format: int32 type: integer minTlsVersion: description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' enum: - '1.0' - '1.1' - '1.2' type: string x-ms-enum: modelAsString: true name: SupportedTlsVersions netFrameworkVersion: default: v4.6 description: .NET Framework version. type: string nodeVersion: description: Version of Node.js. type: string numberOfWorkers: description: Number of workers. format: int32 type: integer phpVersion: description: Version of PHP. type: string preWarmedInstanceCount: description: "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans" format: int32 maximum: 10 minimum: 0 type: integer publishingUsername: description: Publishing user name. type: string push: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object pythonVersion: description: Version of Python. type: string remoteDebuggingEnabled: description: true if remote debugging is enabled; otherwise, false. type: boolean remoteDebuggingVersion: description: Remote debugging version. type: string requestTracingEnabled: description: true if request tracing is enabled; otherwise, false. type: boolean requestTracingExpirationTime: description: Request tracing expiration time. format: date-time type: string scmIpSecurityRestrictions: description: IP security restrictions for scm. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array scmIpSecurityRestrictionsUseMain: description: IP security restrictions for scm to use main. type: boolean scmType: description: SCM type. enum: - None - Dropbox - Tfs - LocalGit - GitHub - CodePlexGit - CodePlexHg - BitbucketGit - BitbucketHg - ExternalGit - ExternalHg - OneDrive - VSO - VSTSRM type: string x-ms-enum: modelAsString: true name: ScmType tracingOptions: description: Tracing options. type: string use32BitWorkerProcess: description: true to use 32-bit worker process; otherwise, false. type: boolean virtualApplications: description: Virtual applications. items: description: Virtual application in an app. properties: physicalPath: description: Physical path. type: string preloadEnabled: description: true if preloading is enabled; otherwise, false. type: boolean virtualDirectories: description: Virtual directories for virtual application. items: description: Directory for virtual application. properties: physicalPath: description: Physical path. type: string virtualPath: description: Path to virtual application. type: string type: object type: array virtualPath: description: Virtual path. type: string type: object type: array vnetName: description: Virtual Network name. type: string x-ms-mutability: - create - read webSocketsEnabled: description: true if WebSocket is enabled; otherwise, false. type: boolean windowsFxVersion: description: Xenon App Framework and version type: string xManagedServiceIdentityId: description: Explicit Managed Service Identity Id format: int32 type: integer type: object slotSwapStatus: description: The status of the last successful slot swap operation. properties: destinationSlotName: description: The destination slot of the last swap operation. readOnly: true type: string sourceSlotName: description: The source slot of the last swap operation. readOnly: true type: string timestampUtc: description: The time the last successful slot swap completed. format: date-time readOnly: true type: string type: object state: description: Current state of the app. readOnly: true type: string suspendedTill: description: App suspended till in case memory-time quota is exceeded. format: date-time readOnly: true type: string targetSwapSlot: description: Specifies which deployment slot this app will swap into. Read-only. readOnly: true type: string trafficManagerHostNames: description: Azure Traffic Manager hostnames associated with the app. Read-only. items: type: string readOnly: true type: array usageState: description: State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded readOnly: true type: string x-ms-enum: modelAsString: false name: UsageState x-ms-client-flatten: true type: object '202': description: Asynchronous operation in progress. schema: allOf: - description: Azure resource. This resource is tracked in Azure Resource Manager properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string location: description: Resource Location. type: string name: description: Resource Name. readOnly: true type: string tags: additionalProperties: type: string description: Resource tags. type: object type: description: Resource type. readOnly: true type: string required: - location x-ms-azure-resource: true description: A web app, a mobile app backend, or an API app. properties: identity: description: Managed service identity. properties: principalId: description: Principal Id of managed service identity. readOnly: true type: string tenantId: description: Tenant of managed service identity. readOnly: true type: string type: description: Type of managed service identity. enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: modelAsString: false name: ManagedServiceIdentityType userAssignedIdentities: additionalProperties: properties: clientId: description: Client Id of user assigned identity readOnly: true type: string principalId: description: Principal Id of user assigned identity readOnly: true type: string type: object description: "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}" type: object type: object properties: description: Site resource specific properties properties: availabilityState: description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode readOnly: true type: string x-ms-enum: modelAsString: false name: SiteAvailabilityState clientAffinityEnabled: description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. type: boolean clientCertEnabled: description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. type: boolean clientCertExclusionPaths: description: client certificate authentication comma-separated exclusion paths type: string cloningInfo: description: Information needed for cloning operation. properties: appSettingsOverrides: additionalProperties: type: string description: "Application setting overrides for cloned app. If specified, these settings override the settings cloned \nfrom source app. Otherwise, application settings from source app are retained." type: object cloneCustomHostNames: description: true to clone custom hostnames from source app; otherwise, false. type: boolean cloneSourceControl: description: true to clone source control from source app; otherwise, false. type: boolean configureLoadBalancing: description: true to configure load balancing for source and destination app. type: boolean correlationId: description: "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot." example: 00000000-0000-0000-0000-000000000000 format: uuid type: string hostingEnvironment: description: App Service Environment. type: string overwrite: description: true to overwrite destination app; otherwise, false. type: boolean sourceWebAppId: description: "ARM resource ID of the source app. App resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots." type: string sourceWebAppLocation: description: 'Location of source app ex: West US or North Europe' type: string trafficManagerProfileId: description: "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}." type: string trafficManagerProfileName: description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. type: string required: - sourceWebAppId type: object containerSize: description: Size of the function container. format: int32 type: integer dailyMemoryTimeQuota: description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). format: int32 type: integer defaultHostName: description: Default hostname of the app. Read-only. readOnly: true type: string enabled: description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). type: boolean enabledHostNames: description: "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames." items: type: string readOnly: true type: array hostNameSslStates: description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. items: description: SSL-enabled hostname. properties: hostType: description: Indicates whether the hostname is a standard or repository hostname. enum: - Standard - Repository type: string x-ms-enum: modelAsString: false name: HostType name: description: Hostname. type: string sslState: description: SSL type. enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: modelAsString: false name: SslState thumbprint: description: SSL certificate thumbprint. type: string toUpdate: description: Set to true to update existing hostname. type: boolean virtualIP: description: Virtual IP address assigned to the hostname if IP based SSL is enabled. type: string type: object type: array hostNames: description: Hostnames associated with the app. items: type: string readOnly: true type: array hostNamesDisabled: description: "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process." type: boolean hostingEnvironmentProfile: description: Specification for an App Service Environment to use for this resource. properties: id: description: Resource ID of the App Service Environment. type: string name: description: Name of the App Service Environment. readOnly: true type: string type: description: Resource type of the App Service Environment. readOnly: true type: string type: object httpsOnly: description: "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests" type: boolean hyperV: default: false description: Hyper-V sandbox. type: boolean x-ms-mutability: - create - read inProgressOperationId: description: Specifies an operation id if this site has a pending operation. example: 00000000-0000-0000-0000-000000000000 format: uuid readOnly: true type: string isDefaultContainer: description: true if the app is a default container; otherwise, false. readOnly: true type: boolean isXenon: default: false description: 'Obsolete: Hyper-V sandbox.' type: boolean x-ms-mutability: - create - read lastModifiedTimeUtc: description: Last time the app was modified, in UTC. Read-only. format: date-time readOnly: true type: string maxNumberOfWorkers: description: "Maximum number of workers.\nThis only applies to Functions container." format: int32 readOnly: true type: integer outboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. readOnly: true type: string possibleOutboundIpAddresses: description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. readOnly: true type: string redundancyMode: description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant type: string x-ms-enum: modelAsString: false name: RedundancyMode repositorySiteName: description: Name of the repository site. readOnly: true type: string reserved: default: false description: true if reserved; otherwise, false. type: boolean x-ms-mutability: - create - read resourceGroup: description: Name of the resource group the app belongs to. Read-only. readOnly: true type: string scmSiteAlsoStopped: default: false description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. type: boolean serverFarmId: description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".' type: string siteConfig: description: Configuration of an App Service app. properties: alwaysOn: description: true if Always On is enabled; otherwise, false. type: boolean apiDefinition: description: Information about the formal API definition for the app. properties: url: description: The URL of the API definition. type: string type: object apiManagementConfig: description: Azure API management (APIM) configuration linked to the app. properties: id: description: APIM-Api Identifier. type: string type: object appCommandLine: description: App command line to launch. type: string appSettings: description: Application settings. items: description: Name value pair. properties: name: description: Pair name. type: string value: description: Pair value. type: string type: object type: array autoHealEnabled: description: true if Auto Heal is enabled; otherwise, false. type: boolean autoHealRules: description: Rules that can be defined for auto-heal. properties: actions: description: Actions which to take by the auto-heal module when a rule is triggered. properties: actionType: description: Predefined action to be taken. enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: modelAsString: false name: AutoHealActionType customAction: description: "Custom action to be executed\nwhen an auto heal rule is triggered." properties: exe: description: Executable to be run. type: string parameters: description: Parameters for the executable. type: string type: object minProcessExecutionTime: description: "Minimum time the process must execute\nbefore taking the action" type: string type: object triggers: description: Triggers for auto-heal. properties: privateBytesInKB: description: A rule based on private bytes. format: int32 type: integer requests: description: Trigger based on total requests. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string type: object slowRequests: description: Trigger based on request execution time. properties: count: description: Request Count. format: int32 type: integer timeInterval: description: Time interval. type: string timeTaken: description: Time taken. type: string type: object statusCodes: description: A rule based on status codes. items: description: Trigger based on status code. properties: count: description: Request Count. format: int32 type: integer status: description: HTTP status code. format: int32 type: integer subStatus: description: Request Sub Status. format: int32 type: integer timeInterval: description: Time interval. type: string win32Status: description: Win32 error code. format: int32 type: integer type: object type: array type: object type: object autoSwapSlotName: description: Auto-swap slot name. type: string connectionStrings: description: Connection strings. items: description: Database connection string information. properties: connectionString: description: Connection string value. type: string name: description: Name of connection string. type: string type: description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL type: string x-ms-enum: modelAsString: false name: ConnectionStringType type: object type: array cors: description: Cross-Origin Resource Sharing (CORS) settings for the app. properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all." items: type: string type: array supportCredentials: description: "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details." type: boolean type: object defaultDocuments: description: Default documents. items: type: string type: array detailedErrorLoggingEnabled: description: true if detailed error logging is enabled; otherwise, false. type: boolean documentRoot: description: Document root. type: string experiments: description: Routing rules in production experiments. properties: rampUpRules: description: List of ramp-up rules. items: description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. properties: actionHostName: description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. type: string changeDecisionCallbackUrl: description: "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\n\ https://www.siteextensions.net/packages/TiPCallback/" type: string changeIntervalInMinutes: description: Specifies interval in minutes to reevaluate ReroutePercentage. format: int32 type: integer changeStep: description: "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl." format: double type: number maxReroutePercentage: description: Specifies upper boundary below which ReroutePercentage will stay. format: double type: number minReroutePercentage: description: Specifies lower boundary above which ReroutePercentage will stay. format: double type: number name: description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string reroutePercentage: description: Percentage of the traffic which will be redirected to ActionHostName. format: double type: number type: object type: array type: object ftpsState: description: State of FTP / FTPS service enum: - AllAllowed - FtpsOnly - Disabled type: string x-ms-enum: modelAsString: true name: FtpsState handlerMappings: description: Handler mappings. items: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." properties: arguments: description: Command-line arguments to be passed to the script processor. type: string extension: description: Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string type: object type: array healthCheckPath: description: Health check path type: string http20Enabled: default: true description: 'Http20Enabled: configures a web site to allow clients to connect over http2.0' type: boolean httpLoggingEnabled: description: true if HTTP logging is enabled; otherwise, false. type: boolean ipSecurityRestrictions: description: IP security restrictions for main. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array javaContainer: description: Java container. type: string javaContainerVersion: description: Java container version. type: string javaVersion: description: Java version. type: string limits: description: Metric limits set on an app. properties: maxDiskSizeInMb: description: Maximum allowed disk size usage in MB. format: int64 type: integer maxMemoryInMb: description: Maximum allowed memory usage in MB. format: int64 type: integer maxPercentageCpu: description: Maximum allowed CPU usage percentage. format: double type: number type: object linuxFxVersion: description: Linux App Framework and version type: string loadBalancing: description: Site load balancing. enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: modelAsString: false name: SiteLoadBalancing localMySqlEnabled: default: false description: true to enable local MySQL; otherwise, false. type: boolean logsDirectorySizeLimit: description: HTTP logs directory size limit. format: int32 type: integer machineKey: description: MachineKey of an app. properties: decryption: description: Algorithm used for decryption. type: string decryptionKey: description: Decryption key. type: string validation: description: MachineKey validation. type: string validationKey: description: Validation key. type: string type: object managedPipelineMode: description: Managed pipeline mode. enum: - Integrated - Classic type: string x-ms-enum: modelAsString: false name: ManagedPipelineMode managedServiceIdentityId: description: Managed Service Identity Id format: int32 type: integer minTlsVersion: description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' enum: - '1.0' - '1.1' - '1.2' type: string x-ms-enum: modelAsString: true name: SupportedTlsVersions netFrameworkVersion: default: v4.6 description: .NET Framework version. type: string nodeVersion: description: Version of Node.js. type: string numberOfWorkers: description: Number of workers. format: int32 type: integer phpVersion: description: Version of PHP. type: string preWarmedInstanceCount: description: "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans" format: int32 maximum: 10 minimum: 0 type: integer publishingUsername: description: Publishing user name. type: string push: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object pythonVersion: description: Version of Python. type: string remoteDebuggingEnabled: description: true if remote debugging is enabled; otherwise, false. type: boolean remoteDebuggingVersion: description: Remote debugging version. type: string requestTracingEnabled: description: true if request tracing is enabled; otherwise, false. type: boolean requestTracingExpirationTime: description: Request tracing expiration time. format: date-time type: string scmIpSecurityRestrictions: description: IP security restrictions for scm. items: description: IP security restriction on an app. properties: action: description: Allow or Deny access for this IP range. type: string description: description: IP restriction rule description. type: string ipAddress: description: "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified." type: string name: description: IP restriction rule name. type: string priority: description: Priority of IP restriction rule. format: int32 type: integer subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for. type: string subnetTrafficTag: description: (internal) Subnet traffic tag format: int32 type: integer tag: description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. enum: - Default - XffProxy type: string x-ms-enum: modelAsString: false name: IpFilterTag vnetSubnetResourceId: description: Virtual network resource id type: string vnetTrafficTag: description: (internal) Vnet traffic tag format: int32 type: integer type: object type: array scmIpSecurityRestrictionsUseMain: description: IP security restrictions for scm to use main. type: boolean scmType: description: SCM type. enum: - None - Dropbox - Tfs - LocalGit - GitHub - CodePlexGit - CodePlexHg - BitbucketGit - BitbucketHg - ExternalGit - ExternalHg - OneDrive - VSO - VSTSRM type: string x-ms-enum: modelAsString: true name: ScmType tracingOptions: description: Tracing options. type: string use32BitWorkerProcess: description: true to use 32-bit worker process; otherwise, false. type: boolean virtualApplications: description: Virtual applications. items: description: Virtual application in an app. properties: physicalPath: description: Physical path. type: string preloadEnabled: description: true if preloading is enabled; otherwise, false. type: boolean virtualDirectories: description: Virtual directories for virtual application. items: description: Directory for virtual application. properties: physicalPath: description: Physical path. type: string virtualPath: description: Path to virtual application. type: string type: object type: array virtualPath: description: Virtual path. type: string type: object type: array vnetName: description: Virtual Network name. type: string x-ms-mutability: - create - read webSocketsEnabled: description: true if WebSocket is enabled; otherwise, false. type: boolean windowsFxVersion: description: Xenon App Framework and version type: string xManagedServiceIdentityId: description: Explicit Managed Service Identity Id format: int32 type: integer type: object slotSwapStatus: description: The status of the last successful slot swap operation. properties: destinationSlotName: description: The destination slot of the last swap operation. readOnly: true type: string sourceSlotName: description: The source slot of the last swap operation. readOnly: true type: string timestampUtc: description: The time the last successful slot swap completed. format: date-time readOnly: true type: string type: object state: description: Current state of the app. readOnly: true type: string suspendedTill: description: App suspended till in case memory-time quota is exceeded. format: date-time readOnly: true type: string targetSwapSlot: description: Specifies which deployment slot this app will swap into. Read-only. readOnly: true type: string trafficManagerHostNames: description: Azure Traffic Manager hostnames associated with the app. Read-only. items: type: string readOnly: true type: array usageState: description: State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded readOnly: true type: string x-ms-enum: modelAsString: false name: UsageState x-ms-client-flatten: true type: object default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Creates a New Web, Mobile, or API App in an Existing Resource Group, or Updates an Existing App. tags: - WebApps x-ms-long-running-operation: true x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname : get: description: Description for Analyze a custom hostname. operationId: WebApps_AnalyzeCustomHostname parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of web app. in: path name: name required: true type: string example: example-value - description: Custom hostname. in: query name: hostName type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CustomHostnameAnalysisResult' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Analyze a Custom Hostname. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig: post: description: Description for Applies the configuration settings from the target slot onto the current slot. operationId: WebApps_ApplySlotConfigToProduction parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: JSON object that contains the target slot name. See example. in: body name: slotSwapEntity required: true schema: $ref: '#/definitions/CsmSlotEntity' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Applies the Configuration Settings from the Target Slot Onto the Current Slot. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup: post: description: Description for Creates a backup of an app. operationId: WebApps_Backup parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: Backup configuration. You can use the JSON response from the POST action as input here. in: body name: request required: true schema: $ref: '#/definitions/BackupRequest' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Creates a Backup of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups: get: description: Description for Gets existing backups of an app. operationId: WebApps_ListBackups parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItemCollection' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets Existing Backups of an App. tags: - WebApps x-ms-pageable: nextLinkName: nextLink x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}: delete: description: Description for Deletes a backup of an app by its ID. operationId: WebApps_DeleteBackup parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: ID of the backup. in: path name: backupId required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted web app backup item. '404': description: Web app backup item does not exist. default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Deletes a Backup of an App by its ID. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: Description for Gets a backup of an app by its ID. operationId: WebApps_GetBackupStatus parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: ID of the backup. in: path name: backupId required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets a Backup of an App by its ID. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list : post: description: Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body. operationId: WebApps_ListBackupStatusSecrets parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of web app. in: path name: name required: true type: string example: example-value - description: ID of backup. in: path name: backupId required: true type: string example: example-value - description: Information on backup request. in: body name: request required: true schema: $ref: '#/definitions/BackupRequest' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets Status of a Web App Backup That May Be in Progress, Including Secrets Associated with the Backup, Such as the Azure Storage SAS URL. Also Can Be Used to Update the SAS URL for the Backup if a New URL is Passed in the Request Body. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore : post: description: Description for Restores a specific backup to another app (or deployment slot, if specified). operationId: WebApps_Restore parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: ID of the backup. in: path name: backupId required: true type: string example: example-value - description: Information on restore request . in: body name: request required: true schema: $ref: '#/definitions/RestoreRequest' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Restore operation started. '202': description: Restore operation started. default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Restores a Specific Backup to Another App (or Deployment Slot, if Specified). tags: - WebApps x-ms-long-running-operation: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config: get: description: Description for List the configurations of an app operationId: WebApps_ListConfigurations parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResourceCollection' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions List the Configurations of an App tags: - WebApps x-ms-pageable: nextLinkName: nextLink x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings: put: description: Description for Replaces the application settings of an app. operationId: WebApps_UpdateApplicationSettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: Application settings of the app. in: body name: appSettings required: true schema: $ref: '#/definitions/StringDictionary' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Replaces the Application Settings of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list : post: description: Description for Gets the application settings of an app. operationId: WebApps_ListApplicationSettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Application Settings of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings : put: description: Description for Updates the Authentication / Authorization settings associated with web app. operationId: WebApps_UpdateAuthSettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of web app. in: path name: name required: true type: string example: example-value - description: Auth settings associated with web app. in: body name: siteAuthSettings required: true schema: $ref: '#/definitions/SiteAuthSettings' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettings' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Updates the Authentication / Authorization Settings Associated with Web App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list : post: description: Description for Gets the Authentication/Authorization settings of an app. operationId: WebApps_GetAuthSettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettings' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Authentication/Authorization Settings of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts : put: description: Description for Updates the Azure storage account configurations of an app. operationId: WebApps_UpdateAzureStorageAccounts parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: Azure storage accounts of the app. in: body name: azureStorageAccounts required: true schema: $ref: '#/definitions/AzureStoragePropertyDictionaryResource' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/AzureStoragePropertyDictionaryResource' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Updates the Azure Storage Account Configurations of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list : post: description: Description for Gets the Azure storage account configurations of an app. operationId: WebApps_ListAzureStorageAccounts parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/AzureStoragePropertyDictionaryResource' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Azure Storage Account Configurations of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup: delete: description: Description for Deletes the backup configuration of an app. operationId: WebApps_DeleteBackupConfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted backup configuration. default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Deletes the Backup Configuration of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: Description for Updates the backup configuration of an app. operationId: WebApps_UpdateBackupConfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: Edited backup configuration. in: body name: request required: true schema: $ref: '#/definitions/BackupRequest' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupRequest' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Updates the Backup Configuration of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list: post: description: Description for Gets the backup configuration of an app. operationId: WebApps_GetBackupConfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupRequest' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Backup Configuration of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings : get: description: Description for Gets the config reference app settings and status of an app operationId: WebApps_GetAppSettingsKeyVaultReferences parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/KeyVaultReferenceCollection' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Config Reference App Settings and Status of an App tags: - WebApps x-ms-examples: Get Azure Key Vault references for app settings: parameters: api-version: '2019-08-01' name: tests346 resourceGroupName: testrg123 subscriptionId: 34adfa4f-cedf-4dc0-ba29-b6d1a69ab345 responses: '200': body: id: /subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/config/configreferences/appsettings name: testc6282 properties: keyToReferenceStatuses: ref1: details: Some Details identityType: None location: ApplicationSetting reference: referenceName secretName: testsec579 secretVersion: '239' source: KeyVault status: Resolved vaultName: testkv124 type: Microsoft.Web/sites/config/appsettings headers: {} x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings/{appSettingKey} : get: description: Description for Gets the config reference and status of an app operationId: WebApps_GetAppSettingKeyVaultReference parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: App Setting key name. in: path name: appSettingKey required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/KeyVaultReferenceResource' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Config Reference and Status of an App tags: - WebApps x-ms-examples: Get Azure Key Vault app setting reference: parameters: api-version: '2019-08-01' appSettingKey: ref1 name: tests346 resourceGroupName: testrg123 subscriptionId: 34adfa4f-cedf-4dc0-ba29-b6d1a69ab345 responses: '200': body: id: /subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/config/configreferences/appsettings/ref1 name: testc6282 properties: details: Some Details identityType: None location: ApplicationSetting reference: referenceName secretName: testsec579 secretVersion: '239' source: KeyVault status: Resolved vaultName: testkv124 type: Microsoft.Web/sites/config/appsettings headers: {} x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings : put: description: Description for Replaces the connection strings of an app. operationId: WebApps_UpdateConnectionStrings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: Connection strings of the app or deployment slot. See example. in: body name: connectionStrings required: true schema: $ref: '#/definitions/ConnectionStringDictionary' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConnectionStringDictionary' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Replaces the Connection Strings of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list : post: description: Description for Gets the connection strings of an app. operationId: WebApps_ListConnectionStrings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConnectionStringDictionary' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Connection Strings of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs: get: description: Description for Gets the logging configuration of an app. operationId: WebApps_GetDiagnosticLogsConfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteLogsConfig' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Logging Configuration of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: Description for Updates the logging configuration of an app. operationId: WebApps_UpdateDiagnosticLogsConfig parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties" property. in: body name: siteLogsConfig required: true schema: $ref: '#/definitions/SiteLogsConfig' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteLogsConfig' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Updates the Logging Configuration of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata: put: description: Description for Replaces the metadata of an app. operationId: WebApps_UpdateMetadata parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: Edited metadata of the app or deployment slot. See example. in: body name: metadata required: true schema: $ref: '#/definitions/StringDictionary' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Replaces the Metadata of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list : post: description: Description for Gets the metadata of an app. operationId: WebApps_ListMetadata parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StringDictionary' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Metadata of an App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list : post: description: Description for Gets the Git/FTP publishing credentials of an app. operationId: WebApps_ListPublishingCredentials parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: User credentials used for publishing activity. properties: properties: description: User resource specific properties properties: publishingPassword: description: Password used for publishing. format: password type: string publishingPasswordHash: description: Password hash used for publishing. format: password type: string publishingPasswordHashSalt: description: Password hash salt used for publishing. format: password type: string publishingUserName: description: Username used for publishing. type: string scmUri: description: Url of SCM site. type: string required: - publishingUserName x-ms-client-flatten: true type: object default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Git/FTP Publishing Credentials of an App. tags: - WebApps x-ms-long-running-operation: true x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings : put: description: Description for Updates the Push settings associated with web app. operationId: WebApps_UpdateSitePushSettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of web app. in: path name: name required: true type: string example: example-value - description: Push settings associated with web app. in: body name: pushSettings required: true schema: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Updates the Push Settings Associated with Web App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list : post: description: Description for Gets the Push settings associated with web app. operationId: WebApps_ListSitePushSettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of web app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Push settings for the App. properties: properties: description: PushSettings resource specific properties properties: dynamicTagsJson: description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. type: string isPushEnabled: description: Gets or sets a flag indicating whether the Push endpoint is enabled. type: boolean tagWhitelistJson: description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. type: string tagsRequiringAuth: description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler." type: string required: - isPushEnabled x-ms-client-flatten: true type: object default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Push Settings Associated with Web App. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames : get: description: Description for Gets the names of app settings and connection strings that stick to the slot (not swapped). operationId: WebApps_ListSlotConfigurationNames parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SlotConfigNamesResource' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Gets the Names of App Settings and Connection Strings That Stick to the Slot (not Swapped). tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: Description for Updates the names of application settings and connection string that remain with the slot during swap operation. operationId: WebApps_UpdateSlotConfigurationNames parameters: - $ref: '#/parameters/resourceGroupNameParameter' - description: Name of the app. in: path name: name required: true type: string example: example-value - description: Names of application settings and connection strings. See example. in: body name: slotConfigNames required: true schema: $ref: '#/definitions/SlotConfigNamesResource' example: example-value - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SlotConfigNamesResource' default: description: App Service error response. schema: description: App Service error response. properties: error: description: Error model. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string details: items: description: Detailed errors. properties: code: description: Standardized string to programmatically identify the error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: array innererror: description: More information to debug error. readOnly: true type: string message: description: Detailed error description and debugging information. readOnly: true type: string target: description: Detailed error description and debugging information. readOnly: true type: string readOnly: true type: object type: object summary: Azure Functions Updates the Names of Application Settings and Connection String That Remain with the Slot During Swap Operation. tags: - WebApps x-microcks-operation: delay: 0 dispatcher: FALLBACK definitions: ApiKVReference: description: Description of site key vault references. properties: details: type: string identityType: enum: - None - SystemAssigned - UserAssigned type: string x-ms-enum: modelAsString: false name: ManagedServiceIdentityType location: enum: - ApplicationSetting type: string x-ms-enum: modelAsString: false name: ConfigReferenceLocation reference: type: string secretName: type: string secretVersion: type: string source: enum: - KeyVault type: string x-ms-enum: modelAsString: false name: ConfigReferenceSource status: enum: - Initialized - Resolved - InvalidSyntax - MSINotEnabled - VaultNotFound - SecretNotFound - SecretVersionNotFound - AccessToKeyVaultDenied - OtherReasons type: string x-ms-enum: modelAsString: false name: ResolveStatus vaultName: type: string type: object ApplicationLogsConfig: description: Application logs configuration. properties: azureBlobStorage: $ref: '#/definitions/AzureBlobStorageApplicationLogsConfig' description: Application logs to blob storage configuration. azureTableStorage: $ref: '#/definitions/AzureTableStorageApplicationLogsConfig' description: Application logs to azure table storage configuration. fileSystem: $ref: '#/definitions/FileSystemApplicationLogsConfig' description: Application logs to file system configuration. type: object AzureBlobStorageApplicationLogsConfig: description: Application logs azure blob storage configuration. properties: level: description: Log level. enum: - Off - Verbose - Information - Warning - Error type: string x-ms-enum: modelAsString: false name: LogLevel retentionInDays: description: "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention." format: int32 type: integer sasUrl: description: SAS url to a azure blob container with read/write/list/delete permissions. type: string type: object AzureBlobStorageHttpLogsConfig: description: Http logs to azure blob storage configuration. properties: enabled: description: True if configuration is enabled, false if it is disabled and null if configuration is not set. type: boolean retentionInDays: description: "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention." format: int32 type: integer sasUrl: description: SAS url to a azure blob container with read/write/list/delete permissions. type: string type: object AzureStorageInfoValue: description: Azure Files or Blob Storage access information value for dictionary storage. properties: accessKey: description: Access key for the storage account. type: string accountName: description: Name of the storage account. type: string mountPath: description: Path to mount the storage within the site's runtime environment. type: string shareName: description: Name of the file share (container name, for Blob storage). type: string state: description: State of the storage account. enum: - Ok - InvalidCredentials - InvalidShare readOnly: true type: string x-ms-enum: modelAsString: false name: AzureStorageState type: description: Type of storage. enum: - AzureFiles - AzureBlob type: string x-ms-enum: modelAsString: false name: AzureStorageType type: object AzureStoragePropertyDictionaryResource: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: AzureStorageInfo dictionary resource. properties: properties: additionalProperties: $ref: '#/definitions/AzureStorageInfoValue' description: Azure storage accounts. type: object x-ms-client-flatten: true type: object AzureTableStorageApplicationLogsConfig: description: Application logs to Azure table storage configuration. properties: level: description: Log level. enum: - Off - Verbose - Information - Warning - Error type: string x-ms-enum: modelAsString: false name: LogLevel sasUrl: description: SAS URL to an Azure table with add/query/delete permissions. type: string required: - sasUrl type: object BackupItem: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Backup description. properties: properties: description: BackupItem resource specific properties properties: blobName: description: Name of the blob which contains data for this backup. readOnly: true type: string correlationId: description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. readOnly: true type: string created: description: Timestamp of the backup creation. format: date-time readOnly: true type: string databases: description: List of databases included in the backup. items: $ref: '#/definitions/DatabaseBackupSetting' readOnly: true type: array finishedTimeStamp: description: Timestamp when this backup finished. format: date-time readOnly: true type: string id: description: Id of the backup. format: int32 readOnly: true type: integer x-ms-client-name: BackupId lastRestoreTimeStamp: description: Timestamp of a last restore operation which used this backup. format: date-time readOnly: true type: string log: description: Details regarding this backup. Might contain an error message. readOnly: true type: string name: description: Name of this backup. readOnly: true type: string scheduled: description: True if this backup has been created due to a schedule being triggered. readOnly: true type: boolean sizeInBytes: description: Size of the backup in bytes. format: int64 readOnly: true type: integer status: description: Backup status. enum: - InProgress - Failed - Succeeded - TimedOut - Created - Skipped - PartiallySucceeded - DeleteInProgress - DeleteFailed - Deleted readOnly: true type: string x-ms-enum: modelAsString: false name: BackupItemStatus storageAccountUrl: description: SAS URL for the storage account container which contains this backup. readOnly: true type: string websiteSizeInBytes: description: Size of the original web app which has been backed up. format: int64 readOnly: true type: integer x-ms-client-flatten: true type: object BackupItemCollection: description: Collection of backup items. properties: nextLink: description: Link to next page of resources. readOnly: true type: string value: description: Collection of resources. items: $ref: '#/definitions/BackupItem' type: array required: - value type: object BackupRequest: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Description of a backup which will be performed. properties: properties: description: BackupRequest resource specific properties properties: backupName: description: Name of the backup. type: string backupSchedule: $ref: '#/definitions/BackupSchedule' description: Schedule for the backup if it is executed periodically. databases: description: Databases included in the backup. items: $ref: '#/definitions/DatabaseBackupSetting' type: array enabled: description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. type: boolean storageAccountUrl: description: SAS URL to the container. type: string required: - storageAccountUrl x-ms-client-flatten: true type: object BackupSchedule: description: Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. properties: frequencyInterval: default: 7 description: 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) format: int32 type: integer frequencyUnit: default: Day description: 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) enum: - Day - Hour type: string x-ms-enum: modelAsString: false name: FrequencyUnit keepAtLeastOneBackup: default: true description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. type: boolean lastExecutionTime: description: Last time when this schedule was triggered. format: date-time readOnly: true type: string retentionPeriodInDays: default: 30 description: After how many days backups should be deleted. format: int32 type: integer startTime: description: When the schedule should start working. format: date-time type: string required: - frequencyInterval - frequencyUnit - keepAtLeastOneBackup - retentionPeriodInDays type: object ConnStringValueTypePair: description: Database connection string value to type pair. properties: type: description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL type: string x-ms-enum: modelAsString: false name: ConnectionStringType value: description: Value of pair. type: string required: - value - type type: object ConnectionStringDictionary: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: String dictionary resource. properties: properties: additionalProperties: $ref: '#/definitions/ConnStringValueTypePair' description: Connection strings. type: object x-ms-client-flatten: true type: object ContainerCpuStatistics: properties: cpuUsage: $ref: '#/definitions/ContainerCpuUsage' onlineCpuCount: format: int32 type: integer systemCpuUsage: format: int64 type: integer throttlingData: $ref: '#/definitions/ContainerThrottlingData' type: object ContainerCpuUsage: properties: kernelModeUsage: format: int64 type: integer perCpuUsage: items: format: int64 type: integer type: array totalUsage: format: int64 type: integer userModeUsage: format: int64 type: integer type: object ContainerInfo: properties: currentCpuStats: $ref: '#/definitions/ContainerCpuStatistics' currentTimeStamp: format: date-time type: string eth0: $ref: '#/definitions/ContainerNetworkInterfaceStatistics' id: type: string memoryStats: $ref: '#/definitions/ContainerMemoryStatistics' name: type: string previousCpuStats: $ref: '#/definitions/ContainerCpuStatistics' previousTimeStamp: format: date-time type: string type: object ContainerMemoryStatistics: properties: limit: format: int64 type: integer maxUsage: format: int64 type: integer usage: format: int64 type: integer type: object ContainerNetworkInterfaceStatistics: properties: rxBytes: format: int64 type: integer rxDropped: format: int64 type: integer rxErrors: format: int64 type: integer rxPackets: format: int64 type: integer txBytes: format: int64 type: integer txDropped: format: int64 type: integer txErrors: format: int64 type: integer txPackets: format: int64 type: integer type: object ContainerThrottlingData: properties: periods: format: int32 type: integer throttledPeriods: format: int32 type: integer throttledTime: format: int32 type: integer type: object ContinuousWebJob: allOf: - description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager. properties: id: description: Resource Id. readOnly: true type: string kind: description: Kind of resource. type: string name: description: Resource Name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true description: Continuous Web Job Information. properties: properties: description: ContinuousWebJob resource specific properties properties: detailed_status: description: Detailed status. type: string error: description: Error information. type: string extra_info_url: description: Extra Info URL. type: string log_url: description: Log URL. type: string run_command: description: Run command. type: string settings: additionalProperties: type: object description: Job settings. type: object status: description: Job status. enum: - Initializing - Starting - Running - PendingRestart - Stopped type: string x-ms-enum: modelAsString: false name: ContinuousWebJobStatus url: description: Job URL. type: string using_sdk: description: Using SDK? type: boolean web_job_type: description: Job type. enum: - Continuous - Triggered type: string x-ms-enum: modelAsString: false name: WebJobType x-ms-client-flatten: true type: object