@datafire/azure_web_service v5.0.0

@datafire/azure_web_service

Client library for WebSite Management Client

Installation and Usage

npm install --save @datafire/azure_web_service

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

.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_web_service.Provider_GetPublishingUser({
  "api-version": ""
}, context)

Input

• input object
  • api-version required string: API Version

Output

• output User

Provider_UpdatePublishingUser

Updates publishing user

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

Input

• input object
  • requestMessage required User
  • api-version required string: API Version

Output

• output User

Provider_GetSourceControls

Gets the source controls available for Azure websites

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

Input

• input object
  • api-version required string: API Version

Output

• output SourceControlCollection

Provider_GetSourceControl

Gets source control token

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

Input

• input object
  • sourceControlType required string: Type of source control
  • api-version required string: API Version

Output

• output SourceControl

Provider_UpdateSourceControl

Updates source control token

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

Input

• input object
  • sourceControlType required string: Type of source control
  • requestMessage required SourceControl
  • api-version required string: API Version

Output

• output SourceControl

GlobalCertificateOrder_GetAllCertificateOrders

Lists all domains in a subscription

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateOrderCollection

GlobalCertificateOrder_ValidateCertificatePurchaseInformation

Validate certificate purchase information

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

Input

• input object
  • certificateOrder required CertificateOrder
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

GlobalDomainRegistration_CheckDomainAvailability

Checks if a domain is available for registration

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

Input

• input object
  • identifier required NameIdentifier
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output DomainAvailablilityCheckResult

GlobalDomainRegistration_GetAllDomains

Lists all domains in a subscription

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output DomainCollection

GlobalDomainRegistration_GetDomainControlCenterSsoRequest

Generates a single sign on request for domain management portal

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output DomainControlCenterSsoRequest

GlobalDomainRegistration_ListDomainRecommendations

Lists domain recommendations based on keywords

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

Input

• input object
  • parameters required DomainRecommendationSearchParameters
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output NameIdentifierCollection

TopLevelDomains_GetGetTopLevelDomains

Lists all top level domains supported for registration

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output TopLevelDomainCollection

TopLevelDomains_GetTopLevelDomain

Gets details of a top level domain

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

Input

• input object
  • name required string: Name of the top level domain
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output TopLevelDomain

TopLevelDomains_ListTopLevelDomainAgreements

Lists legal agreements that user needs to accept before purchasing domain

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

Input

• input object
  • name required string: Name of the top level domain
  • agreementOption required TopLevelDomainAgreementOption
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output TldLegalAgreementCollection

GlobalDomainRegistration_ValidateDomainPurchaseInformation

Validates domain registration information

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

Input

• input object
  • domainRegistrationInput required DomainRegistrationInput
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

Global_GetAllCertificates

Get all certificates for a subscription

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateCollection

Global_CheckNameAvailability

Check if resource name is available

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

Input

• input object
  • request required ResourceNameAvailabilityRequest
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output ResourceNameAvailability

Global_GetAllClassicMobileServices

Gets all mobile services for a subscription

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output ClassicMobileServiceCollection

Global_GetSubscriptionGeoRegions

Gets list of available geo regions

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

Input

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

Output

• output GeoRegionCollection

Global_GetAllHostingEnvironments

Gets all hostingEnvironments (App Service Environment) for a subscription

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output HostingEnvironmentCollection

Global_IsHostingEnvironmentNameAvailable

Whether hosting environment name is available

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

Input

• input object
  • name required string: Hosting environment name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

Global_IsHostingEnvironmentWithLegacyNameAvailable

Whether hosting environment name is available

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

Input

• input object
  • name required string: Hosting environment name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

Global_GetAllManagedHostingEnvironments

Gets all managed hosting environments for a subscription

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output ManagedHostingEnvironmentCollection

Global_ListPremierAddOnOffers

List premier add on offers

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

Global_GetSubscriptionPublishingCredentials

Gets publishing credentials for the subscription owner

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output User

Global_UpdateSubscriptionPublishingCredentials

Updates publishing credentials for the subscription owner

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

Input

• input object
  • requestMessage required User
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output User

Recommendations_GetRecommendationBySubscription

Gets a list of recommendations associated with the specified subscription.

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

Input

