Connectors Reference

Azure App Service

Azure App Service connector allows you to manage app services and server farms in your subscription.

 

Status: Production

Tier: Premium

Version: 2019-12-01

 

Actions:

Name

Summary

Subscriptions_List ([internal]string x-ms-api-version)

List subscriptions

ResourceGroups_List ([internal]string x-ms-api-version, string subscriptionId)

List resource groups

WebApps_List ([internal]string x-ms-api-version, string subscriptionId, string resourceGroupName)

List web apps

WebApp_Start ([internal]string api-version, string subscriptionId, string resourceGroupName, string webAppName)

Start web app

WebApp_Stop ([internal]string api-version, string subscriptionId, string resourceGroupName, string webAppName)

Stop web app

WebApp_Restart ([internal]string api-version, string subscriptionId, string resourceGroupName, string webAppName)

Restart web app

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

ResourceGroup

 

ResourceGroupListResult

 

Subscription

 

SubscriptionListResult

 

WebApp

 

WebAppListResult

 

 

Actions:

Subscriptions_List

Summary: List subscriptions

Description: Gets a list of all the subscriptions to which the principal has access.

 

Syntax:

AzureAppService.Subscriptions_List ([internal]string x-ms-api-version)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

ARM API version

True

 

Returns:

          Type:SubscriptionListResult

          Description: Subscription list operation response.

 

ResourceGroups_List

Summary: List resource groups

Description: Lists all the resource groups within the subscription.

 

Syntax:

AzureAppService.ResourceGroups_List ([internal]string x-ms-api-version, string subscriptionId)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

ARM API version

True

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

 

Returns:

          Type:ResourceGroupListResult

          Description: List of resource groups.

 

WebApps_List

Summary: List web apps

Description: Lists all the web apps within the resource group.

 

Syntax:

AzureAppService.WebApps_List ([internal]string x-ms-api-version, string subscriptionId, string resourceGroupName)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

Azure app service API version

True

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

 

Returns:

          Type:WebAppListResult

          Description: List of web apps.

 

WebApp_Start

Summary: Start web app

Description: Starts a web app.

 

Syntax:

AzureAppService.WebApp_Start ([internal]string api-version, string subscriptionId, string resourceGroupName, string webAppName)

 

Parameters:

Name

Type

Summary

Required

Related Action

api-version

string

(API Version)

Azure app service API version

True

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

webAppName

string

(Web App)

The name of the web app.

True

WebApps_List

 

Returns:

 

WebApp_Stop

Summary: Stop web app

Description: Stops a web app.

 

Syntax:

AzureAppService.WebApp_Stop ([internal]string api-version, string subscriptionId, string resourceGroupName, string webAppName)

 

Parameters:

Name

Type

Summary

Required

Related Action

api-version

string

(API Version)

Azure app service API version

True

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

webAppName

string

(Web App)

The name of the web app.

True

WebApps_List

 

Returns:

 

WebApp_Restart

Summary: Restart web app

Description: Restarts a web app.

 

Syntax:

AzureAppService.WebApp_Restart ([internal]string api-version, string subscriptionId, string resourceGroupName, string webAppName)

 

Parameters:

Name

Type

Summary

Required

Related Action

api-version

string

(API Version)

Azure app service API version

True

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

webAppName

string

(Web App)

The name of the web app.

True

WebApps_List

 

Returns:

 


 

ResourceGroup

Summary:

Description: Resource group information.

 

          Properties:

Name

Type

Summary

id

string

Id

The ID of the resource group.

name

string

Name

The Name of the resource group.

managedBy

string

Managed By

Id of the resource that manages this resource group.


 

ResourceGroupListResult

Summary:

Description: List of resource groups.

 

          Properties:

Name

Type

Summary

value

array of (ResourceGroup)

 

The list of resource groups.

nextLink

string

Next Link

The URL to get the next set of results.


 

Subscription

Summary:

Description: Subscription information.

 

          Properties:

Name

Type

Summary

id

string

Id

The fully qualified Id.

subscriptionId

string

Subscription Id

The subscription Id.

tenantId

string

Tenant Id

The tenant Id.

displayName

string

Display Name

The subscription display name.

state

string

State

The subscription state.  Values: [Enabled, Warned, PastDue, Disabled, Deleted]

authorizationSource

string

Authorization Source

The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'.


 

SubscriptionListResult

Summary:

Description: Subscription list operation response.

 

          Properties:

Name

Type

Summary

value

array of (Subscription)

 

The subscriptions.

nextLink

string

Next Link

The URL to get the next set of results.


 

WebApp

Summary:

Description: Web app information.

 

          Properties:

Name

Type

Summary

id

string

Id

The ID of the web app.

name

string

Name

The Name of the web app.


 

WebAppListResult

Summary:

Description: List of web apps.

 

          Properties:

Name

Type

Summary

value

array of (WebApp)

 

The list of web apps.

nextLink

string

Next Link

The URL to get the next set of results.