code_signing_accounts

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

Overview

Name	code_signing_accounts
Type	Resource
Id	azure.artifact_signing.code_signing_accounts

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.
accountUri	string	The URI of the artifact signing account which is used during signing files.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Status of the current operation on artifact signing account. Known values are: "Succeeded", "Failed", "Canceled", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Updating, Deleting, Accepted)
sku	object	SKU of the artifact signing account.
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".

check_name_availability

Name	Datatype	Description
message	string	An error message explaining the Reason value in more detail.
nameAvailable	boolean	A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.
reason	string	The reason that an artifact signing account name could not be used. The Reason element is only returned if nameAvailable is false. Known values are: "AccountNameInvalid" and "AlreadyExists". (AccountNameInvalid, AlreadyExists)

list_by_resource_group

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.
accountUri	string	The URI of the artifact signing account which is used during signing files.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Status of the current operation on artifact signing account. Known values are: "Succeeded", "Failed", "Canceled", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Updating, Deleting, Accepted)
sku	object	SKU of the artifact signing account.
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_subscription

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.
accountUri	string	The URI of the artifact signing account which is used during signing files.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Status of the current operation on artifact signing account. Known values are: "Succeeded", "Failed", "Canceled", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Updating, Deleting, Accepted)
sku	object	SKU of the artifact signing account.
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, account_name, subscription_id		Get an artifact Signing Account.
check_name_availability	select	subscription_id		Checks if the artifact signing account name is valid and is not already in use.
list_by_resource_group	select	resource_group_name, subscription_id		Lists artifact signing accounts within a resource group.
list_by_subscription	select	subscription_id		Lists artifact signing accounts within a subscription.
create	insert	resource_group_name, account_name, subscription_id, location		Create an artifact Signing Account.
update	update	resource_group_name, account_name, subscription_id		Update an artifact signing account.
delete	delete	resource_group_name, account_name, subscription_id		Delete an artifact signing account.

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
account_name	string	Artifact Signing account name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get an artifact Signing Account.

SELECT
id,
name,
accountUri,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.artifact_signing.code_signing_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_name_availability

Checks if the artifact signing account name is valid and is not already in use.

SELECT
message,
nameAvailable,
reason
FROM azure.artifact_signing.code_signing_accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists artifact signing accounts within a resource group.

SELECT
id,
name,
accountUri,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.artifact_signing.code_signing_accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists artifact signing accounts within a subscription.

SELECT
id,
name,
accountUri,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.artifact_signing.code_signing_accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create an artifact Signing Account.

INSERT INTO azure.artifact_signing.code_signing_accounts (
tags,
location,
properties,
resource_group_name,
account_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: code_signing_accounts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the code_signing_accounts resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the code_signing_accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the code_signing_accounts resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      accountUri: "{{ accountUri }}"
      sku:
        name: "{{ name }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update an artifact signing account.

UPDATE azure.artifact_signing.code_signing_accounts
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete an artifact signing account.

DELETE FROM azure.artifact_signing.code_signing_accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;