❤
npm
Sign UpSign In

@datafire/azure_web_appserviceplans

5.0.0 • Public • Published

@datafire/azure_web_appserviceplans

Client library for AppServicePlans API Client

Installation and Usage

npm install --save @datafire/azure_web_appserviceplans
let azure_web_appserviceplans = require('@datafire/azure_web_appserviceplans').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

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

Description

Actions

AppServicePlans_List

Get all App Service plans for a subscription.

azure_web_appserviceplans.AppServicePlans_List({
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • detailed boolean: Specify true to return all App Service plan properties. The default is false, which returns a subset of the properties.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Collection of App Service plans.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.
      • items object: App Service plan.
        • properties object: AppServicePlan resource specific properties
          • freeOfferExpirationTime string: The time when the server farm free offer expires.
          • geoRegion string: Geographical location for the App Service plan.
          • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
            • id string: Resource ID of the App Service Environment.
            • name string: Name of the App Service Environment.
            • type string: Resource type of the App Service Environment.
          • hyperV boolean: If Hyper-V container app service plan true, false otherwise.
          • isSpot boolean: If true, this App Service Plan owns spot instances.
          • isXenon boolean: Obsolete: If Hyper-V container app service plan true, false otherwise.
          • maximumElasticWorkerCount integer: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
          • maximumNumberOfWorkers integer: Maximum number of instances that can be assigned to this App Service plan.
          • numberOfSites integer: Number of apps assigned to this App Service plan.
          • perSiteScaling boolean: If true, apps assigned to this App Service plan can be scaled independently.
          • provisioningState string (values: Succeeded, Failed, Canceled, InProgress, Deleting): Provisioning state of the App Service Environment.
          • reserved boolean: If Linux app service plan true, false otherwise.
          • resourceGroup string: Resource group of the App Service plan.
          • spotExpirationTime string: The time when the server farm expires. Valid only if it is a spot server farm.
          • status string (values: Ready, Pending, Creating): App Service plan status.
          • subscription string: App Service plan subscription.
          • targetWorkerCount integer: Scaling worker count.
          • targetWorkerSizeId integer: Scaling worker size ID.
          • workerTierName string: Target worker tier assigned to the App Service plan.
        • sku object: Description of a SKU for a scalable resource.
          • capabilities array: Capabilities of the SKU, e.g., is traffic manager enabled?
            • items object: Describes the capabilities/features allowed for a specific SKU.
          • capacity integer: Current number of instances assigned to the resource.
          • family string: Family code of the resource SKU.
          • locations array: Locations of the SKU.
            • items string
          • name string: Name of the resource SKU.
          • size string: Size specifier of the resource SKU.
          • skuCapacity object: Description of the App Service plan scale options.
            • default integer: Default number of workers for this App Service plan SKU.
            • maximum integer: Maximum number of workers for this App Service plan SKU.
            • minimum integer: Minimum number of workers for this App Service plan SKU.
            • scaleType string: Available scale configurations for an App Service plan.
          • tier string: Service tier of the resource SKU.
        • id string: Resource Id.
        • kind string: Kind of resource.
        • location required string: Resource Location.
        • name string: Resource Name.
        • tags object: Resource tags.
        • type string: Resource type.

AppServicePlans_ListByResourceGroup

Get all App Service plans in a resource group.

azure_web_appserviceplans.AppServicePlans_ListByResourceGroup({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Collection of App Service plans.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.
      • items object: App Service plan.
        • properties object: AppServicePlan resource specific properties
          • freeOfferExpirationTime string: The time when the server farm free offer expires.
          • geoRegion string: Geographical location for the App Service plan.
          • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
            • id string: Resource ID of the App Service Environment.
            • name string: Name of the App Service Environment.
            • type string: Resource type of the App Service Environment.
          • hyperV boolean: If Hyper-V container app service plan true, false otherwise.
          • isSpot boolean: If true, this App Service Plan owns spot instances.
          • isXenon boolean: Obsolete: If Hyper-V container app service plan true, false otherwise.
          • maximumElasticWorkerCount integer: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
          • maximumNumberOfWorkers integer: Maximum number of instances that can be assigned to this App Service plan.
          • numberOfSites integer: Number of apps assigned to this App Service plan.
          • perSiteScaling boolean: If true, apps assigned to this App Service plan can be scaled independently.
          • provisioningState string (values: Succeeded, Failed, Canceled, InProgress, Deleting): Provisioning state of the App Service Environment.
          • reserved boolean: If Linux app service plan true, false otherwise.
          • resourceGroup string: Resource group of the App Service plan.
          • spotExpirationTime string: The time when the server farm expires. Valid only if it is a spot server farm.
          • status string (values: Ready, Pending, Creating): App Service plan status.
          • subscription string: App Service plan subscription.
          • targetWorkerCount integer: Scaling worker count.
          • targetWorkerSizeId integer: Scaling worker size ID.
          • workerTierName string: Target worker tier assigned to the App Service plan.
        • sku object: Description of a SKU for a scalable resource.
          • capabilities array: Capabilities of the SKU, e.g., is traffic manager enabled?
            • items object: Describes the capabilities/features allowed for a specific SKU.
          • capacity integer: Current number of instances assigned to the resource.
          • family string: Family code of the resource SKU.
          • locations array: Locations of the SKU.
            • items string
          • name string: Name of the resource SKU.
          • size string: Size specifier of the resource SKU.
          • skuCapacity object: Description of the App Service plan scale options.
            • default integer: Default number of workers for this App Service plan SKU.
            • maximum integer: Maximum number of workers for this App Service plan SKU.
            • minimum integer: Minimum number of workers for this App Service plan SKU.
            • scaleType string: Available scale configurations for an App Service plan.
          • tier string: Service tier of the resource SKU.
        • id string: Resource Id.
        • kind string: Kind of resource.
        • location required string: Resource Location.
        • name string: Resource Name.
        • tags object: Resource tags.
        • type string: Resource type.

AppServicePlans_Delete

Delete an App Service plan.

azure_web_appserviceplans.AppServicePlans_Delete({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

AppServicePlans_Get

Get an App Service plan.

azure_web_appserviceplans.AppServicePlans_Get({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: App Service plan.
    • properties object: AppServicePlan resource specific properties
      • freeOfferExpirationTime string: The time when the server farm free offer expires.
      • geoRegion string: Geographical location for the App Service plan.
      • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
        • id string: Resource ID of the App Service Environment.
        • name string: Name of the App Service Environment.
        • type string: Resource type of the App Service Environment.
      • hyperV boolean: If Hyper-V container app service plan true, false otherwise.
      • isSpot boolean: If true, this App Service Plan owns spot instances.
      • isXenon boolean: Obsolete: If Hyper-V container app service plan true, false otherwise.
      • maximumElasticWorkerCount integer: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
      • maximumNumberOfWorkers integer: Maximum number of instances that can be assigned to this App Service plan.
      • numberOfSites integer: Number of apps assigned to this App Service plan.
      • perSiteScaling boolean: If true, apps assigned to this App Service plan can be scaled independently.
      • provisioningState string (values: Succeeded, Failed, Canceled, InProgress, Deleting): Provisioning state of the App Service Environment.
      • reserved boolean: If Linux app service plan true, false otherwise.
      • resourceGroup string: Resource group of the App Service plan.
      • spotExpirationTime string: The time when the server farm expires. Valid only if it is a spot server farm.
      • status string (values: Ready, Pending, Creating): App Service plan status.
      • subscription string: App Service plan subscription.
      • targetWorkerCount integer: Scaling worker count.
      • targetWorkerSizeId integer: Scaling worker size ID.
      • workerTierName string: Target worker tier assigned to the App Service plan.
    • sku object: Description of a SKU for a scalable resource.
      • capabilities array: Capabilities of the SKU, e.g., is traffic manager enabled?
        • items object: Describes the capabilities/features allowed for a specific SKU.
          • name string: Name of the SKU capability.
          • reason string: Reason of the SKU capability.
          • value string: Value of the SKU capability.
      • capacity integer: Current number of instances assigned to the resource.
      • family string: Family code of the resource SKU.
      • locations array: Locations of the SKU.
        • items string
      • name string: Name of the resource SKU.
      • size string: Size specifier of the resource SKU.
      • skuCapacity object: Description of the App Service plan scale options.
        • default integer: Default number of workers for this App Service plan SKU.
        • maximum integer: Maximum number of workers for this App Service plan SKU.
        • minimum integer: Minimum number of workers for this App Service plan SKU.
        • scaleType string: Available scale configurations for an App Service plan.
      • tier string: Service tier of the resource SKU.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • location required string: Resource Location.
    • name string: Resource Name.
    • tags object: Resource tags.
    • type string: Resource type.

AppServicePlans_Update

Creates or updates an App Service Plan.

azure_web_appserviceplans.AppServicePlans_Update({
  "resourceGroupName": "",
  "name": "",
  "appServicePlan": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • appServicePlan required AppServicePlanPatchResource
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: App Service plan.
    • properties object: AppServicePlan resource specific properties
      • freeOfferExpirationTime string: The time when the server farm free offer expires.
      • geoRegion string: Geographical location for the App Service plan.
      • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
        • id string: Resource ID of the App Service Environment.
        • name string: Name of the App Service Environment.
        • type string: Resource type of the App Service Environment.
      • hyperV boolean: If Hyper-V container app service plan true, false otherwise.
      • isSpot boolean: If true, this App Service Plan owns spot instances.
      • isXenon boolean: Obsolete: If Hyper-V container app service plan true, false otherwise.
      • maximumElasticWorkerCount integer: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
      • maximumNumberOfWorkers integer: Maximum number of instances that can be assigned to this App Service plan.
      • numberOfSites integer: Number of apps assigned to this App Service plan.
      • perSiteScaling boolean: If true, apps assigned to this App Service plan can be scaled independently.
      • provisioningState string (values: Succeeded, Failed, Canceled, InProgress, Deleting): Provisioning state of the App Service Environment.
      • reserved boolean: If Linux app service plan true, false otherwise.
      • resourceGroup string: Resource group of the App Service plan.
      • spotExpirationTime string: The time when the server farm expires. Valid only if it is a spot server farm.
      • status string (values: Ready, Pending, Creating): App Service plan status.
      • subscription string: App Service plan subscription.
      • targetWorkerCount integer: Scaling worker count.
      • targetWorkerSizeId integer: Scaling worker size ID.
      • workerTierName string: Target worker tier assigned to the App Service plan.
    • sku object: Description of a SKU for a scalable resource.
      • capabilities array: Capabilities of the SKU, e.g., is traffic manager enabled?
        • items object: Describes the capabilities/features allowed for a specific SKU.
          • name string: Name of the SKU capability.
          • reason string: Reason of the SKU capability.
          • value string: Value of the SKU capability.
      • capacity integer: Current number of instances assigned to the resource.
      • family string: Family code of the resource SKU.
      • locations array: Locations of the SKU.
        • items string
      • name string: Name of the resource SKU.
      • size string: Size specifier of the resource SKU.
      • skuCapacity object: Description of the App Service plan scale options.
        • default integer: Default number of workers for this App Service plan SKU.
        • maximum integer: Maximum number of workers for this App Service plan SKU.
        • minimum integer: Minimum number of workers for this App Service plan SKU.
        • scaleType string: Available scale configurations for an App Service plan.
      • tier string: Service tier of the resource SKU.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • location required string: Resource Location.
    • name string: Resource Name.
    • tags object: Resource tags.
    • type string: Resource type.

AppServicePlans_CreateOrUpdate

Creates or updates an App Service Plan.

azure_web_appserviceplans.AppServicePlans_CreateOrUpdate({
  "resourceGroupName": "",
  "name": "",
  "appServicePlan": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • appServicePlan required object: App Service plan.
      • properties object: AppServicePlan resource specific properties
        • freeOfferExpirationTime string: The time when the server farm free offer expires.
        • geoRegion string: Geographical location for the App Service plan.
        • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
          • id string: Resource ID of the App Service Environment.
          • name string: Name of the App Service Environment.
          • type string: Resource type of the App Service Environment.
        • hyperV boolean: If Hyper-V container app service plan true, false otherwise.
        • isSpot boolean: If true, this App Service Plan owns spot instances.
        • isXenon boolean: Obsolete: If Hyper-V container app service plan true, false otherwise.
        • maximumElasticWorkerCount integer: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
        • maximumNumberOfWorkers integer: Maximum number of instances that can be assigned to this App Service plan.
        • numberOfSites integer: Number of apps assigned to this App Service plan.
        • perSiteScaling boolean: If true, apps assigned to this App Service plan can be scaled independently.
        • provisioningState string (values: Succeeded, Failed, Canceled, InProgress, Deleting): Provisioning state of the App Service Environment.
        • reserved boolean: If Linux app service plan true, false otherwise.
        • resourceGroup string: Resource group of the App Service plan.
        • spotExpirationTime string: The time when the server farm expires. Valid only if it is a spot server farm.
        • status string (values: Ready, Pending, Creating): App Service plan status.
        • subscription string: App Service plan subscription.
        • targetWorkerCount integer: Scaling worker count.
        • targetWorkerSizeId integer: Scaling worker size ID.
        • workerTierName string: Target worker tier assigned to the App Service plan.
      • sku object: Description of a SKU for a scalable resource.
        • capabilities array: Capabilities of the SKU, e.g., is traffic manager enabled?
          • items object: Describes the capabilities/features allowed for a specific SKU.
            • name string: Name of the SKU capability.
            • reason string: Reason of the SKU capability.
            • value string: Value of the SKU capability.
        • capacity integer: Current number of instances assigned to the resource.
        • family string: Family code of the resource SKU.
        • locations array: Locations of the SKU.
          • items string
        • name string: Name of the resource SKU.
        • size string: Size specifier of the resource SKU.
        • skuCapacity object: Description of the App Service plan scale options.
          • default integer: Default number of workers for this App Service plan SKU.
          • maximum integer: Maximum number of workers for this App Service plan SKU.
          • minimum integer: Minimum number of workers for this App Service plan SKU.
          • scaleType string: Available scale configurations for an App Service plan.
        • tier string: Service tier of the resource SKU.
      • id string: Resource Id.
      • kind string: Kind of resource.
      • location required string: Resource Location.
      • name string: Resource Name.
      • tags object: Resource tags.
      • type string: Resource type.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: App Service plan.
    • properties object: AppServicePlan resource specific properties
      • freeOfferExpirationTime string: The time when the server farm free offer expires.
      • geoRegion string: Geographical location for the App Service plan.
      • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
        • id string: Resource ID of the App Service Environment.
        • name string: Name of the App Service Environment.
        • type string: Resource type of the App Service Environment.
      • hyperV boolean: If Hyper-V container app service plan true, false otherwise.
      • isSpot boolean: If true, this App Service Plan owns spot instances.
      • isXenon boolean: Obsolete: If Hyper-V container app service plan true, false otherwise.
      • maximumElasticWorkerCount integer: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
      • maximumNumberOfWorkers integer: Maximum number of instances that can be assigned to this App Service plan.
      • numberOfSites integer: Number of apps assigned to this App Service plan.
      • perSiteScaling boolean: If true, apps assigned to this App Service plan can be scaled independently.
      • provisioningState string (values: Succeeded, Failed, Canceled, InProgress, Deleting): Provisioning state of the App Service Environment.
      • reserved boolean: If Linux app service plan true, false otherwise.
      • resourceGroup string: Resource group of the App Service plan.
      • spotExpirationTime string: The time when the server farm expires. Valid only if it is a spot server farm.
      • status string (values: Ready, Pending, Creating): App Service plan status.
      • subscription string: App Service plan subscription.
      • targetWorkerCount integer: Scaling worker count.
      • targetWorkerSizeId integer: Scaling worker size ID.
      • workerTierName string: Target worker tier assigned to the App Service plan.
    • sku object: Description of a SKU for a scalable resource.
      • capabilities array: Capabilities of the SKU, e.g., is traffic manager enabled?
        • items object: Describes the capabilities/features allowed for a specific SKU.
          • name string: Name of the SKU capability.
          • reason string: Reason of the SKU capability.
          • value string: Value of the SKU capability.
      • capacity integer: Current number of instances assigned to the resource.
      • family string: Family code of the resource SKU.
      • locations array: Locations of the SKU.
        • items string
      • name string: Name of the resource SKU.
      • size string: Size specifier of the resource SKU.
      • skuCapacity object: Description of the App Service plan scale options.
        • default integer: Default number of workers for this App Service plan SKU.
        • maximum integer: Maximum number of workers for this App Service plan SKU.
        • minimum integer: Minimum number of workers for this App Service plan SKU.
        • scaleType string: Available scale configurations for an App Service plan.
      • tier string: Service tier of the resource SKU.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • location required string: Resource Location.
    • name string: Resource Name.
    • tags object: Resource tags.
    • type string: Resource type.

AppServicePlans_ListCapabilities

List all capabilities of an App Service plan.

azure_web_appserviceplans.AppServicePlans_ListCapabilities({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output array
    • items object: Describes the capabilities/features allowed for a specific SKU.
      • name string: Name of the SKU capability.
      • reason string: Reason of the SKU capability.
      • value string: Value of the SKU capability.

AppServicePlans_DeleteHybridConnection

Delete a Hybrid Connection in use in an App Service plan.

azure_web_appserviceplans.AppServicePlans_DeleteHybridConnection({
  "resourceGroupName": "",
  "name": "",
  "namespaceName": "",
  "relayName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • namespaceName required string: Name of the Service Bus namespace.
    • relayName required string: Name of the Service Bus relay.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

AppServicePlans_GetHybridConnection

Retrieve a Hybrid Connection in use in an App Service plan.

azure_web_appserviceplans.AppServicePlans_GetHybridConnection({
  "resourceGroupName": "",
  "name": "",
  "namespaceName": "",
  "relayName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • namespaceName required string: Name of the Service Bus namespace.
    • relayName required string: Name of the Service Bus relay.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Hybrid Connection contract. This is used to configure a Hybrid Connection.
    • properties object: HybridConnection resource specific properties
      • hostname string: The hostname of the endpoint.
      • port integer: The port of the endpoint.
      • relayArmUri string: The ARM URI to the Service Bus relay.
      • relayName string: The name of the Service Bus relay.
      • sendKeyName string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
      • sendKeyValue string: The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned
      • serviceBusNamespace string: The name of the Service Bus namespace.
      • serviceBusSuffix string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

AppServicePlans_ListHybridConnectionKeys

Get the send key name and value of a Hybrid Connection.

azure_web_appserviceplans.AppServicePlans_ListHybridConnectionKeys({
  "resourceGroupName": "",
  "name": "",
  "namespaceName": "",
  "relayName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • namespaceName required string: The name of the Service Bus namespace.
    • relayName required string: The name of the Service Bus relay.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.
    • properties object: HybridConnectionKey resource specific properties
      • sendKeyName string: The name of the send key.
      • sendKeyValue string: The value of the send key.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

AppServicePlans_ListWebAppsByHybridConnection

Get all apps that use a Hybrid Connection in an App Service Plan.

azure_web_appserviceplans.AppServicePlans_ListWebAppsByHybridConnection({
  "resourceGroupName": "",
  "name": "",
  "namespaceName": "",
  "relayName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • namespaceName required string: Name of the Hybrid Connection namespace.
    • relayName required string: Name of the Hybrid Connection relay.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

AppServicePlans_GetHybridConnectionPlanLimit

Get the maximum number of Hybrid Connections allowed in an App Service plan.

azure_web_appserviceplans.AppServicePlans_GetHybridConnectionPlanLimit({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

AppServicePlans_ListHybridConnections

Retrieve all Hybrid Connections in use in an App Service plan.

azure_web_appserviceplans.AppServicePlans_ListHybridConnections({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

AppServicePlans_ListMetricDefintions

Get metrics that can be queried for an App Service plan, and their definitions.

azure_web_appserviceplans.AppServicePlans_ListMetricDefintions({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Collection of metric definitions.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.
      • items object: Metadata for the metrics.
        • properties object: ResourceMetricDefinition resource specific properties
          • metricAvailabilities array: List of time grains supported for the metric together with retention period.
            • items object: Metrics availability and retention.
          • primaryAggregationType string: Primary aggregation type.
          • properties object: Resource metric definition properties.
          • resourceUri string: Resource URI.
          • unit string: Unit of the metric.
        • id string: Resource Id.
        • kind string: Kind of resource.
        • name string: Resource Name.
        • type string: Resource type.

AppServicePlans_ListMetrics

Get metrics for an App Service plan.

azure_web_appserviceplans.AppServicePlans_ListMetrics({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • details boolean: Specify true to include instance details. The default is false.
    • $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: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Collection of metric responses.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.
      • items object: Object representing a metric for any resource .
        • endTime string: Metric end time.
        • id string: Resource Id.
        • metricValues array: Metric values.
          • items object: Value of resource metric.
            • average number: Value average.
            • count number: Value count.
            • maximum number: Value maximum.
            • minimum number: Value minimum.
            • properties array: Resource metric properties collection.
            • timestamp string: Value timestamp.
            • total number: Value total.
        • name object: Name of a metric for any resource .
          • localizedValue string: Localized metric name value.
          • value string: metric name value.
        • properties array: Resource metric properties collection.
          • items object: Resource metric property.
            • key string: Key for resource metric property.
            • value string: Value of pair.
        • resourceId string: Metric resource Id.
        • startTime string: Metric start time.
        • timeGrain string: Metric granularity. E.g PT1H, PT5M, P1D
        • unit string: Metric unit.

AppServicePlans_RestartWebApps

Restart all apps in an App Service plan.

azure_web_appserviceplans.AppServicePlans_RestartWebApps({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • softRestart boolean: Specify true to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

AppServicePlans_ListWebApps

Get all apps associated with an App Service plan.

azure_web_appserviceplans.AppServicePlans_ListWebApps({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • $skipToken string: Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list
    • $filter string: Supported filter: $filter=state eq running. Returns only web apps that are currently running
    • $top string: List page size. If specified, results are paged.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Collection of App Service apps.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.
      • items object: A web app, a mobile app backend, or an API app.
        • identity object: Managed service identity.
          • principalId string: Principal Id of managed service identity.
          • tenantId string: Tenant of managed service identity.
          • type string (values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None): Type of managed service identity.
          • userAssignedIdentities object: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}
        • properties object: Site resource specific properties
          • availabilityState string (values: Normal, Limited, DisasterRecoveryMode): Management information availability state for the app.
          • clientAffinityEnabled boolean: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.
          • clientCertEnabled boolean: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.
          • clientCertExclusionPaths string: client certificate authentication comma-separated exclusion paths
          • cloningInfo object: Information needed for cloning operation.
            • appSettingsOverrides object: Application setting overrides for cloned app. If specified, these settings override the settings cloned
            • cloneCustomHostNames boolean: true to clone custom hostnames from source app; otherwise, false.
            • cloneSourceControl boolean: true to clone source control from source app; otherwise, false.
            • configureLoadBalancing boolean: true to configure load balancing for source and destination app.
            • correlationId string: Correlation ID of cloning operation. This ID ties multiple cloning operations
            • hostingEnvironment string: App Service Environment.
            • overwrite boolean: true to overwrite destination app; otherwise, false.
            • sourceWebAppId required string: ARM resource ID of the source app. App resource ID is of the form
            • sourceWebAppLocation string: Location of source app ex: West US or North Europe
            • trafficManagerProfileId string: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form
            • trafficManagerProfileName string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.
          • containerSize integer: Size of the function container.
          • dailyMemoryTimeQuota integer: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
          • defaultHostName string: Default hostname of the app. Read-only.
          • enabled boolean: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
          • enabledHostNames array: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,
            • items string
          • geoDistributions array: GeoDistributions for this site
            • items object: A global distribution definition.
          • hostNameSslStates array: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
            • items object: SSL-enabled hostname.
          • hostNames array: Hostnames associated with the app.
            • items string
          • hostNamesDisabled boolean: true to disable the public hostnames of the app; otherwise, false.
          • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
            • id string: Resource ID of the App Service Environment.
            • name string: Name of the App Service Environment.
            • type string: Resource type of the App Service Environment.
          • httpsOnly boolean: HttpsOnly: configures a web site to accept only https requests. Issues redirect for
          • hyperV boolean: Hyper-V sandbox.
          • inProgressOperationId string: Specifies an operation id if this site has a pending operation.
          • isDefaultContainer boolean: true if the app is a default container; otherwise, false.
          • isXenon boolean: Obsolete: Hyper-V sandbox.
          • lastModifiedTimeUtc string: Last time the app was modified, in UTC. Read-only.
          • maxNumberOfWorkers integer: Maximum number of workers.
          • outboundIpAddresses string: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.
          • possibleOutboundIpAddresses string: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.
          • redundancyMode string (values: None, Manual, Failover, ActiveActive, GeoRedundant): Site redundancy mode
          • repositorySiteName string: Name of the repository site.
          • reserved boolean: true if reserved; otherwise, false.
          • resourceGroup string: Name of the resource group the app belongs to. Read-only.
          • scmSiteAlsoStopped boolean: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.
          • serverFarmId string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
          • siteConfig object: Configuration of an App Service app.
            • alwaysOn boolean: true if Always On is enabled; otherwise, false.
            • apiDefinition object: Information about the formal API definition for the app.
            • appCommandLine string: App command line to launch.
            • appSettings array: Application settings.
            • autoHealEnabled boolean: true if Auto Heal is enabled; otherwise, false.
            • autoHealRules object: Rules that can be defined for auto-heal.
            • autoSwapSlotName string: Auto-swap slot name.
            • azureStorageAccounts object: User-provided Azure storage accounts.
            • connectionStrings array: Connection strings.
            • cors object: Cross-Origin Resource Sharing (CORS) settings for the app.
            • defaultDocuments array: Default documents.
            • detailedErrorLoggingEnabled boolean: true if detailed error logging is enabled; otherwise, false.
            • documentRoot string: Document root.
            • experiments object: Routing rules in production experiments.
            • ftpsState string (values: AllAllowed, FtpsOnly, Disabled): State of FTP / FTPS service
            • handlerMappings array: Handler mappings.
            • http20Enabled boolean: Http20Enabled: configures a web site to allow clients to connect over http2.0
            • httpLoggingEnabled boolean: true if HTTP logging is enabled; otherwise, false.
            • ipSecurityRestrictions array: IP security restrictions for main.
            • javaContainer string: Java container.
            • javaContainerVersion string: Java container version.
            • javaVersion string: Java version.
            • limits object: Metric limits set on an app.
            • linuxFxVersion string: Linux App Framework and version
            • loadBalancing string (values: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash): Site load balancing.
            • localMySqlEnabled boolean: true to enable local MySQL; otherwise, false.
            • logsDirectorySizeLimit integer: HTTP logs directory size limit.
            • machineKey object: MachineKey of an app.
            • managedPipelineMode string (values: Integrated, Classic): Managed pipeline mode.
            • managedServiceIdentityId integer: Managed Service Identity Id
            • minTlsVersion string (values: 1.0, 1.1, 1.2): MinTlsVersion: configures the minimum version of TLS required for SSL requests
            • netFrameworkVersion string: .NET Framework version.
            • nodeVersion string: Version of Node.js.
            • numberOfWorkers integer: Number of workers.
            • phpVersion string: Version of PHP.
            • publishingUsername string: Publishing user name.
            • push object: Push settings for the App.
            • pythonVersion string: Version of Python.
            • remoteDebuggingEnabled boolean: true if remote debugging is enabled; otherwise, false.
            • remoteDebuggingVersion string: Remote debugging version.
            • requestTracingEnabled boolean: true if request tracing is enabled; otherwise, false.
            • requestTracingExpirationTime string: Request tracing expiration time.
            • reservedInstanceCount integer: Number of reserved instances.
            • scmIpSecurityRestrictions array: IP security restrictions for scm.
            • scmIpSecurityRestrictionsUseMain boolean: IP security restrictions for scm to use main.
            • scmType string (values: None, Dropbox, Tfs, LocalGit, GitHub, CodePlexGit, CodePlexHg, BitbucketGit, BitbucketHg, ExternalGit, ExternalHg, OneDrive, VSO): SCM type.
            • tracingOptions string: Tracing options.
            • use32BitWorkerProcess boolean: true to use 32-bit worker process; otherwise, false.
            • virtualApplications array: Virtual applications.
            • vnetName string: Virtual Network name.
            • webSocketsEnabled boolean: true if WebSocket is enabled; otherwise, false.
            • windowsFxVersion string: Xenon App Framework and version
            • xManagedServiceIdentityId integer: Explicit Managed Service Identity Id
          • slotSwapStatus object: The status of the last successful slot swap operation.
            • destinationSlotName string: The destination slot of the last swap operation.
            • sourceSlotName string: The source slot of the last swap operation.
            • timestampUtc string: The time the last successful slot swap completed.
          • state string: Current state of the app.
          • suspendedTill string: App suspended till in case memory-time quota is exceeded.
          • targetSwapSlot string: Specifies which deployment slot this app will swap into. Read-only.
          • trafficManagerHostNames array: Azure Traffic Manager hostnames associated with the app. Read-only.
            • items string
          • usageState string (values: Normal, Exceeded): State indicating whether the app has exceeded its quota usage. Read-only.
        • id string: Resource Id.
        • kind string: Kind of resource.
        • location required string: Resource Location.
        • name string: Resource Name.
        • tags object: Resource tags.
        • type string: Resource type.

AppServicePlans_GetServerFarmSkus

Gets all selectable SKUs for a given App Service Plan

azure_web_appserviceplans.AppServicePlans_GetServerFarmSkus({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of App Service Plan
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object

AppServicePlans_ListUsages

Gets server farm usage information

azure_web_appserviceplans.AppServicePlans_ListUsages({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of App Service Plan
    • $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').
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Collection of CSM usage quotas.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.
      • items object: Usage of the quota resource.
        • currentValue integer: The current value of the resource counter.
        • limit integer: The resource limit.
        • name object: Localizable string object containing the name and a localized value.
          • localizedValue string: Localized name.
          • value string: Non-localized name.
        • nextResetTime string: Next reset time for the resource counter.
        • unit string: Units of measurement for the quota resource.

AppServicePlans_ListVnets

Get all Virtual Networks associated with an App Service plan.

azure_web_appserviceplans.AppServicePlans_ListVnets({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output array
    • items object: Virtual Network information contract.
      • properties object: VnetInfo resource specific properties
        • certBlob string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a
        • certThumbprint string: The client certificate thumbprint.
        • dnsServers string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
        • isSwift boolean: Flag that is used to denote if this is VNET injection
        • resyncRequired boolean: true if a resync is required; otherwise, false.
        • routes array: The routes that this Virtual Network connection uses.
          • items object: Virtual Network route contract used to pass routing information for a Virtual Network.
            • properties object: VnetRoute resource specific properties
            • id string: Resource Id.
            • kind string: Kind of resource.
            • name string: Resource Name.
            • type string: Resource type.
        • vnetResourceId string: The Virtual Network's resource ID.
      • id string: Resource Id.
      • kind string: Kind of resource.
      • name string: Resource Name.
      • type string: Resource type.

AppServicePlans_GetVnetFromServerFarm

Get a Virtual Network associated with an App Service plan.

azure_web_appserviceplans.AppServicePlans_GetVnetFromServerFarm({
  "resourceGroupName": "",
  "name": "",
  "vnetName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • vnetName required string: Name of the Virtual Network.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Virtual Network information contract.
    • properties object: VnetInfo resource specific properties
      • certBlob string: A certificate file (.cer) blob containing the public key of the private key used to authenticate a
      • certThumbprint string: The client certificate thumbprint.
      • dnsServers string: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
      • isSwift boolean: Flag that is used to denote if this is VNET injection
      • resyncRequired boolean: true if a resync is required; otherwise, false.
      • routes array: The routes that this Virtual Network connection uses.
        • items object: Virtual Network route contract used to pass routing information for a Virtual Network.
          • properties object: VnetRoute resource specific properties
            • endAddress string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
            • routeType string (values: DEFAULT, INHERITED, STATIC): The type of route this is:
            • startAddress string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
          • id string: Resource Id.
          • kind string: Kind of resource.
          • name string: Resource Name.
          • type string: Resource type.
      • vnetResourceId string: The Virtual Network's resource ID.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

AppServicePlans_GetVnetGateway

Get a Virtual Network gateway.

azure_web_appserviceplans.AppServicePlans_GetVnetGateway({
  "resourceGroupName": "",
  "name": "",
  "vnetName": "",
  "gatewayName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • vnetName required string: Name of the Virtual Network.
    • gatewayName required string: Name of the gateway. Only the 'primary' gateway is supported.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.
    • properties object: VnetGateway resource specific properties
      • vnetName string: The Virtual Network name.
      • vpnPackageUri required string: The URI where the VPN package can be downloaded.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

AppServicePlans_UpdateVnetGateway

Update a Virtual Network gateway.

azure_web_appserviceplans.AppServicePlans_UpdateVnetGateway({
  "resourceGroupName": "",
  "name": "",
  "vnetName": "",
  "gatewayName": "",
  "connectionEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • vnetName required string: Name of the Virtual Network.
    • gatewayName required string: Name of the gateway. Only the 'primary' gateway is supported.
    • connectionEnvelope required object: The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.
      • properties object: VnetGateway resource specific properties
        • vnetName string: The Virtual Network name.
        • vpnPackageUri required string: The URI where the VPN package can be downloaded.
      • id string: Resource Id.
      • kind string: Kind of resource.
      • name string: Resource Name.
      • type string: Resource type.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.
    • properties object: VnetGateway resource specific properties
      • vnetName string: The Virtual Network name.
      • vpnPackageUri required string: The URI where the VPN package can be downloaded.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

AppServicePlans_ListRoutesForVnet

Get all routes that are associated with a Virtual Network in an App Service plan.

azure_web_appserviceplans.AppServicePlans_ListRoutesForVnet({
  "resourceGroupName": "",
  "name": "",
  "vnetName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • vnetName required string: Name of the Virtual Network.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output array
    • items object: Virtual Network route contract used to pass routing information for a Virtual Network.
      • properties object: VnetRoute resource specific properties
        • endAddress string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
        • routeType string (values: DEFAULT, INHERITED, STATIC): The type of route this is:
        • startAddress string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
      • id string: Resource Id.
      • kind string: Kind of resource.
      • name string: Resource Name.
      • type string: Resource type.

AppServicePlans_DeleteVnetRoute

Delete a Virtual Network route in an App Service plan.

azure_web_appserviceplans.AppServicePlans_DeleteVnetRoute({
  "resourceGroupName": "",
  "name": "",
  "vnetName": "",
  "routeName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • vnetName required string: Name of the Virtual Network.
    • routeName required string: Name of the Virtual Network route.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

AppServicePlans_GetRouteForVnet

Get a Virtual Network route in an App Service plan.

azure_web_appserviceplans.AppServicePlans_GetRouteForVnet({
  "resourceGroupName": "",
  "name": "",
  "vnetName": "",
  "routeName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • vnetName required string: Name of the Virtual Network.
    • routeName required string: Name of the Virtual Network route.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output array
    • items object: Virtual Network route contract used to pass routing information for a Virtual Network.
      • properties object: VnetRoute resource specific properties
        • endAddress string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
        • routeType string (values: DEFAULT, INHERITED, STATIC): The type of route this is:
        • startAddress string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
      • id string: Resource Id.
      • kind string: Kind of resource.
      • name string: Resource Name.
      • type string: Resource type.

AppServicePlans_UpdateVnetRoute

Create or update a Virtual Network route in an App Service plan.

azure_web_appserviceplans.AppServicePlans_UpdateVnetRoute({
  "resourceGroupName": "",
  "name": "",
  "vnetName": "",
  "routeName": "",
  "route": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • vnetName required string: Name of the Virtual Network.
    • routeName required string: Name of the Virtual Network route.
    • route required object: Virtual Network route contract used to pass routing information for a Virtual Network.
      • properties object: VnetRoute resource specific properties
        • endAddress string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
        • routeType string (values: DEFAULT, INHERITED, STATIC): The type of route this is:
        • startAddress string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
      • id string: Resource Id.
      • kind string: Kind of resource.
      • name string: Resource Name.
      • type string: Resource type.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Virtual Network route contract used to pass routing information for a Virtual Network.
    • properties object: VnetRoute resource specific properties
      • endAddress string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
      • routeType string (values: DEFAULT, INHERITED, STATIC): The type of route this is:
      • startAddress string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

AppServicePlans_CreateOrUpdateVnetRoute

Create or update a Virtual Network route in an App Service plan.

azure_web_appserviceplans.AppServicePlans_CreateOrUpdateVnetRoute({
  "resourceGroupName": "",
  "name": "",
  "vnetName": "",
  "routeName": "",
  "route": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • vnetName required string: Name of the Virtual Network.
    • routeName required string: Name of the Virtual Network route.
    • route required object: Virtual Network route contract used to pass routing information for a Virtual Network.
      • properties object: VnetRoute resource specific properties
        • endAddress string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
        • routeType string (values: DEFAULT, INHERITED, STATIC): The type of route this is:
        • startAddress string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
      • id string: Resource Id.
      • kind string: Kind of resource.
      • name string: Resource Name.
      • type string: Resource type.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Virtual Network route contract used to pass routing information for a Virtual Network.
    • properties object: VnetRoute resource specific properties
      • endAddress string: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
      • routeType string (values: DEFAULT, INHERITED, STATIC): The type of route this is:
      • startAddress string: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

AppServicePlans_RebootWorker

Reboot a worker machine in an App Service plan.

azure_web_appserviceplans.AppServicePlans_RebootWorker({
  "resourceGroupName": "",
  "name": "",
  "workerName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the App Service plan.
    • workerName required string: Name of worker machine, which typically starts with RD.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

Definitions

AppServicePlanPatchResource

  • AppServicePlanPatchResource object: ARM resource for a app service plan.
    • properties object: AppServicePlanPatchResource resource specific properties
      • freeOfferExpirationTime string: The time when the server farm free offer expires.
      • geoRegion string: Geographical location for the App Service plan.
      • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
        • id string: Resource ID of the App Service Environment.
        • name string: Name of the App Service Environment.
        • type string: Resource type of the App Service Environment.
      • hyperV boolean: If Hyper-V container app service plan true, false otherwise.
      • isSpot boolean: If true, this App Service Plan owns spot instances.
      • isXenon boolean: Obsolete: If Hyper-V container app service plan true, false otherwise.
      • maximumElasticWorkerCount integer: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
      • maximumNumberOfWorkers integer: Maximum number of instances that can be assigned to this App Service plan.
      • numberOfSites integer: Number of apps assigned to this App Service plan.
      • perSiteScaling boolean: If true, apps assigned to this App Service plan can be scaled independently.
      • provisioningState string (values: Succeeded, Failed, Canceled, InProgress, Deleting): Provisioning state of the App Service Environment.
      • reserved boolean: If Linux app service plan true, false otherwise.
      • resourceGroup string: Resource group of the App Service plan.
      • spotExpirationTime string: The time when the server farm expires. Valid only if it is a spot server farm.
      • status string (values: Ready, Pending, Creating): App Service plan status.
      • subscription string: App Service plan subscription.
      • targetWorkerCount integer: Scaling worker count.
      • targetWorkerSizeId integer: Scaling worker size ID.
      • workerTierName string: Target worker tier assigned to the App Service plan.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

HybridConnectionCollection

  • HybridConnectionCollection object: Collection of hostname bindings.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.
      • items object: Hybrid Connection contract. This is used to configure a Hybrid Connection.
        • properties object: HybridConnection resource specific properties
          • hostname string: The hostname of the endpoint.
          • port integer: The port of the endpoint.
          • relayArmUri string: The ARM URI to the Service Bus relay.
          • relayName string: The name of the Service Bus relay.
          • sendKeyName string: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
          • sendKeyValue string: The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned
          • serviceBusNamespace string: The name of the Service Bus namespace.
          • serviceBusSuffix string: The suffix for the service bus endpoint. By default this is .servicebus.windows.net
        • id string: Resource Id.
        • kind string: Kind of resource.
        • name string: Resource Name.
        • type string: Resource type.

HybridConnectionLimits

  • HybridConnectionLimits object: Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.
    • properties object: HybridConnectionLimits resource specific properties
      • current integer: The current number of Hybrid Connections.
      • maximum integer: The maximum number of Hybrid Connections allowed.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

ResourceCollection

  • ResourceCollection object: Collection of resources.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.
      • items string

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/azure_web_appserviceplans

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

2

Version

5.0.0

License

MIT

Unpacked Size

439 kB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware