Web Apps - Install Site Extension Slot

  • Reference
Service:
App Service
API Version:
2024-04-01

Description for Install site extension on a web site, or a deployment slot.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}?api-version=2024-04-01

URI Parameters

Name In Required Type Description
name
 path True

string

Site name.
resourceGroupName
 path True

string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$
siteExtensionId
 path True

string

Site extension name.
slot
 path True

string

Name of the deployment slot. If a slot is not specified, the API uses the production slot.
subscriptionId
 path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version
 query True

string

API Version

Responses

Name Type Description
200 OK

SiteExtensionInfo

Site Extension created.
201 Created

SiteExtensionInfo

Site Extension created.
429 Too Many Requests

Site Extension is being installed on another request: Rejecting current request.
Other Status Codes

DefaultErrorResponse

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

Definitions

Name Description
DefaultErrorResponse

App Service error response.
Details
Error

Error model.
SiteExtensionInfo

Site Extension Information.
SiteExtensionType

Site extension type.

DefaultErrorResponse

App Service error response.

Name Type Description
error

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.

SiteExtensionInfo

Site Extension Information.

Name Type Description
id

string

Resource Id.
kind

string

Kind of resource.
name

string

Resource Name.
properties.authors

string[]

List of authors.
properties.comment

string

Site Extension comment.
properties.description

string

Detailed description.
properties.download_count

integer

Count of downloads.
properties.extension_id

string

Site extension ID.
properties.extension_type

SiteExtensionType

Site extension type.
properties.extension_url

string

Extension URL.
properties.feed_url

string

Feed URL.
properties.icon_url

string

Icon URL.
properties.installed_date_time

string

Installed timestamp.
properties.installer_command_line_params

string

Installer command line parameters.
properties.license_url

string

License URL.
properties.local_is_latest_version

boolean

true if the local version is the latest version; false otherwise.
properties.local_path

string

Local path.
properties.project_url

string

Project URL.
properties.provisioningState

string

Provisioning state.
properties.published_date_time

string

Published timestamp.
properties.summary

string

Summary description.
properties.title

string

properties.version

string

Version information.
type

string

Resource type.

SiteExtensionType

Site extension type.

Name Type Description
Gallery

string

WebRoot

string