WebFunctions

Functions

Link copied to clipboard

Description for Get the properties of an App Service Environment. Azure REST API version: 2022-09-01. Other available API versions: 2019-08-01, 2020-10-01, 2021-01-15.

Link copied to clipboard

Description for Get an App Service plan. Azure REST API version: 2022-09-01. Other available API versions: 2016-09-01, 2020-10-01.

suspend fun getAppServicePlan(name: String, resourceGroupName: String): GetAppServicePlanResult
Link copied to clipboard

Description for Get a certificate. Azure REST API version: 2022-09-01. Other available API versions: 2015-08-01, 2016-03-01, 2020-10-01.

suspend fun getCertificate(name: String, resourceGroupName: String): GetCertificateResult
Link copied to clipboard

Get a specific connection Azure REST API version: 2016-06-01. Other available API versions: 2015-08-01-preview.

suspend fun getConnection(connectionName: String, resourceGroupName: String, subscriptionId: String? = null): GetConnectionResult
Link copied to clipboard

Gets a specific gateway under a subscription and in a specific resource group Azure REST API version: 2016-06-01.

suspend fun getConnectionGateway(connectionGatewayName: String, resourceGroupName: String, subscriptionId: String? = null): GetConnectionGatewayResult
Link copied to clipboard

Gets a custom API by name for a specific subscription and resource group Azure REST API version: 2016-06-01.

suspend fun getCustomApi(apiName: String, resourceGroupName: String, subscriptionId: String? = null): GetCustomApiResult
Link copied to clipboard

Description for Get the properties of a Kubernetes Environment. Azure REST API version: 2022-09-01.

suspend fun getKubeEnvironment(name: String, resourceGroupName: String): GetKubeEnvironmentResult
Link copied to clipboard

Description for Gets the details of a static site. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01, 2021-02-01.

suspend fun getStaticSite(name: String, resourceGroupName: String): GetStaticSiteResult
Link copied to clipboard

Description for Gets an existing custom domain for a particular static site. Azure REST API version: 2022-09-01.

suspend fun getStaticSiteCustomDomain(domainName: String, name: String, resourceGroupName: String): GetStaticSiteCustomDomainResult
Link copied to clipboard

Static Site Database Connection resource. Azure REST API version: 2022-09-01.

suspend fun getStaticSiteDatabaseConnection(databaseConnectionName: String, name: String, resourceGroupName: String): GetStaticSiteDatabaseConnectionResult
Link copied to clipboard

Static Site Linked Backend ARM resource. Azure REST API version: 2022-09-01.

suspend fun getStaticSiteLinkedBackend(linkedBackendName: String, name: String, resourceGroupName: String): GetStaticSiteLinkedBackendResult
Link copied to clipboard
Link copied to clipboard

Description for Gets the details of a web, mobile, or API app. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2018-11-01, 2020-10-01.

suspend fun getWebApp(argument: suspend GetWebAppPlainArgsBuilder.() -> Unit): GetWebAppResult
suspend fun getWebApp(name: String, resourceGroupName: String): GetWebAppResult
Link copied to clipboard

Description for Get a deployment by its ID for an app, or a deployment slot. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppDeployment(id: String, name: String, resourceGroupName: String): GetWebAppDeploymentResult
Link copied to clipboard

Description for Get a deployment by its ID for an app, or a deployment slot. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppDeploymentSlot(id: String, name: String, resourceGroupName: String, slot: String): GetWebAppDeploymentSlotResult
Link copied to clipboard

Description for Gets the logging configuration of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Get domain ownership identifier for web app. Azure REST API version: 2022-09-01. Other available API versions: 2018-11-01, 2020-10-01.

suspend fun getWebAppDomainOwnershipIdentifier(domainOwnershipIdentifierName: String, name: String, resourceGroupName: String): GetWebAppDomainOwnershipIdentifierResult
Link copied to clipboard

Description for Get domain ownership identifier for web app. Azure REST API version: 2022-09-01. Other available API versions: 2018-11-01, 2020-10-01.

suspend fun getWebAppDomainOwnershipIdentifierSlot(domainOwnershipIdentifierName: String, name: String, resourceGroupName: String, slot: String): GetWebAppDomainOwnershipIdentifierSlotResult
Link copied to clipboard

