proxy_artifact

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

Overview

Name	proxy_artifact
Type	Resource
Id	azure_extras.hybrid_network.proxy_artifact

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.
artifactState	string	The artifact state. Known values are: "Unknown", "Preview", "Active", and "Deprecated".
artifactType	string	The artifact type. Known values are: "Unknown", "OCIArtifact", "VhdImageFile", "ArmTemplate", and "ImageFile".
artifactVersion	string	The artifact version.
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

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.
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, publisher_name, artifact_store_name, subscription_id, artifactName		Get a Artifact overview information.
list	select	resource_group_name, publisher_name, artifact_store_name, subscription_id		Lists all the available artifacts in the parent Artifact Store.
update_state	exec	resource_group_name, publisher_name, artifact_store_name, artifact_version_name, subscription_id, artifactName		Change artifact state defined in artifact store.

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
artifactName	string	The name of the artifact. Required.
artifact_store_name	string	The name of the artifact store. Required.
artifact_version_name	string	The name of the artifact version. Required.
publisher_name	string	The name of the publisher. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Artifact overview information.

SELECT
id,
name,
artifactState,
artifactType,
artifactVersion,
systemData,
type
FROM azure_extras.hybrid_network.proxy_artifact
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND artifact_store_name = '{{ artifact_store_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND artifactName = '{{ artifactName }}' -- required
;

list

Lists all the available artifacts in the parent Artifact Store.

SELECT
id,
name,
systemData,
type
FROM azure_extras.hybrid_network.proxy_artifact
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND artifact_store_name = '{{ artifact_store_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

update_state

Change artifact state defined in artifact store.

EXEC azure_extras.hybrid_network.proxy_artifact.update_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@publisher_name='{{ publisher_name }}' --required, 
@artifact_store_name='{{ artifact_store_name }}' --required, 
@artifact_version_name='{{ artifact_version_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@artifactName='{{ artifactName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;