components

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

Overview

Name	components
Type	Resource
Id	azure_extras.hybrid_network.components

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
deploymentProfile	string	The JSON-serialized deployment profile of the component resource.
deploymentStatus	object	The deployment status of the component resource.
provisioningState	string	The provisioning state of the component resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_network_function

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
deploymentProfile	string	The JSON-serialized deployment profile of the component resource.
deploymentStatus	object	The deployment status of the component resource.
provisioningState	string	The provisioning state of the component resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_function_name, component_name, subscription_id		Gets information about the specified application instance resource.
list_by_network_function	select	resource_group_name, network_function_name, subscription_id		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
component_name	string	The name of the component. Required.
network_function_name	string	The name of the network function. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets information about the specified application instance resource.

SELECT
id,
name,
deploymentProfile,
deploymentStatus,
provisioningState,
systemData,
type
FROM azure_extras.hybrid_network.components
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_function_name = '{{ network_function_name }}' -- required
AND component_name = '{{ component_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_network_function

Lists all the component resources in a network function.

SELECT
id,
name,
deploymentProfile,
deploymentStatus,
provisioningState,
systemData,
type
FROM azure_extras.hybrid_network.components
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_function_name = '{{ network_function_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;