certificates

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

Overview

Name	certificates
Type	Resource
Id	azure.batch.certificates

Fields

The following fields are returned by SELECT queries:

get

The operation was successful. The response contains the certificate entity.

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
etag	string	The ETag of the resource, used for concurrency statements.
properties	object	The properties associated with the certificate.
tags	object	The tags of the resource.
type	string	The type of the resource.

list_by_batch_account

The operation was successful. The response contains a list of certificates associated with the account.

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
etag	string	The ETag of the resource, used for concurrency statements.
properties	object	The properties associated with the certificate.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, accountName, certificateName, subscriptionId		Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
list_by_batch_account	select	resourceGroupName, accountName, subscriptionId	maxresults, $select, $filter	Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
create	insert	resourceGroupName, accountName, certificateName, subscriptionId	If-Match, If-None-Match	Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
update	update	resourceGroupName, accountName, certificateName, subscriptionId	If-Match	Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
delete	delete	resourceGroupName, accountName, certificateName, subscriptionId		Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.
cancel_deletion	exec	resourceGroupName, accountName, certificateName, subscriptionId		If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

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
accountName	string	The name of the Batch account.
certificateName	string	The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.
resourceGroupName	string	The name of the resource group that contains the Batch account.
subscriptionId	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
$filter	string	OData filter expression. Valid properties for filtering are "properties/provisioningState", "properties/provisioningStateTransitionTime", "name".
$select	string	Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection.
If-Match	string	The entity state (ETag) version of the certificate to update. This value can be omitted or set to "*" to apply the operation unconditionally.
If-None-Match	string	Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored.
maxresults	integer (int32)	The maximum number of items to return in the response.

SELECT examples

get

Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

SELECT
id,
name,
etag,
properties,
tags,
type
FROM azure.batch.certificates
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND certificateName = '{{ certificateName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_batch_account

Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

SELECT
id,
name,
etag,
properties,
tags,
type
FROM azure.batch.certificates
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND maxresults = '{{ maxresults }}'
AND $select = '{{ $select }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

INSERT INTO azure.batch.certificates (
data__properties,
data__tags,
resourceGroupName,
accountName,
certificateName,
subscriptionId,
If-Match,
If-None-Match
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ certificateName }}',
'{{ subscriptionId }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
etag,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: certificates
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the certificates resource.
    - name: accountName
      value: string
      description: Required parameter for the certificates resource.
    - name: certificateName
      value: string
      description: Required parameter for the certificates resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the certificates resource.
    - name: properties
      value: object
      description: |
        The properties associated with the certificate.
    - name: tags
      value: object
      description: |
        The tags of the resource.
    - name: If-Match
      value: string
      description: The entity state (ETag) version of the certificate to update. A value of "*" can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored.

UPDATE examples

update

Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

UPDATE azure.batch.certificates
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND certificateName = '{{ certificateName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
properties,
tags,
type;

DELETE examples

delete

Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

DELETE FROM azure.batch.certificates
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND certificateName = '{{ certificateName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

cancel_deletion

If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

EXEC azure.batch.certificates.cancel_deletion 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@certificateName='{{ certificateName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;