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 Event Hub
GraphQL
|
query{queryazureEventHub{idnametypesubscriptionIdregionresourceGroupIdcreatedBycreatedByTypecreatedAtlastModifiedBylastModifiedByTypelastModifiedAtpartitionIdsupdatedAtmessageRetentionInDayspartitionCountstatuscaptureDescription{enabledencodingintervalInSecondssizeLimitInBytesdestination{namestorageAccountResourceIdblobContainerarchiveNameFormatdataLakeSubscriptionIddataLakeAccountNamedataLakeFolderPath}skipEmptyArchives}resourceGroup{id# Other fields and connections here...}storageAccount{id# Other fields and connections here...}}}
Filtering
Get data for a single Azure Event Hub key that you know the ID for:
GraphQL
|
query{getazureEventHub(id:"12345"){id# Other fields and connections here...}}
Get data for all of the Event Hubs in a certain Azure subscription:
GraphQL
|
query{queryazureEventHub(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# region# resourceGroupId# createdBy# createdByType# createdAt# lastModifiedBy# lastModifiedByType# lastModifiedAt# partitionIds# updatedAt# messageRetentionInDays# partitionCount# status# 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 Event Hubs that are NOT in a certain Azure subscription:
GraphQL
|
query{queryazureEventHub(filter:{not:{subscriptionId:{eq:"12345"}}}){id# Other fields and connections here...}}
Advanced Filtering
Get data for all of the Event Hubs that are connected to a storageAccount:
GraphQL
|
query{queryazureEventHub(filter:{has:storageAccounts}){id# Other fields and connections here...}}
Ordering
You can order the results you get back either asc or desc depending on your preference:
GraphQL
|
query{queryazureEventHub(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# subscriptionId# type# region# resourceGroupId# createdBy# createdByType# createdAt# lastModifiedBy# lastModifiedByType# lastModifiedAt# partitionIds# updatedAt# messageRetentionInDays# partitionCount# status
Only select and return the first two Event Hubs that are found:
GraphQL
|
query{queryazureEventHub(first:2,order:{desc:name}){id# Other fields and connections here...}}
Only select and return the first two Event Hubs that are found, but offset by one so keys two & three are returned:
GraphQL
|
query{queryazureEventHub(first:2,order:{desc:name},offset:1){id# Other fields and connections here...}}
Aggregation
Count the number of Event Hubs across all scanned Azure subscriptions:
GraphQL
|
query{aggregateazureEventHub{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 Virtual Machines:# idMin# idMax# nameMin# nameMax# typeMin# typeMax# subscriptionIdMin# subscriptionIdMax# regionMin# regionMax# resourceGroupIdMin# resourceGroupIdMax# createdByMin# createdByMax# createdByTypeMin# createdByTypeMax# createdAtMin# createdAtMax# lastModifiedByMin# lastModifiedByMax# lastModifiedByTypeMin# lastModifiedByTypeMax# lastModifiedAtMin# lastModifiedAtMax# updatedAtMin# updatedAtMax# messageRetentionInDaysMin# messageRetentionInDaysMax# messageRetentionInDaysSum# messageRetentionInDaysAvg# partitionCountMin# partitionCountMax# partitionCountSum# partitionCountAvg# statusMin# statusMax
Count the number of Event Hubs in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
|
query{aggregateazureEventHub(filter:{subscriptionId:{eq:"12345"}}){count# Other fields and connections here...}}
Examples
Find all of the Event Hubs that are in the eastus region across all your accounts:
GraphQL
|
query{queryazureEventHub(filter:{region:{eq:"eastus"}}){id# Other fields and connections here...}}
Kitchen Sink
Putting it all together; get all data for all Event Hubs 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, disk -> virtualMachine -> networkInterface ...etc:
GraphQL
|
query{queryazureEventHub{idnametypesubscriptionIdregionresourceGroupIdcreatedBycreatedByTypecreatedAtlastModifiedBylastModifiedByTypelastModifiedAtpartitionIdsupdatedAtmessageRetentionInDayspartitionCountstatuscaptureDescription{enabledencodingintervalInSecondssizeLimitInBytesdestination{namestorageAccountResourceIdblobContainerarchiveNameFormatdataLakeSubscriptionIddataLakeAccountNamedataLakeFolderPath}skipEmptyArchives}resourceGroup{idnametypekindsubscriptionIdregionmanagedBydisks{id# Other fields and connections here...}appServicePlans{id# Other fields and connections here...}appServiceWebApps{id# Other fields and connections here...}disks{id# Other fields and connections here...}dns{id# Other fields and connections here...}eventGrids{id# Other fields and connections here...}eventHubs{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...}storageBlobs{id# Other fields and connections here...}storageContainers{id# Other fields and connections here...}virtualMachines{id# Other fields and connections here...}virtualMachineScaleSets{id# Other fields and connections here...}virtualNetworks{id# Other fields and connections here...}privateDns{id# Other fields and connections here...}tags{idkeyvalue}}storageAccount{idnametypekindsubscriptionIdregionresourceGroupIdextendedLocationNameextendedLocationTypeprovisioningStateprimaryEndpoints{blobqueuetablefilewebdfs}primaryMicrosoftEndpoints{blobqueuetablefilewebdfs}primaryInternetEndpoints{blobfilewebdfs}primaryLocationstatusOfPrimarylastGeoFailoverTimesecondaryLocationstatusOfSecondarycustomDomainNamecustomDomainUseSubDomainNamesasPolicyExpirationPeriodkeyPolicyExpirationPeriodInDayskeyCreationTimeKey1keyCreationTimeKey2encryptionServiceBlob{enabledlastEnabledTimekeyType}encryptionServiceFile{enabledlastEnabledTimekeyType}encryptionServiceTable{enabledlastEnabledTimekeyType}encryptionServiceQueue{enabledlastEnabledTimekeyType}encryptionKeySourceencryptionRequireInfrastructureEncryptionencryptionKeyVaultPropertyKeyNameencryptionKeyVaultPropertyKeyVersionencryptionKeyVaultPropertyKeyVaultUriencryptionKeyVaultPropertyCurrentVersionedKeyIdentifierencryptionKeyVaultPropertyLastKeyRotationTimestampencryptionUserAssignedIdentityaccessTierazureFilesIdentityBasedAuthenticationDirectoryServiceOptionsazureFilesIdentityBasedAuthenticationADProperties{domainNamenetBiosDomainNameforestNamedomainGuiddomainSidazureStorageSid}enableHttpsTrafficOnlynetworkRuleSetByPassnetworkRuleResourceAccessRules{idtenantIdresourceId}networkRuleVirtualNetworkRules{idvirtualNetworkResourceIdactionstate}networkRuleIpRules{idiPAddressOrRangeaction}networkRuleSetDefaultActionisHnsEnabledgeoReplicationStatsStatusgeoReplicationStatsLastSyncTimegeoReplicationStatsCanFailoverfailoverInProgresslargeFileSharesStateprivateEndpointConnections{idprivateEndpointIdprivateLinkServiceConnectionStateStatusprivateLinkServiceConnectionStateDescriptionprivateLinkServiceConnectionStateActionRequiredprovisioningState}routingPreferenceChoiceroutingPreferencePublishMicrosoftEndpointsroutingPreferencePublishInternetEndpointsallowBlobPublicAccessminimumTlsVersionallowSharedKeyAccessenableNfsV3resourceGroup{id# Other fields and connections here...}storageContainers{id# Other fields and connections here...}tags{idkeyvalue}}}}