• input object
  • 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 required string: Subscription Id
  • api-version required string: API Version

Output

• output array
  • items Recommendation

Global_GetAllServerFarms

Gets all App Service Plans for a subscription

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

Input

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

Output

• output ServerFarmCollection

Global_GetAllSites

Gets all Web Apps for a subscription

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

Input

• input object
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output SiteCollection

GlobalResourceGroups_MoveResources

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

Input

• input object
  • resourceGroupName required string
  • moveResourceEnvelope required CsmMoveResourceEnvelope
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

Output schema unknown

CertificateOrders_GetCertificateOrders

Get certificate orders in a resource group

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateOrderCollection

CertificateOrders_GetCertificates

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

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • certificateOrderName required string: Certificate name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateOrderCertificateCollection

CertificateOrders_DeleteCertificate

Deletes the certificate associated with the certificate order

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • certificateOrderName required string: Certificate name
  • name required string: Certificate name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

CertificateOrders_GetCertificate

Get certificate associated with the certificate order

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • certificateOrderName required string: Certificate name
  • name required string: Certificate name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateOrderCertificate

CertificateOrders_UpdateCertificate

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

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • certificateOrderName required string: Certificate name
  • name required string: Certificate name
  • keyVaultCertificate required CertificateOrderCertificate
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateOrderCertificate

CertificateOrders_CreateOrUpdateCertificate

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

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • certificateOrderName required string: Certificate name
  • name required string: Certificate name
  • keyVaultCertificate required CertificateOrderCertificate
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateOrderCertificate

CertificateOrders_DeleteCertificateOrder

Delete an existing certificate order

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • name required string: Certificate name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

CertificateOrders_GetCertificateOrder

Get a certificate order

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • name required string: Certificate name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateOrder

CertificateOrders_UpdateCertificateOrder

Create or update a certificate purchase order

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • name required string: Certificate name
  • certificateDistinguishedName required CertificateOrder
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateOrder

CertificateOrders_CreateOrUpdateCertificateOrder

Create or update a certificate purchase order

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • name required string: Certificate name
  • certificateDistinguishedName required CertificateOrder
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateOrder

CertificateOrders_ReissueCertificateOrder

Reissue an existing certificate order

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • name required string: Certificate name
  • reissueCertificateOrderRequest required ReissueCertificateOrderRequest
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

CertificateOrders_RenewCertificateOrder

Renew an existing certificate order

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • name required string: Certificate name
  • renewCertificateOrderRequest required RenewCertificateOrderRequest
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

CertificateOrders_ResendCertificateEmail

Resend certificate email

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • name required string: Certificate order name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

CertificateOrders_RetrieveCertificateActions

Retrieve the list of certificate actions

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • name required string: Certificate order name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output array
  • items CertificateOrderAction

CertificateOrders_RetrieveCertificateEmailHistory

Retrieve email history

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • name required string: Certificate order name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output array
  • items CertificateEmail

CertificateOrders_VerifyDomainOwnership

Verify domain ownership for this certificate order

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

Input

• input object
  • resourceGroupName required string: Azure resource group name
  • name required string: Certificate order name
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

Domains_GetDomains

Lists domains under a resource group

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

Input

• input object
  • resourceGroupName required string: Name of the resource group
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output DomainCollection

Domains_DeleteDomain

Deletes a domain

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

Input

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

Output

• output Object

Domains_GetDomain

Gets details of a domain

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

Input

• input object
  • resourceGroupName required string: Name of the resource group
  • domainName required string: Name of the domain
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Domain

Domains_UpdateDomain

Creates a domain

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

Input

• input object
  • resourceGroupName required string: >Name of the resource group
  • domainName required string: Name of the domain
  • domain required Domain
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Domain

Domains_CreateOrUpdateDomain

Creates a domain

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

Input

• input object
  • resourceGroupName required string: >Name of the resource group
  • domainName required string: Name of the domain
  • domain required Domain
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Domain

Domains_GetDomainOperation

Retrieves the latest status of a domain purchase operation

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

Input

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

Output

• output Domain

Usage_GetUsage

Returns usage records for specified subscription and resource groups

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

Input

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

Output

• output Object

Certificates_GetCertificates

Get certificates for a subscription in the specified resource group.

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

