components

Creates, updates, deletes, gets or lists a components resource.

Overview

Name	components
Type	Resource
Id	azure.hybrid_network.components

Fields

The following fields are returned by SELECT queries:

get

Operation is successful. The operation returns the resulting component resource.

Name	Datatype	Description
properties	object	The component properties.

list_by_network_function

Request is successful. The operation returns a list of component resources.

Name	Datatype	Description
properties	object	The component properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, networkFunctionName, componentName, subscriptionId		Gets information about the specified application instance resource.
list_by_network_function	select	resourceGroupName, subscriptionId, networkFunctionName		Lists all the component resources in a network function.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
componentName	string	The name of the component.
networkFunctionName	string	The name of the network function.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets information about the specified application instance resource.

SELECT
properties
FROM azure.hybrid_network.components
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkFunctionName = '{{ networkFunctionName }}' -- required
AND componentName = '{{ componentName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_network_function

Lists all the component resources in a network function.

SELECT
properties
FROM azure.hybrid_network.components
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND networkFunctionName = '{{ networkFunctionName }}' -- required
;