Description for Returns whether FTP is allowed on the site or not. Azure REST API version: 2022-09-01. Other available API versions: 2019-08-01, 2020-06-01, 2020-09-01, 2020-10-01, 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01.

suspend fun getWebAppFtpAllowed(name: String, resourceGroupName: String): GetWebAppFtpAllowedResult
Link copied to clipboard

Description for Get function information by its ID for web site, or a deployment slot. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2020-10-01.

suspend fun getWebAppFunction(functionName: String, name: String, resourceGroupName: String): GetWebAppFunctionResult
Link copied to clipboard

Description for Get the named hostname binding for an app (or deployment slot, if specified). Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppHostNameBinding(hostName: String, name: String, resourceGroupName: String): GetWebAppHostNameBindingResult
Link copied to clipboard

Description for Get the named hostname binding for an app (or deployment slot, if specified). Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppHostNameBindingSlot(hostName: String, name: String, resourceGroupName: String, slot: String): GetWebAppHostNameBindingSlotResult
Link copied to clipboard

Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppHybridConnection(name: String, namespaceName: String, relayName: String, resourceGroupName: String): GetWebAppHybridConnectionResult
Link copied to clipboard

Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppHybridConnectionSlot(name: String, namespaceName: String, relayName: String, resourceGroupName: String, slot: String): GetWebAppHybridConnectionSlotResult
Link copied to clipboard

Description for Get function information by its ID for web site, or a deployment slot. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2020-10-01.

suspend fun getWebAppInstanceFunctionSlot(functionName: String, name: String, resourceGroupName: String, slot: String): GetWebAppInstanceFunctionSlotResult
Link copied to clipboard

Description for Gets a named add-on of an app. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2020-10-01.

suspend fun getWebAppPremierAddOn(name: String, premierAddOnName: String, resourceGroupName: String): GetWebAppPremierAddOnResult
Link copied to clipboard

Description for Gets a named add-on of an app. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2020-10-01.

suspend fun getWebAppPremierAddOnSlot(name: String, premierAddOnName: String, resourceGroupName: String, slot: String): GetWebAppPremierAddOnSlotResult
Link copied to clipboard

Description for Gets a private endpoint connection Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppPrivateEndpointConnection(name: String, privateEndpointConnectionName: String, resourceGroupName: String): GetWebAppPrivateEndpointConnectionResult
Link copied to clipboard

Description for Get the named public certificate for an app (or deployment slot, if specified). Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppPublicCertificate(name: String, publicCertificateName: String, resourceGroupName: String): GetWebAppPublicCertificateResult
Link copied to clipboard

Description for Get the named public certificate for an app (or deployment slot, if specified). Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppPublicCertificateSlot(name: String, publicCertificateName: String, resourceGroupName: String, slot: String): GetWebAppPublicCertificateSlotResult
Link copied to clipboard

Description for Gets a hybrid connection configuration by its name. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Gets a hybrid connection configuration by its name. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Returns whether Scm basic auth is allowed on the site or not. Azure REST API version: 2022-09-01. Other available API versions: 2019-08-01, 2020-06-01, 2020-09-01, 2020-10-01, 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01.

suspend fun getWebAppScmAllowed(name: String, resourceGroupName: String): GetWebAppScmAllowedResult
Link copied to clipboard

Description for Get site extension information by its ID for a web site, or a deployment slot. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2020-10-01.

suspend fun getWebAppSiteExtension(name: String, resourceGroupName: String, siteExtensionId: String): GetWebAppSiteExtensionResult
Link copied to clipboard

Description for Get site extension information by its ID for a web site, or a deployment slot. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2020-10-01.

suspend fun getWebAppSiteExtensionSlot(name: String, resourceGroupName: String, siteExtensionId: String, slot: String): GetWebAppSiteExtensionSlotResult
Link copied to clipboard

Description for Gets the details of a web, mobile, or API app. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2018-11-01, 2020-10-01.

suspend fun getWebAppSlot(name: String, resourceGroupName: String, slot: String): GetWebAppSlotResult
Link copied to clipboard

Description for Gets the names of app settings and connection strings that stick to the slot (not swapped). Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Gets the source control configuration of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppSourceControl(name: String, resourceGroupName: String): GetWebAppSourceControlResult
Link copied to clipboard

Description for Gets the source control configuration of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppSourceControlSlot(name: String, resourceGroupName: String, slot: String): GetWebAppSourceControlSlotResult
Link copied to clipboard