Input

• input object
  • resourceGroupName required string: Name of the resource group
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output CertificateCollection

Certificates_DeleteCertificate

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

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

Input

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

Output

• output Object

Certificates_GetCertificate

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

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

Input

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

Output

• output Certificate

Certificates_UpdateCertificate

Creates or modifies an existing certificate.

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

Input

• input object
  • resourceGroupName required string: Name of the resource group
  • name required string: Name of the certificate.
  • certificateEnvelope required Certificate
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Certificate

Certificates_CreateOrUpdateCertificate

Creates or modifies an existing certificate.

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

Input

• input object
  • resourceGroupName required string: Name of the resource group
  • name required string: Name of the certificate.
  • certificateEnvelope required Certificate
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Certificate

ClassicMobileServices_GetClassicMobileServices

Get all mobile services in a resource group.

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

Input

• input object
  • resourceGroupName required string: Name of resource group
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output ClassicMobileServiceCollection

ClassicMobileServices_DeleteClassicMobileService

Delete a mobile service.

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

Input

• input object
  • resourceGroupName required string: Name of resource group
  • name required string: Name of mobile service
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

ClassicMobileServices_GetClassicMobileService

Get a mobile service.

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

Input

• input object
  • resourceGroupName required string: Name of resource group
  • name required string: Name of mobile service
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output ClassicMobileService

Certificates_GetCsrs

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

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

Input

• input object
  • resourceGroupName required string: Name of the resource group
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output array
  • items Csr

Certificates_DeleteCsr

Delete the certificate signing request.

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

Input

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

Output

• output Object

Certificates_GetCsr

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

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

Input

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

Output

• output Csr

Certificates_UpdateCsr

Creates or modifies an existing certificate signing request.

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

Input

• input object
  • resourceGroupName required string: Name of the resource group
  • name required string: Name of the certificate.
  • csrEnvelope required Csr
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Csr

Certificates_CreateOrUpdateCsr

Creates or modifies an existing certificate signing request.

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

Input

• input object
  • resourceGroupName required string: Name of the resource group
  • name required string: Name of the certificate.
  • csrEnvelope required Csr
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output Csr

Sites_GetDeletedSites

Gets deleted web apps in subscription

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

Input

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

Output

• output DeletedSiteCollection

HostingEnvironments_GetHostingEnvironments

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

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

Input

• input object
  • resourceGroupName required string: Name of resource group
  • subscriptionId required string: Subscription Id
  • api-version required string: API Version

Output

• output HostingEnvironmentCollection

HostingEnvironments_DeleteHostingEnvironment

Delete a hostingEnvironment (App Service Environment).

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

Input

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

Output

• output Object

HostingEnvironments_GetHostingEnvironment

Get properties of hostingEnvironment (App Service Environment).

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

Input

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

Output

• output HostingEnvironment

HostingEnvironments_CreateOrUpdateHostingEnvironment

Create or update a hostingEnvironment (App Service Environment).

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

Input

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

Output

• output HostingEnvironment

HostingEnvironments_GetHostingEnvironmentCapacities

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

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

Input

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

Output

• output StampCapacityCollection

HostingEnvironments_GetHostingEnvironmentVips

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

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

Input

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

Output

• output AddressResponse

HostingEnvironments_GetHostingEnvironmentDiagnostics

Get diagnostic information for hostingEnvironment (App Service Environment).

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

Input

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

Output

• output array
  • items HostingEnvironmentDiagnostics

HostingEnvironments_GetHostingEnvironmentDiagnosticsItem

Get diagnostic information for hostingEnvironment (App Service Environment).

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

Input

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

Output

• output HostingEnvironmentDiagnostics

HostingEnvironments_GetHostingEnvironmentMetricDefinitions

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

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

Input

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

Output

• output MetricDefinition

HostingEnvironments_GetHostingEnvironmentMetrics

Get global metrics of hostingEnvironment (App Service Environment).

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

Input

• input object
  • resourceGroupName required string: Name of resource group
  • name required string: 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 required string: Subscription Id
  • api-version required string: API Version

Output

• output ResourceMetricCollection

HostingEnvironments_GetMultiRolePools

Get all multi role pools

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

Input

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

Output

