@datafire/azure_arm_web

Client library for WebSite Management Client

Installation and Usage

npm install --save datafire @datafire/azure_arm_web

let datafire = require('datafire');
let azure_arm_web = require('@datafire/azure_arm_web').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: "",
});

azure_arm_web.Provider_GetPublishingUser({}).then(data => {
  console.log(data);
})

Description

Use these APIs to manage Azure Websites resources through the Azure Resource Manager. All task operations conform to the HTTP/1.1 protocol specification and each operation returns an x-ms-request-id header that can be used to obtain information about the request. You must make sure that requests made to these resources are secure. For more information, see https://msdn.microsoft.com/en-us/library/azure/dn790557.aspx.

Actions

Provider_GetPublishingUser

Gets publishing user

azure_arm_web.Provider_GetPublishingUser({
  "api-version": ""
}, context)

Parameters

• api-version (string) required - API Version

Provider_UpdatePublishingUser

Updates publishing user

azure_arm_web.Provider_UpdatePublishingUser({
  "requestMessage": {},
  "api-version": ""
}, context)

Parameters

• requestMessage (object) required - Represents user crendentials used for publishing activity
• api-version (string) required - API Version

Provider_GetSourceControls

Gets the source controls available for Azure websites

azure_arm_web.Provider_GetSourceControls({
  "api-version": ""
}, context)

Parameters

• api-version (string) required - API Version

Provider_GetSourceControl

Gets source control token

azure_arm_web.Provider_GetSourceControl({
  "sourceControlType": "",
  "api-version": ""
}, context)

Parameters

• sourceControlType (string) required - Type of source control
• api-version (string) required - API Version

Provider_UpdateSourceControl

Updates source control token

azure_arm_web.Provider_UpdateSourceControl({
  "sourceControlType": "",
  "requestMessage": {},
  "api-version": ""
}, context)

Parameters

• sourceControlType (string) required - Type of source control
• requestMessage (object) required - Describes the Source Control OAuth Token
• api-version (string) required - API Version

GlobalCertificateOrder_GetAllCertificateOrders

Lists all domains in a subscription

azure_arm_web.GlobalCertificateOrder_GetAllCertificateOrders({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

GlobalCertificateOrder_ValidateCertificatePurchaseInformation

Validate certificate purchase information

azure_arm_web.GlobalCertificateOrder_ValidateCertificatePurchaseInformation({
  "certificateOrder": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• certificateOrder (object) required - Certificate purchase order
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

GlobalDomainRegistration_CheckDomainAvailability

Checks if a domain is available for registration

azure_arm_web.GlobalDomainRegistration_CheckDomainAvailability({
  "identifier": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• identifier (object) required - Identifies an object
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

GlobalDomainRegistration_GetAllDomains

Lists all domains in a subscription

azure_arm_web.GlobalDomainRegistration_GetAllDomains({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

GlobalDomainRegistration_GetDomainControlCenterSsoRequest

Generates a single sign on request for domain management portal

azure_arm_web.GlobalDomainRegistration_GetDomainControlCenterSsoRequest({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

GlobalDomainRegistration_ListDomainRecommendations

Lists domain recommendations based on keywords

azure_arm_web.GlobalDomainRegistration_ListDomainRecommendations({
  "parameters": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• parameters (object) required - Domain recommendation search parameters
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

TopLevelDomains_GetGetTopLevelDomains

Lists all top level domains supported for registration

azure_arm_web.TopLevelDomains_GetGetTopLevelDomains({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

TopLevelDomains_GetTopLevelDomain

Gets details of a top level domain

azure_arm_web.TopLevelDomains_GetTopLevelDomain({
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• name (string) required - Name of the top level domain
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

TopLevelDomains_ListTopLevelDomainAgreements

Lists legal agreements that user needs to accept before purchasing domain

azure_arm_web.TopLevelDomains_ListTopLevelDomainAgreements({
  "name": "",
  "agreementOption": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• name (string) required - Name of the top level domain
• agreementOption (object) required - Options for retrieving the list of top level domain legal agreements
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

GlobalDomainRegistration_ValidateDomainPurchaseInformation

Validates domain registration information

azure_arm_web.GlobalDomainRegistration_ValidateDomainPurchaseInformation({
  "domainRegistrationInput": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• domainRegistrationInput (object) required - Domain registration input for validation Api
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_GetAllCertificates

Get all certificates for a subscription

azure_arm_web.Global_GetAllCertificates({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_CheckNameAvailability

Check if resource name is available

azure_arm_web.Global_CheckNameAvailability({
  "request": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• request (object) required - Resource name availability request content
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_GetAllClassicMobileServices

Gets all mobile services for a subscription

azure_arm_web.Global_GetAllClassicMobileServices({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_GetSubscriptionGeoRegions

Gets list of available geo regions

azure_arm_web.Global_GetSubscriptionGeoRegions({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• sku (string) - Filter only to regions that support this sku
• linuxWorkersEnabled (boolean) - Filter only to regions that support linux workers
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_GetAllHostingEnvironments

Gets all hostingEnvironments (App Service Environment) for a subscription

azure_arm_web.Global_GetAllHostingEnvironments({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_IsHostingEnvironmentNameAvailable

Whether hosting environment name is available

azure_arm_web.Global_IsHostingEnvironmentNameAvailable({
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• name (string) required - Hosting environment name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_IsHostingEnvironmentWithLegacyNameAvailable

Whether hosting environment name is available

azure_arm_web.Global_IsHostingEnvironmentWithLegacyNameAvailable({
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• name (string) required - Hosting environment name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_GetAllManagedHostingEnvironments

Gets all managed hosting environments for a subscription

azure_arm_web.Global_GetAllManagedHostingEnvironments({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_ListPremierAddOnOffers

List premier add on offers

azure_arm_web.Global_ListPremierAddOnOffers({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_GetSubscriptionPublishingCredentials

Gets publishing credentials for the subscription owner

azure_arm_web.Global_GetSubscriptionPublishingCredentials({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_UpdateSubscriptionPublishingCredentials

Updates publishing credentials for the subscription owner

azure_arm_web.Global_UpdateSubscriptionPublishingCredentials({
  "requestMessage": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• requestMessage (object) required - Represents user crendentials used for publishing activity
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Recommendations_GetRecommendationBySubscription

Gets a list of recommendations associated with the specified subscription.

azure_arm_web.Recommendations_GetRecommendationBySubscription({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• featured (boolean) - If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available
• $filter (string) - Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification'
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_GetAllServerFarms

Gets all App Service Plans for a subcription

azure_arm_web.Global_GetAllServerFarms({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• detailed (boolean) - False to return a subset of App Service Plan properties, true to return all of the properties.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Global_GetAllSites

Gets all Web Apps for a subscription

azure_arm_web.Global_GetAllSites({
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

GlobalResourceGroups_MoveResources

azure_arm_web.GlobalResourceGroups_MoveResources({
  "resourceGroupName": "",
  "moveResourceEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required
• moveResourceEnvelope (object) required - Class containing a list of the resources that need to be moved and the resource group they should be moved to
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_GetCertificateOrders

Get certificate orders in a resource group

azure_arm_web.CertificateOrders_GetCertificateOrders({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_GetCertificates

List all certificates associated with a certificate order (only one certificate can be associated with an order at a time)

azure_arm_web.CertificateOrders_GetCertificates({
  "resourceGroupName": "",
  "certificateOrderName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• certificateOrderName (string) required - Certificate name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_DeleteCertificate

Deletes the certificate associated with the certificate order

azure_arm_web.CertificateOrders_DeleteCertificate({
  "resourceGroupName": "",
  "certificateOrderName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• certificateOrderName (string) required - Certificate name
• name (string) required - Certificate name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_GetCertificate

Get certificate associated with the certificate order

azure_arm_web.CertificateOrders_GetCertificate({
  "resourceGroupName": "",
  "certificateOrderName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• certificateOrderName (string) required - Certificate name
• name (string) required - Certificate name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_UpdateCertificate

Associates a Key Vault secret to a certificate store that will be used for storing the certificate once it's ready

azure_arm_web.CertificateOrders_UpdateCertificate({
  "resourceGroupName": "",
  "certificateOrderName": "",
  "name": "",
  "keyVaultCertificate": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• certificateOrderName (string) required - Certificate name
• name (string) required - Certificate name
• keyVaultCertificate (object) required - Class representing the Key Vault container for certificate purchased through Azure
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_CreateOrUpdateCertificate

Associates a Key Vault secret to a certificate store that will be used for storing the certificate once it's ready

azure_arm_web.CertificateOrders_CreateOrUpdateCertificate({
  "resourceGroupName": "",
  "certificateOrderName": "",
  "name": "",
  "keyVaultCertificate": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• certificateOrderName (string) required - Certificate name
• name (string) required - Certificate name
• keyVaultCertificate (object) required - Class representing the Key Vault container for certificate purchased through Azure
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_DeleteCertificateOrder

Delete an existing certificate order

azure_arm_web.CertificateOrders_DeleteCertificateOrder({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• name (string) required - Certificate name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_GetCertificateOrder

Get a certificate order

azure_arm_web.CertificateOrders_GetCertificateOrder({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• name (string) required - Certificate name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_UpdateCertificateOrder

Create or update a certificate purchase order

azure_arm_web.CertificateOrders_UpdateCertificateOrder({
  "resourceGroupName": "",
  "name": "",
  "certificateDistinguishedName": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• name (string) required - Certificate name
• certificateDistinguishedName (object) required - Certificate purchase order
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_CreateOrUpdateCertificateOrder

Create or update a certificate purchase order

azure_arm_web.CertificateOrders_CreateOrUpdateCertificateOrder({
  "resourceGroupName": "",
  "name": "",
  "certificateDistinguishedName": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• name (string) required - Certificate name
• certificateDistinguishedName (object) required - Certificate purchase order
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_ReissueCertificateOrder

Reissue an existing certificate order

azure_arm_web.CertificateOrders_ReissueCertificateOrder({
  "resourceGroupName": "",
  "name": "",
  "reissueCertificateOrderRequest": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• name (string) required - Certificate name
• reissueCertificateOrderRequest (object) required - Class representing certificate reissue request
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_RenewCertificateOrder

Renew an existing certificate order

azure_arm_web.CertificateOrders_RenewCertificateOrder({
  "resourceGroupName": "",
  "name": "",
  "renewCertificateOrderRequest": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• name (string) required - Certificate name
• renewCertificateOrderRequest (object) required - Class representing certificate renew request
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_ResendCertificateEmail

Resend certificate email

azure_arm_web.CertificateOrders_ResendCertificateEmail({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• name (string) required - Certificate order name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_RetrieveCertificateActions

Retrieve the list of certificate actions

azure_arm_web.CertificateOrders_RetrieveCertificateActions({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• name (string) required - Certificate order name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_RetrieveCertificateEmailHistory

Retrive email history

azure_arm_web.CertificateOrders_RetrieveCertificateEmailHistory({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• name (string) required - Certificate order name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

CertificateOrders_VerifyDomainOwnership

Verify domain ownership for this certificate order

azure_arm_web.CertificateOrders_VerifyDomainOwnership({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Azure resource group name
• name (string) required - Certificate order name
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Domains_GetDomains

Lists domains under a resource group

azure_arm_web.Domains_GetDomains({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Domains_DeleteDomain

Deletes a domain

azure_arm_web.Domains_DeleteDomain({
  "resourceGroupName": "",
  "domainName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• domainName (string) required - Name of the domain
• forceHardDeleteDomain (boolean) - If true then the domain will be deleted immediately instead of after 24 hours
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Domains_GetDomain

Gets details of a domain

azure_arm_web.Domains_GetDomain({
  "resourceGroupName": "",
  "domainName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• domainName (string) required - Name of the domain
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Domains_UpdateDomain

Creates a domain

azure_arm_web.Domains_UpdateDomain({
  "resourceGroupName": "",
  "domainName": "",
  "domain": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - >Name of the resource group
• domainName (string) required - Name of the domain
• domain (object) required - Represents a domain
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Domains_CreateOrUpdateDomain

Creates a domain

azure_arm_web.Domains_CreateOrUpdateDomain({
  "resourceGroupName": "",
  "domainName": "",
  "domain": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - >Name of the resource group
• domainName (string) required - Name of the domain
• domain (object) required - Represents a domain
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Domains_GetDomainOperation

Retrieves the latest status of a domain purchase operation

azure_arm_web.Domains_GetDomainOperation({
  "resourceGroupName": "",
  "domainName": "",
  "operationId": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• domainName (string) required - Name of the domain
• operationId (string) required - Domain purchase operation Id
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Usage_GetUsage

Returns usage records for specified subscription and resource groups

azure_arm_web.Usage_GetUsage({
  "resourceGroupName": "",
  "environmentName": "",
  "lastId": "",
  "batchSize": 0,
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• environmentName (string) required - Environment name
• lastId (string) required - Last marker that was returned from the batch
• batchSize (integer) required - size of the batch to be returned.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Certificates_GetCertificates

Get certificates for a subscription in the specified resource group.

azure_arm_web.Certificates_GetCertificates({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Certificates_DeleteCertificate

Delete a certificate by name in a specificed subscription and resourcegroup.

azure_arm_web.Certificates_DeleteCertificate({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• name (string) required - Name of the certificate to be deleted.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Certificates_GetCertificate

Get a certificate by certificate name for a subscription in the specified resource group.

azure_arm_web.Certificates_GetCertificate({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• name (string) required - Name of the certificate.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Certificates_UpdateCertificate

Creates or modifies an existing certificate.

azure_arm_web.Certificates_UpdateCertificate({
  "resourceGroupName": "",
  "name": "",
  "certificateEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• name (string) required - Name of the certificate.
• certificateEnvelope (object) required - App certificate
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Certificates_CreateOrUpdateCertificate

Creates or modifies an existing certificate.

azure_arm_web.Certificates_CreateOrUpdateCertificate({
  "resourceGroupName": "",
  "name": "",
  "certificateEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• name (string) required - Name of the certificate.
• certificateEnvelope (object) required - App certificate
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ClassicMobileServices_GetClassicMobileServices

Get all mobile services in a resource group.

azure_arm_web.ClassicMobileServices_GetClassicMobileServices({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ClassicMobileServices_DeleteClassicMobileService

Delete a mobile service.

azure_arm_web.ClassicMobileServices_DeleteClassicMobileService({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of mobile service
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ClassicMobileServices_GetClassicMobileService

Get a mobile service.

azure_arm_web.ClassicMobileServices_GetClassicMobileService({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of mobile service
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Certificates_GetCsrs

Gets the certificate signing requests for a subscription in the specified resource group

azure_arm_web.Certificates_GetCsrs({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Certificates_DeleteCsr

Delete the certificate signing request.

azure_arm_web.Certificates_DeleteCsr({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• name (string) required - Name of the certificate signing request.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Certificates_GetCsr

Gets a certificate signing request by certificate name for a subscription in the specified resource group

azure_arm_web.Certificates_GetCsr({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• name (string) required - Name of the certificate.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Certificates_UpdateCsr

Creates or modifies an existing certificate signing request.

azure_arm_web.Certificates_UpdateCsr({
  "resourceGroupName": "",
  "name": "",
  "csrEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• name (string) required - Name of the certificate.
• csrEnvelope (object) required - Certificate signing request object
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Certificates_CreateOrUpdateCsr

Creates or modifies an existing certificate signing request.

azure_arm_web.Certificates_CreateOrUpdateCsr({
  "resourceGroupName": "",
  "name": "",
  "csrEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of the resource group
• name (string) required - Name of the certificate.
• csrEnvelope (object) required - Certificate signing request object
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

Sites_GetDeletedSites

Gets deleted web apps in subscription

azure_arm_web.Sites_GetDeletedSites({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• propertiesToInclude (string) - Additional web app properties included in the response
• includeSiteTypes (string) - Types of apps included in the response
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironments

Get all hostingEnvironments (App Service Environments) in a resource group.

azure_arm_web.HostingEnvironments_GetHostingEnvironments({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_DeleteHostingEnvironment

Delete a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_DeleteHostingEnvironment({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• forceDelete (boolean) - Delete even if the hostingEnvironment (App Service Environment) contains resources
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironment

Get properties of hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironment({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_CreateOrUpdateHostingEnvironment

Create or update a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_CreateOrUpdateHostingEnvironment({
  "resourceGroupName": "",
  "name": "",
  "hostingEnvironmentEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• hostingEnvironmentEnvelope (object) required - Description of an hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentCapacities

Get used, available, and total worker capacity for hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentCapacities({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentVips

Get IP addresses assigned to the hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentVips({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentDiagnostics

Get diagnostic information for hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentDiagnostics({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentDiagnosticsItem

Get diagnostic information for hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentDiagnosticsItem({
  "resourceGroupName": "",
  "name": "",
  "diagnosticsName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• diagnosticsName (string) required - Name of the diagnostics
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentMetricDefinitions

Get global metric definitions of hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentMetricDefinitions({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentMetrics

Get global metrics of hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentMetrics({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• details (boolean) - Include instance details
• $filter (string) - Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetMultiRolePools

Get all multi role pools

azure_arm_web.HostingEnvironments_GetMultiRolePools({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetMultiRolePool

Get properties of a multiRool pool.

azure_arm_web.HostingEnvironments_GetMultiRolePool({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_CreateOrUpdateMultiRolePool

Create or update a multiRole pool.

azure_arm_web.HostingEnvironments_CreateOrUpdateMultiRolePool({
  "resourceGroupName": "",
  "name": "",
  "multiRolePoolEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• multiRolePoolEnvelope (object) required - Worker pool of a hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetMultiRolePoolInstanceMetricDefinitions

Get metric definitions for a specific instance of a multiRole pool of a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetMultiRolePoolInstanceMetricDefinitions({
  "resourceGroupName": "",
  "name": "",
  "instance": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• instance (string) required - Name of instance in the multiRole pool>
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetMultiRolePoolInstanceMetrics

Get metrics for a specific instance of a multiRole pool of a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetMultiRolePoolInstanceMetrics({
  "resourceGroupName": "",
  "name": "",
  "instance": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• instance (string) required - Name of instance in the multiRole pool
• details (boolean) - Include instance details
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentMultiRoleMetricDefinitions

Get metric definitions for a multiRole pool of a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentMultiRoleMetricDefinitions({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentMultiRoleMetrics

Get metrics for a multiRole pool of a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentMultiRoleMetrics({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• startTime (string) - Beginning time of metrics query
• endTime (string) - End time of metrics query
• timeGrain (string) - Time granularity of metrics query
• details (boolean) - Include instance details
• $filter (string) - Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetMultiRolePoolSkus

Get available skus for scaling a multiRole pool.

azure_arm_web.HostingEnvironments_GetMultiRolePoolSkus({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentMultiRoleUsages

Get usages for a multiRole pool of a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentMultiRoleUsages({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentOperations

List all currently running operations on the hostingEnvironment (App Service Environment)

azure_arm_web.HostingEnvironments_GetHostingEnvironmentOperations({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentOperation

Get status of an operation on a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentOperation({
  "resourceGroupName": "",
  "name": "",
  "operationId": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• operationId (string) required - operation identifier GUID
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_RebootHostingEnvironment

Reboots all machines in a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_RebootHostingEnvironment({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_ResumeHostingEnvironment

Resumes the hostingEnvironment.

azure_arm_web.HostingEnvironments_ResumeHostingEnvironment({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentServerFarms

Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentServerFarms({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentSites

Get all sites on the hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentSites({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• propertiesToInclude (string) - Comma separated list of site properties to include
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_SuspendHostingEnvironment

Suspends the hostingEnvironment.

azure_arm_web.HostingEnvironments_SuspendHostingEnvironment({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentUsages

Get global usages of hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentUsages({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• $filter (string) - Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentWebHostingPlans

Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentWebHostingPlans({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetWorkerPools

Get all worker pools

azure_arm_web.HostingEnvironments_GetWorkerPools({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetWorkerPool

Get properties of a worker pool.

azure_arm_web.HostingEnvironments_GetWorkerPool({
  "resourceGroupName": "",
  "name": "",
  "workerPoolName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• workerPoolName (string) required - Name of worker pool
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_CreateOrUpdateWorkerPool

Create or update a worker pool.

azure_arm_web.HostingEnvironments_CreateOrUpdateWorkerPool({
  "resourceGroupName": "",
  "name": "",
  "workerPoolName": "",
  "workerPoolEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• workerPoolName (string) required - Name of worker pool
• workerPoolEnvelope (object) required - Worker pool of a hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetWorkerPoolInstanceMetricDefinitions

Get metric definitions for a specific instance of a worker pool of a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetWorkerPoolInstanceMetricDefinitions({
  "resourceGroupName": "",
  "name": "",
  "workerPoolName": "",
  "instance": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• workerPoolName (string) required - Name of worker pool
• instance (string) required - Name of instance in the worker pool
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetWorkerPoolInstanceMetrics

Get metrics for a specific instance of a worker pool of a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetWorkerPoolInstanceMetrics({
  "resourceGroupName": "",
  "name": "",
  "workerPoolName": "",
  "instance": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• workerPoolName (string) required - Name of worker pool
• instance (string) required - Name of instance in the worker pool
• details (boolean) - Include instance details
• $filter (string) - Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentWebWorkerMetricDefinitions

Get metric definitions for a worker pool of a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentWebWorkerMetricDefinitions({
  "resourceGroupName": "",
  "name": "",
  "workerPoolName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• workerPoolName (string) required - Name of worker pool
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentWebWorkerMetrics

Get metrics for a worker pool of a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentWebWorkerMetrics({
  "resourceGroupName": "",
  "name": "",
  "workerPoolName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• workerPoolName (string) required - Name of worker pool
• details (boolean) - Include instance details
• $filter (string) - Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetWorkerPoolSkus

Get available skus for scaling a worker pool.

azure_arm_web.HostingEnvironments_GetWorkerPoolSkus({
  "resourceGroupName": "",
  "name": "",
  "workerPoolName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• workerPoolName (string) required - Name of worker pool
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

HostingEnvironments_GetHostingEnvironmentWebWorkerUsages

Get usages for a worker pool of a hostingEnvironment (App Service Environment).

azure_arm_web.HostingEnvironments_GetHostingEnvironmentWebWorkerUsages({
  "resourceGroupName": "",
  "name": "",
  "workerPoolName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of hostingEnvironment (App Service Environment)
• workerPoolName (string) required - Name of worker pool
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ManagedHostingEnvironments_GetManagedHostingEnvironments

Get all managed hosting environments in a resource group.

azure_arm_web.ManagedHostingEnvironments_GetManagedHostingEnvironments({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ManagedHostingEnvironments_DeleteManagedHostingEnvironment

Delete a managed hosting environment.

azure_arm_web.ManagedHostingEnvironments_DeleteManagedHostingEnvironment({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of managed hosting environment
• forceDelete (boolean) - Delete even if the managed hosting environment contains resources
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ManagedHostingEnvironments_GetManagedHostingEnvironment

Get properties of a managed hosting environment.

azure_arm_web.ManagedHostingEnvironments_GetManagedHostingEnvironment({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of managed hosting environment
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ManagedHostingEnvironments_CreateOrUpdateManagedHostingEnvironment

Create or update a managed hosting environment.

azure_arm_web.ManagedHostingEnvironments_CreateOrUpdateManagedHostingEnvironment({
  "resourceGroupName": "",
  "name": "",
  "ManagedHostingEnvironmentEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of managed hosting environment
• ManagedHostingEnvironmentEnvelope (object) required - Description of an hostingEnvironment (App Service Environment)
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ManagedHostingEnvironments_GetManagedHostingEnvironmentVips

Get list of ip addresses assigned to a managed hosting environment

azure_arm_web.ManagedHostingEnvironments_GetManagedHostingEnvironmentVips({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of managed hosting environment
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ManagedHostingEnvironments_GetManagedHostingEnvironmentOperation

Get status of an operation on a managed hosting environment.

azure_arm_web.ManagedHostingEnvironments_GetManagedHostingEnvironmentOperation({
  "resourceGroupName": "",
  "name": "",
  "operationId": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of managed hosting environment
• operationId (string) required - operation identifier GUID
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ManagedHostingEnvironments_GetManagedHostingEnvironmentServerFarms

Get all serverfarms (App Service Plans) on the managed hosting environment.

azure_arm_web.ManagedHostingEnvironments_GetManagedHostingEnvironmentServerFarms({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of managed hosting environment
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ManagedHostingEnvironments_GetManagedHostingEnvironmentSites

Get all sites on the managed hosting environment.

azure_arm_web.ManagedHostingEnvironments_GetManagedHostingEnvironmentSites({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of managed hosting environment
• propertiesToInclude (string) - Comma separated list of site properties to include
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ManagedHostingEnvironments_GetManagedHostingEnvironmentWebHostingPlans

Get all serverfarms (App Service Plans) on the managed hosting environment.

azure_arm_web.ManagedHostingEnvironments_GetManagedHostingEnvironmentWebHostingPlans({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of managed hosting environment
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ServerFarms_GetServerFarms

Gets collection of App Service Plans in a resource group for a given subscription.

azure_arm_web.ServerFarms_GetServerFarms({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ServerFarms_DeleteServerFarm

Deletes a App Service Plan

azure_arm_web.ServerFarms_DeleteServerFarm({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of App Service Plan
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ServerFarms_GetServerFarm

Gets specified App Service Plan in a resource group

azure_arm_web.ServerFarms_GetServerFarm({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of App Service Plan
• subscriptionId (string) required - Subscription Id
• api-version (string) required - API Version

ServerFarms_CreateOrUpdateServerFarm

Creates or updates an App Service Plan

azure_arm_web.ServerFarms_CreateOrUpdateServerFarm({
  "resourceGroupName": "",
  "name": "",
  "serverFarmEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Parameters

• resourceGroupName (string) required - Name of resource group
• name (string) required - Name of App Service Plan
• serverFarmEnvelope (object) required - App Service Plan Model
• allowPendingState (boolean) - OBSOLETE: If true, allow pending state for App Service Plan
• subscription