Description for Gets a Swift Virtual Network connection. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Gets a virtual network the app (or deployment slot) is connected to by name. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppVnetConnection(name: String, resourceGroupName: String, vnetName: String): GetWebAppVnetConnectionResult
Link copied to clipboard

Description for Gets a virtual network the app (or deployment slot) is connected to by name. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun getWebAppVnetConnectionSlot(name: String, resourceGroupName: String, slot: String, vnetName: String): GetWebAppVnetConnectionSlotResult
Link copied to clipboard

Description for Get the send key name and value of a Hybrid Connection. Azure REST API version: 2022-09-01. Other available API versions: 2016-09-01, 2020-10-01.

suspend fun listAppServicePlanHybridConnectionKeys(name: String, namespaceName: String, relayName: String, resourceGroupName: String): ListAppServicePlanHybridConnectionKeysResult
Link copied to clipboard

Lists the consent links of a connection Azure REST API version: 2016-06-01. Other available API versions: 2015-08-01-preview.

suspend fun listConnectionConsentLinks(connectionName: String, parameters: List<ConsentLinkParameterDefinition>? = null, resourceGroupName: String, subscriptionId: String? = null): ListConnectionConsentLinksResult
Link copied to clipboard

Lists connection keys. Azure REST API version: 2015-08-01-preview.

suspend fun listConnectionKeys(connectionName: String, id: String? = null, kind: String? = null, location: String? = null, name: String? = null, resourceGroupName: String, tags: Map<String, String>? = null, type: String? = null, validityTimeSpan: String? = null): ListConnectionKeysResult
Link copied to clipboard

This returns the list of interfaces in the WSDL Azure REST API version: 2016-06-01.

suspend fun listCustomApiWsdlInterfaces(content: String? = null, importMethod: Either<String, WsdlImportMethod>? = null, location: String, service: WsdlService? = null, subscriptionId: String? = null, url: String? = null): ListCustomApiWsdlInterfacesResult
Link copied to clipboard

Description for List all apps that are assigned to a hostname. Azure REST API version: 2022-09-01. Other available API versions: 2016-03-01, 2018-02-01, 2019-08-01, 2020-06-01, 2020-09-01, 2020-10-01, 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01.

Link copied to clipboard

Description for Gets the application settings of a static site. Azure REST API version: 2022-09-01. Other available API versions: 2021-02-01.

Link copied to clipboard

Description for Gets the application settings of a static site build. Azure REST API version: 2022-09-01. Other available API versions: 2021-02-01.

suspend fun listStaticSiteBuildAppSettings(environmentName: String, name: String, resourceGroupName: String): ListStaticSiteBuildAppSettingsResult
Link copied to clipboard

Description for Gets the application settings of a static site build. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01, 2021-02-01.

Link copied to clipboard

Description for Lists the roles configured for the static site. Azure REST API version: 2022-09-01. Other available API versions: 2021-02-01.

Link copied to clipboard

Description for Gets the application settings of a static site. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01, 2021-02-01.

Link copied to clipboard

Description for Lists the secrets for an existing static site. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01, 2021-02-01.

suspend fun listStaticSiteSecrets(name: String, resourceGroupName: String): ListStaticSiteSecretsResult
Link copied to clipboard

Description for Gets the list of users of a static site. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01, 2021-02-01.

suspend fun listStaticSiteUsers(authprovider: String, name: String, resourceGroupName: String): ListStaticSiteUsersResult
Link copied to clipboard

Description for Gets the application settings of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Gets the application settings of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Gets the Authentication/Authorization settings of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun listWebAppAuthSettings(name: String, resourceGroupName: String): ListWebAppAuthSettingsResult
Link copied to clipboard

Description for Gets the Authentication/Authorization settings of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun listWebAppAuthSettingsSlot(name: String, resourceGroupName: String, slot: String): ListWebAppAuthSettingsSlotResult
Link copied to clipboard

Description for Gets the Azure storage account configurations of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Gets the Azure storage account configurations of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Gets the backup configuration of an app. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2020-10-01.

Link copied to clipboard

Description for Gets the backup configuration of an app. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2020-10-01.

Link copied to clipboard

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. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2018-11-01, 2020-10-01.

