@datafire/azure_web_appserviceenvironments

Client library for AppServiceEnvironments API Client

Installation and Usage

npm install --save @datafire/azure_web_appserviceenvironments

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

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

Description

Actions

AppServiceEnvironments_List

Get all App Service Environments for a subscription.

azure_web_appserviceenvironments.AppServiceEnvironments_List({
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • 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 AppServiceEnvironmentCollection

AppServiceEnvironments_ListByResourceGroup

Get all App Service Environments in a resource group.

azure_web_appserviceenvironments.AppServiceEnvironments_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 AppServiceEnvironmentCollection

AppServiceEnvironments_Delete

Delete an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_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 Environment.
  • forceDelete boolean: Specify true to force the deletion even if the App Service Environment contains resources. The default is false.
  • 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

AppServiceEnvironments_Get

Get the properties of an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_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 Environment.
  • 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 AppServiceEnvironmentResource

AppServiceEnvironments_Update

Create or update an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_Update({
  "resourceGroupName": "",
  "name": "",
  "hostingEnvironmentEnvelope": {},
  "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 Environment.
  • hostingEnvironmentEnvelope required AppServiceEnvironmentPatchResource
  • 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 AppServiceEnvironmentResource

AppServiceEnvironments_CreateOrUpdate

Create or update an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_CreateOrUpdate({
  "resourceGroupName": "",
  "name": "",
  "hostingEnvironmentEnvelope": {},
  "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 Environment.
  • hostingEnvironmentEnvelope required AppServiceEnvironmentResource
  • 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 AppServiceEnvironmentResource

AppServiceEnvironments_ListCapacities

Get the used, available, and total worker capacity an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListCapacities({
  "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 Environment.
  • 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 StampCapacityCollection

AppServiceEnvironments_ListVips

Get IP addresses assigned to an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListVips({
  "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 Environment.
  • 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 AddressResponse

AppServiceEnvironments_ChangeVnet

Move an App Service Environment to a different VNET.

azure_web_appserviceenvironments.AppServiceEnvironments_ChangeVnet({
  "resourceGroupName": "",
  "name": "",
  "vnetInfo": {},
  "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 Environment.
  • vnetInfo required object: Specification for using a Virtual Network.
    • id string: Resource id of the Virtual Network.
    • name string: Name of the Virtual Network (read-only).
    • subnet string: Subnet within the Virtual Network.
    • type string: Resource type of the Virtual Network (read-only).
  • 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.

AppServiceEnvironments_ListDiagnostics

Get diagnostic information for an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListDiagnostics({
  "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 Environment.
  • 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 HostingEnvironmentDiagnostics

AppServiceEnvironments_GetDiagnosticsItem

Get a diagnostics item for an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_GetDiagnosticsItem({
  "resourceGroupName": "",
  "name": "",
  "diagnosticsName": "",
  "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 Environment.
  • diagnosticsName required string: Name of the diagnostics item.
  • 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 HostingEnvironmentDiagnostics

AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints

Get the network endpoints of all inbound dependencies of an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints({
  "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 Environment.
  • 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 InboundEnvironmentEndpointCollection

AppServiceEnvironments_ListMetricDefinitions

Get global metric definitions of an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListMetricDefinitions({
  "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 Environment.
  • 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 MetricDefinition

AppServiceEnvironments_ListMetrics

Get global metrics of an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_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 Environment.
  • 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.

AppServiceEnvironments_ListMultiRolePools

Get all multi-role pools.

azure_web_appserviceenvironments.AppServiceEnvironments_ListMultiRolePools({
  "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 Environment.
  • 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 WorkerPoolCollection

AppServiceEnvironments_GetMultiRolePool

Get properties of a multi-role pool.

azure_web_appserviceenvironments.AppServiceEnvironments_GetMultiRolePool({
  "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 Environment.
  • 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 WorkerPoolResource

AppServiceEnvironments_UpdateMultiRolePool

Create or update a multi-role pool.

azure_web_appserviceenvironments.AppServiceEnvironments_UpdateMultiRolePool({
  "resourceGroupName": "",
  "name": "",
  "multiRolePoolEnvelope": {},
  "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 Environment.
  • multiRolePoolEnvelope required WorkerPoolResource
  • 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 WorkerPoolResource

AppServiceEnvironments_CreateOrUpdateMultiRolePool

Create or update a multi-role pool.

azure_web_appserviceenvironments.AppServiceEnvironments_CreateOrUpdateMultiRolePool({
  "resourceGroupName": "",
  "name": "",
  "multiRolePoolEnvelope": {},
  "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 Environment.
  • multiRolePoolEnvelope required WorkerPoolResource
  • 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 WorkerPoolResource

AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions

Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions({
  "resourceGroupName": "",
  "name": "",
  "instance": "",
  "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 Environment.
  • instance required string: Name of the instance in the multi-role pool.
  • 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.

AppServiceEnvironments_ListMultiRolePoolInstanceMetrics

Get metrics for a specific instance of a multi-role pool of an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListMultiRolePoolInstanceMetrics({
  "resourceGroupName": "",
  "name": "",
  "instance": "",
  "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 Environment.
  • instance required string: Name of the instance in the multi-role pool.
  • details boolean: Specify true to include instance details. The default is false.
  • 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.

AppServiceEnvironments_ListMultiRoleMetricDefinitions

Get metric definitions for a multi-role pool of an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListMultiRoleMetricDefinitions({
  "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 Environment.
  • 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.

AppServiceEnvironments_ListMultiRoleMetrics

Get metrics for a multi-role pool of an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListMultiRoleMetrics({
  "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 Environment.
  • startTime string: Beginning time of the metrics query.
  • endTime string: End time of the metrics query.
  • timeGrain string: Time granularity of the metrics query.
  • 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.

AppServiceEnvironments_ListMultiRolePoolSkus

Get available SKUs for scaling a multi-role pool.

azure_web_appserviceenvironments.AppServiceEnvironments_ListMultiRolePoolSkus({
  "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 Environment.
  • 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 SkuInfoCollection

AppServiceEnvironments_ListMultiRoleUsages

Get usage metrics for a multi-role pool of an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListMultiRoleUsages({
  "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 Environment.
  • 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 UsageCollection

AppServiceEnvironments_ListOperations

List all currently running operations on the App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListOperations({
  "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 Environment.
  • 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: An operation on a resource.
    • createdTime string: Time when operation has started.
    • errors array: Any errors associate with the operation.
      • items object: Body of the error response returned from the API.
        • code string: Basic error code.
        • extendedCode string: Type of error.
        • innerErrors array: Inner errors.
          • items ErrorEntity
        • message string: Any details of the error.
        • messageTemplate string: Message template.
        • parameters array: Parameters for the template.
          • items string
    • expirationTime string: Time when operation will expire.
    • geoMasterOperationId string: Applicable only for stamp operation ids.
    • id string: Operation ID.
    • modifiedTime string: Time when operation has been updated.
    • name string: Operation name.
    • status string (values: InProgress, Failed, Succeeded, TimedOut, Created): The current status of the operation.

AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints

Get the network endpoints of all outbound dependencies of an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints({
  "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 Environment.
  • 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 OutboundEnvironmentEndpointCollection

AppServiceEnvironments_Reboot

Reboot all machines in an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_Reboot({
  "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 Environment.
  • 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

AppServiceEnvironments_Resume

Resume an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_Resume({
  "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 Environment.
  • 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.

AppServiceEnvironments_ListAppServicePlans

Get all App Service plans in an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_ListAppServicePlans({
  "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 Environment.
  • 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.

AppServiceEnvironments_ListWebApps

Get all apps in an App Service Environment.

azure_web_appserviceenvironments.AppServiceEnvironments_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 Environment.
  • propertiesToInclude string: Comma separated list of app properties to include.
  • 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; ot