App Service Plan
16min
Note: if you are running CloudGraph locally you can view the interactive, automatically generated documentation in either GraphQL Playground or Altair by clicking the docs button on the right-hand side of the screen. After reading the below information we highly suggest you use one of these tools to test your queries as they will autocomplete fields for you and let you know if your queries are valid before you even submit them.
Overview
You can currently query the following attributes and connections on an Azure App Service Plan
GraphQL
|
query { queryazureAppServicePlan{ id name type kind subscriptionId region skuDescription{ name tier size family capacity skuCapacity{ minimum maximum elasticMaximum default scaleType } locations capabilities{ id name value reason } } workerTierName status subscription maximumNumberOfWorkers geoRegion perSiteScaling elasticScaleEnabled maximumElasticWorkerCount numberOfSites isSpot spotExpirationTime freeOfferExpirationTime resourceGroupId reserved isXenon hyperV targetWorkerCount targetWorkerSizeId provisioningState zoneRedundant appServiceWebApps{ id # Other fields and connections here... } resourceGroup{ id # Other fields and connections here... } tags{ id key value } } }
Filtering
Get data for a single Azure App Service Plan key that you know the ID for:
GraphQL
|
query { getazureAppServicePlan(id: "12345") { id # Other fields and connections here... } }
Get data for all of the App Service Plans in a certain Azure subscription:
GraphQL
|
query { queryazureAppServicePlan(filter: { subscriptionId: { eq: "12345" } }) { id # Other fields and connections here... } } # Note that in addition to "subscriptionId" you can # Filter based on any of the following attributes: # id # name # type # kind # subscriptionId # region # resourceGroup # workerTierName # status # subscription # maximumNumberOfWorkers # geoRegion # perSiteScaling # elasticScaleEnabled # maximumElasticWorkerCount # numberOfSites # isSpot # spotExpirationTime # freeOfferExpirationTime # resourceGroupId # reserved # isXenon # hyperV # targetWorkerCount # targetWorkerSizeId # provisioningState # zoneRedundant # And the following Dgraph filters can also be applied: # has # and # or # not # regexp (regular expressions) # fulltext filters # alloftext # anyoftext
Get data for all of the App Service Plans that are NOT in a certain Azure subscription:
GraphQL
|
query { queryazureAppServicePlan(filter: { not: { subscriptionId: { eq: "12345" } } }) { id # Other fields and connections here... } }
Advanced Filtering
Get data for all of the App Service Plans that are connected to a appServiceWebApp:
GraphQL
|
query { queryazureAppServicePlan(filter: { has: appServiceWebApps }) { id # Other fields and connections here... } } # Note that in addition to "appServiceWebApps" you can filter # Using "has" based on any of the following attributes: # tags
Ordering
You can order the results you get back either asc or desc depending on your preference:
GraphQL
|
query { queryazureAppServicePlan(order: { desc: name }) { id # Other fields and connections here... } } # Note that in addition to "name" you can filter # Using "asc" or "desc" based on any of the following attributes: # id # type # kind # subscriptionId # region # resourceGroup # workerTierName # status # subscription # maximumNumberOfWorkers # geoRegion # perSiteScaling # elasticScaleEnabled # maximumElasticWorkerCount # numberOfSites # isSpot # spotExpirationTime # freeOfferExpirationTime # resourceGroupId # reserved # isXenon # hyperV # targetWorkerCount # targetWorkerSizeId # provisioningState # zoneRedundant
Only select and return the first two App Service Plans that are found:
GraphQL
|
query { queryazureAppServicePlan(first: 2, order: { desc: name }) { id # Other fields and connections here... } }
Only select and return the first two App Service Plans that are found, but offset by one so keys two & three are returned:
GraphQL
|
query { queryazureAppServicePlan(first: 2, order: { desc: name }, offset: 1) { id # Other fields and connections here... } }
Aggregation
Count the number of App Service Plans across all scanned Azure subscriptions:
GraphQL
|
query { aggregateazureAppServicePlan { count # Other fields and connections here... } } # Note that in addition to "count" you can request the # # Following min and max values based on attributes of your App Service Plans # idMin # idMax # nameMin # nameMax # typeMin # typeMax # kindMin # kindMax # subscriptionIdMin # subscriptionIdMax # regionMin # regionMax # workerTierNameMin # workerTierNameMax # statusMin # statusMax # subscriptionMin # subscriptionMax # maximumNumberOfWorkersMin # maximumNumberOfWorkersMax # maximumNumberOfWorkersSum # maximumNumberOfWorkersAvg # geoRegionMin # geoRegionMax # maximumElasticWorkerCountMin # maximumElasticWorkerCountMax # maximumElasticWorkerCountSum # maximumElasticWorkerCountAvg # numberOfSitesMin # numberOfSitesMax # numberOfSitesSum # numberOfSitesAvg # spotExpirationTimeMin # spotExpirationTimeMax # freeOfferExpirationTimeMin # freeOfferExpirationTimeMax # resourceGroupIdMin # resourceGroupIdMax # targetWorkerCountMin # targetWorkerCountMax # targetWorkerCountSum # targetWorkerCountAvg # targetWorkerSizeIdMin # targetWorkerSizeIdMax # targetWorkerSizeIdSum # targetWorkerSizeIdAvg # provisioningStateMin # provisioningStateMax
Count the number of App Service Plans in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
|
query { aggregateazureAppServicePlan(filter: { subscriptionId: { eq: "12345" } }) { count # Other fields and connections here... } }
Examples
Find all of the App Service Plans that are in the eastus region across all your accounts:
GraphQL
|
query { queryazureAppServicePlan(filter: { region: { eq: "eastus" } }) { id # Other fields and connections here... } }
Find all of the App Service Plans that have a tag of Environment:Production for a single Azure Subscription:
GraphQL
|
query { queryazureTag( filter: { key: { eq: "Environment" }, value: { eq: "Production" } } ) { appServicePlans(filter: { subscriptionId: { eq: "12345" } }) { id # Other fields and connections here... } } }
With CloudGraph you can run multiple queries at the same time so you can combine the above two queries if you like:
GraphQL
|
query { queryazureAppServicePlan(filter: { region: { eq: "eastus" } }) { id # Other fields and connections here... } queryazureTag( filter: { key: { eq: "Environment" }, value: { eq: "Production" } } ) { appServicePlans(filter: { subscriptionId: { eq: "12345" } }) { id # Other fields and connections here... } } }
Kitchen Sink
Putting it all together; get all data for all App Service Plans across all regions for all scanned Azure subscriptions in a single query. For the purposes of this example, we will only get direct children of the keys but if you want to it's easy to go from say, appServiceWebApps -> resourceGroup -> networkInterfaces ...etc:
GraphQL
|
query { queryazureAppServicePlan{ id name type kind subscriptionId region skuDescription{ name tier size family capacity skuCapacity{ minimum maximum elasticMaximum default scaleType } locations capabilities{ id name value reason } } workerTierName status subscription maximumNumberOfWorkers geoRegion perSiteScaling elasticScaleEnabled maximumElasticWorkerCount numberOfSites isSpot spotExpirationTime freeOfferExpirationTime resourceGroupId reserved isXenon hyperV targetWorkerCount targetWorkerSizeId provisioningState zoneRedundant appServiceWebApps{ id name type kind subscriptionId region resourceGroup { id } state hostNames repositorySiteName usageState enabled enabledHostNames availabilityState hostNameSslStates{ id name sslState ipBasedSslResult ipBasedSslState virtualIP thumbprint toUpdate toUpdateIpBasedSsl hostType } serverFarmId reserved isXenon hyperV lastModifiedTimeUtc siteConfig{ numberOfWorkers defaultDocuments netFrameworkVersion phpVersion pythonVersion nodeVersion powerShellVersion linuxFxVersion windowsFxVersion requestTracingEnabled requestTracingExpirationTime remoteDebuggingEnabled remoteDebuggingVersion httpLoggingEnabled acrUseManagedIdentityCreds acrUserManagedIdentityID logsDirectorySizeLimit detailedErrorLoggingEnabled publishingUsername appSettings{ id name value } connectionStrings{ id name connectionString type } documentRoot scmType use32BitWorkerProcess webSocketsEnabled alwaysOn javaVersion javaContainer javaContainerVersion appCommandLine managedPipelineMode virtualApplications{ id virtualPath physicalPath preloadEnabled virtualDirectories{ id virtualPath physicalPath } } loadBalancing limits{ maxPercentageCpu maxMemoryInMb maxDiskSizeInMb } autoHealEnabled tracingOptions vnetName vnetRouteAllEnabled vnetPrivatePortsCount cors{ allowedOrigins supportCredentials } isPushEnabled apiDefinitionInfoUrl apiManagementConfigId autoSwapSlotName localMySqlEnabled managedServiceIdentityId xManagedServiceIdentityId keyVaultReferenceIdentity scmIpSecurityRestrictionsUseMain http20Enabled http20ProxyFlag minTlsVersion scmMinTlsVersion ftpsState preWarmedInstanceCount functionAppScaleLimit healthCheckPath functionsRuntimeScaleMonitoringEnabled websiteTimeZone } trafficManagerHostNames scmSiteAlsoStopped targetSwapSlot hostingEnvironmentProfile { id } clientAffinityEnabled clientCertEnabled clientCertMode clientCertExclusionPaths hostNamesDisabled customDomainVerificationId outboundIpAddresses possibleOutboundIpAddresses containerSize dailyMemoryTimeQuota suspendedTill maxNumberOfWorkers resourceGroupId isDefaultContainer defaultHostName httpsOnly redundancyMode inProgressOperationId storageAccountRequired keyVaultReferenceIdentity virtualNetworkSubnetId } resourceGroup{ id name type kind subscriptionId region managedBy disks { id # Other fields and connections here... } dns { id # Other fields and connections here... } firewalls { id # Other fields and connections here... } functionApps { id # Other fields and connections here... } keyVaults { id # Other fields and connections here... } networkInterfaces { id # Other fields and connections here... } publicIps { id # Other fields and connections here... } securityGroups { id # Other fields and connections here... } storageAccounts { id # Other fields and connections here... } storageContainers { id # Other fields and connections here... } virtualMachines { id # Other fields and connections here... } virtualNetworks { id # Other fields and connections here... } tags{ id key value } } tags{ id key value } } }query { queryazureAppServicePlan{ id name type kind subscriptionId region skuDescription{ name tier size family capacity skuCapacity{ minimum maximum elasticMaximum default scaleType } locations capabilities{ id name value reason } } workerTierName status subscription maximumNumberOfWorkers geoRegion perSiteScaling elasticScaleEnabled maximumElasticWorkerCount numberOfSites isSpot spotExpirationTime freeOfferExpirationTime resourceGroupId reserved isXenon hyperV targetWorkerCount targetWorkerSizeId provisioningState zoneRedundant appServiceWebApps{ id name type kind subscriptionId region resourceGroup { id } state hostNames repositorySiteName usageState enabled enabledHostNames availabilityState hostNameSslStates{ id name sslState ipBasedSslResult ipBasedSslState virtualIP thumbprint toUpdate toUpdateIpBasedSsl hostType } serverFarmId reserved isXenon hyperV lastModifiedTimeUtc siteConfig{ numberOfWorkers defaultDocuments netFrameworkVersion phpVersion pythonVersion nodeVersion powerShellVersion linuxFxVersion windowsFxVersion requestTracingEnabled requestTracingExpirationTime remoteDebuggingEnabled remoteDebuggingVersion httpLoggingEnabled acrUseManagedIdentityCreds acrUserManagedIdentityID logsDirectorySizeLimit detailedErrorLoggingEnabled publishingUsername appSettings{ id name value } connectionStrings{ id name connectionString type } documentRoot scmType use32BitWorkerProcess webSocketsEnabled alwaysOn javaVersion javaContainer javaContainerVersion appCommandLine managedPipelineMode virtualApplications{ id virtualPath physicalPath preloadEnabled virtualDirectories{ id virtualPath physicalPath } } loadBalancing limits{ maxPercentageCpu maxMemoryInMb maxDiskSizeInMb } autoHealEnabled tracingOptions vnetName vnetRouteAllEnabled vnetPrivatePortsCount cors{ allowedOrigins supportCredentials } isPushEnabled apiDefinitionInfoUrl apiManagementConfigId autoSwapSlotName localMySqlEnabled managedServiceIdentityId xManagedServiceIdentityId keyVaultReferenceIdentity scmIpSecurityRestrictionsUseMain http20Enabled http20ProxyFlag minTlsVersion scmMinTlsVersion ftpsState preWarmedInstanceCount functionAppScaleLimit healthCheckPath functionsRuntimeScaleMonitoringEnabled websiteTimeZone } trafficManagerHostNames scmSiteAlsoStopped targetSwapSlot hostingEnvironmentProfile { id } clientAffinityEnabled clientCertEnabled clientCertMode clientCertExclusionPaths hostNamesDisabled customDomainVerificationId outboundIpAddresses possibleOutboundIpAddresses containerSize dailyMemoryTimeQuota suspendedTill maxNumberOfWorkers resourceGroupId isDefaultContainer defaultHostName httpsOnly redundancyMode inProgressOperationId storageAccountRequired keyVaultReferenceIdentity virtualNetworkSubnetId } resourceGroup{ id name type kind subscriptionId region managedBy disks { id # Other fields and connections here... } dns { id # Other fields and connections here... } firewalls { id # Other fields and connections here... } functionApps { id # Other fields and connections here... } keyVaults { id # Other fields and connections here... } networkInterfaces { id # Other fields and connections here... } publicIps { id # Other fields and connections here... } securityGroups { id # Other fields and connections here... } storageAccounts { id # Other fields and connections here... } storageContainers { id # Other fields and connections here... } virtualMachines { id # Other fields and connections here... } virtualNetworks { id # Other fields and connections here... } tags{ id key value } } tags{ id key value } } }
References
Updated 03 Mar 2023
Did this page help you?
Yes
No