suspend fun listWebAppBackupStatusSecrets(backupId: String, backupName: String? = null, backupSchedule: BackupSchedule? = null, databases: List<DatabaseBackupSetting>? = null, enabled: Boolean? = null, kind: String? = null, name: String, resourceGroupName: String, storageAccountUrl: String): ListWebAppBackupStatusSecretsResult
Link copied to clipboard

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. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2018-11-01, 2020-10-01.

suspend fun listWebAppBackupStatusSecretsSlot(backupId: String, backupName: String? = null, backupSchedule: BackupSchedule? = null, databases: List<DatabaseBackupSetting>? = null, enabled: Boolean? = null, kind: String? = null, name: String, resourceGroupName: String, slot: String, storageAccountUrl: String): ListWebAppBackupStatusSecretsSlotResult
Link copied to clipboard

Description for Gets the connection strings of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Gets the connection strings of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Get function keys for a function in a web site, or a deployment slot. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun listWebAppFunctionKeys(functionName: String, name: String, resourceGroupName: String): ListWebAppFunctionKeysResult
Link copied to clipboard

Description for Get function keys for a function in a web site, or a deployment slot. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun listWebAppFunctionKeysSlot(functionName: String, name: String, resourceGroupName: String, slot: String): ListWebAppFunctionKeysSlotResult
Link copied to clipboard

Description for Get function secrets for a function in a web site, or a deployment slot. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2020-10-01.

suspend fun listWebAppFunctionSecrets(functionName: String, name: String, resourceGroupName: String): ListWebAppFunctionSecretsResult
Link copied to clipboard

Description for Get function secrets for a function in a web site, or a deployment slot. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2020-10-01.

suspend fun listWebAppFunctionSecretsSlot(functionName: String, name: String, resourceGroupName: String, slot: String): ListWebAppFunctionSecretsSlotResult
Link copied to clipboard

Description for Get host secrets for a function app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun listWebAppHostKeys(name: String, resourceGroupName: String): ListWebAppHostKeysResult
Link copied to clipboard

Description for Get host secrets for a function app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun listWebAppHostKeysSlot(name: String, resourceGroupName: String, slot: String): ListWebAppHostKeysSlotResult
Link copied to clipboard

Gets the send key name and value for a Hybrid Connection. Azure REST API version: 2018-11-01.

suspend fun listWebAppHybridConnectionKeys(name: String, namespaceName: String, relayName: String, resourceGroupName: String): ListWebAppHybridConnectionKeysResult
Link copied to clipboard

Gets the send key name and value for a Hybrid Connection. Azure REST API version: 2018-11-01.

suspend fun listWebAppHybridConnectionKeysSlot(name: String, namespaceName: String, relayName: String, resourceGroupName: String, slot: String): ListWebAppHybridConnectionKeysSlotResult
Link copied to clipboard

Description for Gets the metadata of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun listWebAppMetadata(name: String, resourceGroupName: String): ListWebAppMetadataResult
Link copied to clipboard

Description for Gets the metadata of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun listWebAppMetadataSlot(name: String, resourceGroupName: String, slot: String): ListWebAppMetadataSlotResult
Link copied to clipboard

Description for Gets the Git/FTP publishing credentials of an app. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2018-11-01, 2020-10-01.

Link copied to clipboard

Description for Gets the Git/FTP publishing credentials of an app. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2018-11-01, 2020-10-01.

Link copied to clipboard

Description for Gets existing backups of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun listWebAppSiteBackups(name: String, resourceGroupName: String): ListWebAppSiteBackupsResult
Link copied to clipboard

Description for Gets existing backups of an app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

suspend fun listWebAppSiteBackupsSlot(name: String, resourceGroupName: String, slot: String): ListWebAppSiteBackupsSlotResult
Link copied to clipboard

Description for Gets the Push settings associated with web app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for Gets the Push settings associated with web app. Azure REST API version: 2022-09-01. Other available API versions: 2020-10-01.

Link copied to clipboard

Description for This is to allow calling via powershell and ARM template. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2018-11-01, 2020-10-01.

Link copied to clipboard

Description for This is to allow calling via powershell and ARM template. Azure REST API version: 2022-09-01. Other available API versions: 2016-08-01, 2018-11-01, 2020-10-01.

Link copied to clipboard

Get the callback URL for a workflow trigger. Azure REST API version: 2022-09-01.

suspend fun listWorkflowTriggerCallbackUrl(name: String, resourceGroupName: String, triggerName: String, workflowName: String): ListWorkflowTriggerCallbackUrlResult