• output WorkerPoolCollection

HostingEnvironments_GetMultiRolePool

Get properties of a multiRole pool.

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

Input

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

Output

• output WorkerPool

HostingEnvironments_CreateOrUpdateMultiRolePool

Create or update a multiRole pool.

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

Input

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

Output

• output WorkerPool

HostingEnvironments_GetMultiRolePoolInstanceMetricDefinitions

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

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

Input

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

Output

• output Object

HostingEnvironments_GetMultiRolePoolInstanceMetrics

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

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

Input

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

Output

• output Object

HostingEnvironments_GetHostingEnvironmentMultiRoleMetricDefinitions

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

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

Input

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

Output

• output MetricDefinitionCollection

HostingEnvironments_GetHostingEnvironmentMultiRoleMetrics

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

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

Input

• input object
  • resourceGroupName required string: Name of resource group
  • name required string: 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 required string: Subscription Id
  • api-version required string: API Version

Output

• output ResourceMetricCollection

HostingEnvironments_GetMultiRolePoolSkus

Get available skus for scaling a multiRole pool.

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

Input

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

Output

• output SkuInfoCollection

HostingEnvironments_GetHostingEnvironmentMultiRoleUsages

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

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

Input

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

Output

• output UsageCollection

HostingEnvironments_GetHostingEnvironmentOperations

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

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

Input

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

Output

• output Object

HostingEnvironments_GetHostingEnvironmentOperation

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

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

Input

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

Output

• output Object

HostingEnvironments_RebootHostingEnvironment

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

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

Input

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

Output

• output Object

HostingEnvironments_ResumeHostingEnvironment

Resumes the hostingEnvironment.

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

Input

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

Output

• output SiteCollection

HostingEnvironments_GetHostingEnvironmentServerFarms

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

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

Input

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

Output

• output ServerFarmCollection

HostingEnvironments_GetHostingEnvironmentSites

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

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

Input

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

Output

• output SiteCollection

HostingEnvironments_SuspendHostingEnvironment

Suspends the hostingEnvironment.

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

Input

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

Output

• output SiteCollection

HostingEnvironments_GetHostingEnvironmentUsages

Get global usages of hostingEnvironment (App Service Environment).

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

Input

• input object
  • resourceGroupName required string: Name of resource group
  • name required string: 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 required string: Subscription Id
  • api-version required string: API Version

Output

• output CsmUsageQuotaCollection

HostingEnvironments_GetHostingEnvironmentWebHostingPlans

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

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

Input

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

Output

• output ServerFarmCollection

HostingEnvironments_GetWorkerPools

Get all worker pools

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

Input

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

Output

• output WorkerPoolCollection

HostingEnvironments_GetWorkerPool

Get properties of a worker pool.

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

Input

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

Output

• output WorkerPool

HostingEnvironments_CreateOrUpdateWorkerPool

Create or update a worker pool.

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

Input

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

Output

• output WorkerPool

HostingEnvironments_GetWorkerPoolInstanceMetricDefinitions

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

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

Input

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

Output

• output Object

HostingEnvironments_GetWorkerPoolInstanceMetrics

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

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

Input

• input object
  • resourceGroupName required string: Name of resource group
  • name required string: Name of hostingEnvironment (App Service Environment)
  • workerPoolName required string: Name of worker pool
  • instance required string: 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 required string: Subscription Id
  • api-version required string: API Version

Output

• output Object

HostingEnvironments_GetHostingEnvironmentWebWorkerMetricDefinitions

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

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

Input

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

Output

• output MetricDefinitionCollection

HostingEnvironments_GetHostingEnvironmentWebWorkerMetrics

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

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

Input

• input object
  • resourceGroupName required string: Name of resource group
  • name required string: Name of hostingEnvironment (App Service Environment)
  • workerPoolName required string: 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 required string: Subscription Id
  • api-version required string: API Version

Output

• output ResourceMetricCollection

HostingEnvironments_GetWorkerPoolSkus

Get available skus for scaling a worker pool.

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

Input

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

Output

• output SkuInfoCollection

HostingEnvironments_GetHostingEnvironmentWebWorkerUsages

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

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

Input

• input object
  • resourceGroupName required string: Name of resource group
  • name required string: Name of hostingEnvi