Promitor Resource Discovery configuration file (resource-discovery-declaration.yaml)

Organization of this page

Syntax

Written in YAML format.

verion: v1
azureLandscape:
  tenantId: tenant-ID
  subscriptions:
  - subscription-ID
resourceDiscoveryGroups:
  - name: virtual-machine-group
    type: VirtualMachine
  - name: function-app-group
    type: FunctionApp

To Page Top

File

resource-discovery-declaration.yaml

resource-discovery-declaration.yaml.model (model file)

To Page Top

Storage directory

For Windows

When using a physical host: Agent-path\conf\promitor\resource-discovery\
When using a logical host: shared-folder\jp1ima\conf\promitor\resource-discovery\

For Linux

When using a physical host: /opt/jp1ima/conf/promitor/resource-discovery/
When using a logical host: shared-directory/jp1ima/conf/promitor/resource-discovery/

To Page Top

Description

The configuration file that defines the resource group to be acquired by Promitor Resource Discovery.

To Page Top

Character encoding

UTF-8 (without BOM)

To Page Top

Linefeed code

In Windows: CR+LF

In Linux: LF

To Page Top

Timing in which definitions are reflected

Definitions are reflected in Promitor Resource Discovery behavior when restarting Promitor Resource Discovery.

After performing the action above, definitions are reflected in the contents of the integrated operation viewer tree view when the jddcreatetree command and the jddupdatetree command are executed.

To Page Top

Content description

Item^#					Description	Modifiable	Content set by the user in JP1/IM - Agent	Default value in JP1/IM - Agent
version					Version of declaration that is used. Allowed values are v1.	N	--	v1
azureLandscape:					Azure information	--	--	--
	tenantId:				The id of the Azure tenant that will be queried.	REQ	Tenant ID	None
	subscriptions:				Defines a subset of subscriptions defined in the Azure landscape	--	--	--
	-	<subscriptionId>			List of Azure subscriptions in the Azure tenant to discover resources in.	REQ	Subscription ID	None
resourceDiscoveryGroups:					Defines a list of resource groups which contains the resources.	--	--	--
-	name:				Name of the resource discovery group which will be used in metrics declaration of Promitor Scraper. Specify this within 256 bytes.	Y	--	Varies depending on the resource discovery group.
	type:				Type of Azure resources that must be discovered, see "Supported Azure Services" for a full list of supported types. The following shows values that can be specified: VirtualMachine FunctionApp ContainerInstance KubernetesService FileStorage BlobStorage ServiceBusNamespace CosmosDb SqlDatabase SqlManagedInstane SqlElasticPool LogicApp	Y	--	Varies depending on the resource discovery group.
	[criteria:]				Conditions to be retrieved. Specify when you want to filter.	--	--	--
		include:			Specifies the conditions for acquisition targets.	--	--	None
			[subscriptions:]		A list of subscription(s) in which the resource is allowed to be located.	--	--	None
			-	<subscriptionId>	Specifies the subscription ID.	Y	--	None
			[resourceGroups:]		A list of resource group(s) in which the resource is allowed to be located.	--	--	None
			-	<resourceGroupName>	Specifies the resource group name.	Y	--	None
			[tags:]		A list of Azure tags and the expected values (exact or regular expression) with which the resources have to be annotated.	--	--	None
				<key>: <value>	Specifies the Azure tag value. This can be specified using a regular expression.	Y	--	None
			[regions:]		A list of Azure region(s) in which the resource is allowed to be located.	--	--	None
			-	<region>	Species the region.	Y	--	None

Legend:: REQ: Required setting, Y: Modifiable, N: Not modifiable, --: Not applicable
#: Brackets ([]) denote optional items.

To Page Top