artifact_manifests

Creates, updates, deletes, gets or lists an artifact_manifests resource.

Overview

Name	artifact_manifests
Type	Resource
Id	azure_extras.hybrid_network.artifact_manifests

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.
artifactManifestState	string	The artifact manifest state. Known values are: "Unknown", "Uploading", "Uploaded", "Validating", "ValidationFailed", and "Succeeded".
artifacts	array	The artifacts list.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the ArtifactManifest resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_artifact_store

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.
artifactManifestState	string	The artifact manifest state. Known values are: "Unknown", "Uploading", "Uploaded", "Validating", "ValidationFailed", and "Succeeded".
artifacts	array	The artifacts list.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the ArtifactManifest resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, artifact_manifest_name, subscription_id		Gets information about a artifact manifest resource.
list_by_artifact_store	select	resource_group_name, publisher_name, artifact_store_name, subscription_id		Gets information about the artifact manifest.
create_or_update	insert	resource_group_name, publisher_name, artifact_store_name, artifact_manifest_name, subscription_id, location		Creates or updates a artifact manifest.
update	update	resource_group_name, publisher_name, artifact_store_name, artifact_manifest_name, subscription_id		Updates a artifact manifest resource.
create_or_update	replace	resource_group_name, publisher_name, artifact_store_name, artifact_manifest_name, subscription_id, location		Creates or updates a artifact manifest.
delete	delete	resource_group_name, publisher_name, artifact_store_name, artifact_manifest_name, subscription_id		Deletes the specified artifact manifest.
list_credential	exec	resource_group_name, publisher_name, artifact_store_name, artifact_manifest_name, subscription_id		List credential for publishing artifacts defined in artifact manifest.
update_state	exec	resource_group_name, publisher_name, artifact_store_name, artifact_manifest_name, subscription_id		Update state for artifact manifest.

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
artifact_manifest_name	string	The name of the artifact manifest. Required.
artifact_store_name	string	The name of the artifact store. 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

Gets information about a artifact manifest resource.

SELECT
id,
name,
artifactManifestState,
artifacts,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.hybrid_network.artifact_manifests
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND artifact_store_name = '{{ artifact_store_name }}' -- required
AND artifact_manifest_name = '{{ artifact_manifest_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_artifact_store

Gets information about the artifact manifest.

SELECT
id,
name,
artifactManifestState,
artifacts,
location,
provisioningState,
systemData,
tags,
type
FROM azure_extras.hybrid_network.artifact_manifests
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
;

INSERT examples

create_or_update

Creates or updates a artifact manifest.

INSERT INTO azure_extras.hybrid_network.artifact_manifests (
tags,
location,
properties,
resource_group_name,
publisher_name,
artifact_store_name,
artifact_manifest_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ publisher_name }}',
'{{ artifact_store_name }}',
'{{ artifact_manifest_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: artifact_manifests
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the artifact_manifests resource.
  - name: publisher_name
    value: "{{ publisher_name }}"
    description: Required parameter for the artifact_manifests resource.
  - name: artifact_store_name
    value: "{{ artifact_store_name }}"
    description: Required parameter for the artifact_manifests resource.
  - name: artifact_manifest_name
    value: "{{ artifact_manifest_name }}"
    description: Required parameter for the artifact_manifests resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the artifact_manifests resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Artifact manifest properties.
    value:
      provisioningState: "{{ provisioningState }}"
      artifactManifestState: "{{ artifactManifestState }}"
      artifacts:
        - artifactName: "{{ artifactName }}"
          artifactType: "{{ artifactType }}"
          artifactVersion: "{{ artifactVersion }}"

UPDATE examples

update

Updates a artifact manifest resource.

UPDATE azure_extras.hybrid_network.artifact_manifests
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND publisher_name = '{{ publisher_name }}' --required
AND artifact_store_name = '{{ artifact_store_name }}' --required
AND artifact_manifest_name = '{{ artifact_manifest_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a artifact manifest.

REPLACE azure_extras.hybrid_network.artifact_manifests
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND publisher_name = '{{ publisher_name }}' --required
AND artifact_store_name = '{{ artifact_store_name }}' --required
AND artifact_manifest_name = '{{ artifact_manifest_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified artifact manifest.

DELETE FROM azure_extras.hybrid_network.artifact_manifests
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND publisher_name = '{{ publisher_name }}' --required
AND artifact_store_name = '{{ artifact_store_name }}' --required
AND artifact_manifest_name = '{{ artifact_manifest_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_credential

List credential for publishing artifacts defined in artifact manifest.

EXEC azure_extras.hybrid_network.artifact_manifests.list_credential 
@resource_group_name='{{ resource_group_name }}' --required, 
@publisher_name='{{ publisher_name }}' --required, 
@artifact_store_name='{{ artifact_store_name }}' --required, 
@artifact_manifest_name='{{ artifact_manifest_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_state

Update state for artifact manifest.

EXEC azure_extras.hybrid_network.artifact_manifests.update_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@publisher_name='{{ publisher_name }}' --required, 
@artifact_store_name='{{ artifact_store_name }}' --required, 
@artifact_manifest_name='{{ artifact_manifest_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"artifactManifestState": "{{ artifactManifestState }}"
}'
;