artifacts
Creates, updates, deletes, gets or lists an artifacts resource.
Overview
| Name | artifacts |
| Type | Resource |
| Id | azure_stack.disconnected_operations.artifacts |
Fields
The following fields are returned by SELECT queries:
- get
- list_by_parent
| 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. |
artifactOrder | integer | The artifact display order. Required. |
description | string | The artifact description. Required. |
provisioningState | string | The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled) |
size | integer | The artifact size in MB. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
title | string | The artifact title. Required. |
type | string | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
| 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. |
artifactOrder | integer | The artifact display order. Required. |
description | string | The artifact description. Required. |
provisioningState | string | The resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled) |
size | integer | The artifact size in MB. |
systemData | object | Azure Resource Manager metadata containing createdBy and modifiedBy information. |
title | string | The artifact title. Required. |
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, name, image_name, artifact_name, subscription_id | Get the resource. | |
list_by_parent | select | resource_group_name, name, image_name, subscription_id | List by parent. | |
list_download_uri | exec | resource_group_name, name, image_name, artifact_name, subscription_id | Get artifact download link. |
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_name | string | The name of the Artifact. Required. |
image_name | string | The name of the Image. Required. |
name | string | Name of the resource. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string |
SELECT examples
- get
- list_by_parent
Get the resource.
SELECT
id,
name,
artifactOrder,
description,
provisioningState,
size,
systemData,
title,
type
FROM azure_stack.disconnected_operations.artifacts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND image_name = '{{ image_name }}' -- required
AND artifact_name = '{{ artifact_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
List by parent.
SELECT
id,
name,
artifactOrder,
description,
provisioningState,
size,
systemData,
title,
type
FROM azure_stack.disconnected_operations.artifacts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND image_name = '{{ image_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Lifecycle Methods
- list_download_uri
Get artifact download link.
EXEC azure_stack.disconnected_operations.artifacts.list_download_uri
@resource_group_name='{{ resource_group_name }}' --required,
@name='{{ name }}' --required,
@image_name='{{ image_name }}' --required,
@artifact_name='{{ artifact_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
;