To Slot Definition

8/1/2022by admin

-->

Copies a deployment slot to another deployment slot of an app.
Description for Copies a deployment slot to another deployment slot of an app.

URI Parameters

Name	In	Required	Type	Description
path	True	string	Name of the app.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-w._()]+[^.]$`
path	True	string	Name of the source slot. If a slot is not specified, the production slot is used as the source slot.
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
query	True	string	API Version

Slot: 1 n a small slit (as for inserting a coin or depositing mail) “he put a quarter in the slot ” Types: coin slot a slot through which coins can be inserted into a slot machine mail slot a slot (usually in a door) through which mail can be delivered Type of: slit a long narrow opening n a time assigned on a schedule or agenda “the TV. Definition of SLOT (noun): long narrow hole that something fits into; time when something is arranged to happen; job someone has as part of team.

Request Body

Name	Required	Type	Description
siteConfig	True	The site object which will be merged with the source slot siteto produce new destination slot site object.`null` to just copy source slot content. Otherwise a `Site`object with properties to override source slot site.
targetSlot	True	string	Destination deployment slot during copy operation.

Responses

Name	Type	Description
200 OK	OK.
202 Accepted	Operation is in progress.
Other Status Codes	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Copy slot

Sample Request

Definitions

ApiDefinitionInfo	Information about the formal API definition for the app.
ApiManagementConfig	Azure API management (APIM) configuration linked to the app.
AutoHealActions	Actions which to take by the auto-heal module when a rule is triggered.
AutoHealActionType	Predefined action to be taken.
AutoHealCustomAction	Custom action to be executedwhen an auto heal rule is triggered.
AutoHealRules	Rules that can be defined for auto-heal.
AutoHealTriggers	Triggers for auto-heal.
ConnectionStringType	Type of database.
ConnStringInfo	Database connection string information.
CorsSettings	Cross-Origin Resource Sharing (CORS) settings for the app.
CsmCopySlotEntity	Copy deployment slot parameters.
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
Experiments	Routing rules in production experiments.
FtpsState	State of FTP / FTPS service
HandlerMapping	The IIS handler mappings used to define which handler processes HTTP requests with certain extension.For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.
IpFilterTag	Defines what this IP filter will be used for. This is to support IP filtering on proxies.
IpSecurityRestriction	IP security restriction on an app.
ManagedPipelineMode	Managed pipeline mode.
NameValuePair	Name value pair.
PushSettings	Push settings for the App.
RampUpRule	Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.
RequestsBasedTrigger	Trigger based on total requests.
ScmType	SCM type.
SiteConfig	Configuration of an App Service app.
SiteLimits	Metric limits set on an app.
SiteLoadBalancing	Site load balancing.
SiteMachineKey	MachineKey of an app.
SlowRequestsBasedTrigger	Trigger based on request execution time.
StatusCodesBasedTrigger	Trigger based on status code.
SupportedTlsVersions	MinTlsVersion: configures the minimum version of TLS required for SSL requests
VirtualApplication	Virtual application in an app.
VirtualDirectory	Directory for virtual application.

ApiDefinitionInfo

Information about the formal API definition for the app.

Name	Type	Description
url	string	The URL of the API definition.

ApiManagementConfig

Azure API management (APIM) configuration linked to the app.

Name	Type	Description
id	string	APIM-Api Identifier.

AutoHealActions

Actions which to take by the auto-heal module when a rule is triggered.

Name	Type	Description
actionType	Predefined action to be taken.
customAction	Custom action to be taken.
minProcessExecutionTime	string	Minimum time the process must executebefore taking the action

AutoHealActionType

Predefined action to be taken.

Name	Type	Description
CustomAction	string
LogEvent	string
Recycle	string

AutoHealCustomAction

Custom action to be executedwhen an auto heal rule is triggered.

Name	Type	Description
exe	string	Executable to be run.
parameters	string	Parameters for the executable.

AutoHealRules

Rules that can be defined for auto-heal.

Name	Type	Description
actions	Actions to be executed when a rule is triggered.
triggers	Conditions that describe when to execute the auto-heal actions.

AutoHealTriggers

Triggers for auto-heal.

Name	Type	Description
privateBytesInKB	integer	A rule based on private bytes.
requests	A rule based on total requests.
slowRequests	A rule based on request execution time.
statusCodes	StatusCodesBasedTrigger[]	A rule based on status codes.

ConnectionStringType

Type of database.

Name	Type	Description
ApiHub	string
Custom	string
DocDb	string
EventHub	string
MySql	string
NotificationHub	string
PostgreSQL	string
RedisCache	string
SQLAzure	string
SQLServer	string
ServiceBus	string

ConnStringInfo

Database connection string information.

Name	Type	Description
connectionString	string	Connection string value.
name	string	Name of connection string.
type	Type of database.

CorsSettings

Cross-Origin Resource Sharing (CORS) settings for the app.

Name	Type	Description
allowedOrigins	string[]	Gets or sets the list of origins that should be allowed to make cross-origincalls (for example: http://example.com:12345). Use '*' to allow all.
supportCredentials	boolean	Gets or sets whether CORS requests with credentials are allowed. Seehttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentialsfor more details.

CsmCopySlotEntity

Copy deployment slot parameters.

Name	Type	Description
siteConfig	The site object which will be merged with the source slot siteto produce new destination slot site object.`null` to just copy source slot content. Otherwise a `Site`object with properties to override source slot site.
targetSlot	string	Destination deployment slot during copy operation.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Experiments

Routing rules in production experiments.

Name	Type	Description
rampUpRules	RampUpRule[]	List of ramp-up rules.

FtpsState

State of FTP / FTPS service

Name	Type	Description
AllAllowed	string
Disabled	string
FtpsOnly	string

HandlerMapping

The IIS handler mappings used to define which handler processes HTTP requests with certain extension.For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.

Name	Type	Description
arguments	string	Command-line arguments to be passed to the script processor.
extension	string	Requests with this extension will be handled using the specified FastCGI application.
scriptProcessor	string	The absolute path to the FastCGI application.

IpFilterTag

Defines what this IP filter will be used for. This is to support IP filtering on proxies.

Name	Type	Description
Default	string
XffProxy	string

IpSecurityRestriction

IP security restriction on an app.

Name	Type	Description
action	string	Allow or Deny access for this IP range.
description	string	IP restriction rule description.
ipAddress	string	IP address the security restriction is valid for.It can be in form of pure ipv4 address (required SubnetMask property) orCIDR notation such as ipv4/mask (leading bit match). For CIDR,SubnetMask property must not be specified.
name	string	IP restriction rule name.
priority	integer	Priority of IP restriction rule.
subnetMask	string	Subnet mask for the range of IP addresses the restriction is valid for.
subnetTrafficTag	integer	(internal) Subnet traffic tag
tag	Defines what this IP filter will be used for. This is to support IP filtering on proxies.
vnetSubnetResourceId	string	Virtual network resource id
vnetTrafficTag	integer	(internal) Vnet traffic tag

ManagedPipelineMode

Managed pipeline mode.

Name	Type	Description
Classic	string
Integrated	string

NameValuePair

Name value pair.

Name	Type	Description
name	string	Pair name.
value	string	Pair value.

PushSettings

Push settings for the App.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.dynamicTagsJson	string	Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.
properties.isPushEnabled	boolean	Gets or sets a flag indicating whether the Push endpoint is enabled.
properties.tagWhitelistJson	string	Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.
properties.tagsRequiringAuth	string	Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.Tags can consist of alphanumeric characters and the following:'_', '@', '#', '.', ':', '-'.Validation should be performed at the PushRequestHandler.
type	string	Resource type.

RampUpRule

Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.

Name	Type	Description
actionHostName	string	Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
changeDecisionCallbackUrl	string	Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.https://www.siteextensions.net/packages/TiPCallback/
changeIntervalInMinutes	integer	Specifies interval in minutes to reevaluate ReroutePercentage.
changeStep	number	In auto ramp up scenario this is the step to add/remove from `ReroutePercentage` until it reaches n`MinReroutePercentage` or`MaxReroutePercentage`. Site metrics are checked every N minutes specified in `ChangeIntervalInMinutes`.nCustom decision algorithmcan be provided in TiPCallback site extension which URL can be specified in `ChangeDecisionCallbackUrl`.
maxReroutePercentage	number	Specifies upper boundary below which ReroutePercentage will stay.
minReroutePercentage	number	Specifies lower boundary above which ReroutePercentage will stay.
name	string	Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.
reroutePercentage	number	Percentage of the traffic which will be redirected to `ActionHostName`.

RequestsBasedTrigger

Trigger based on total requests.

Name	Type	Description
count	integer	Request Count.
timeInterval	string	Time interval.

ScmType

SCM type.

Name	Type	Description
BitbucketGit	string
BitbucketHg	string
CodePlexGit	string
CodePlexHg	string
Dropbox	string
ExternalGit	string
ExternalHg	string
GitHub	string
LocalGit	string
None	string
OneDrive	string
Tfs	string
VSO	string
VSTSRM	string

SiteConfig