CertificateOperations Class

CertificateOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Inheritance
builtins.object
CertificateOperations

Constructor

CertificateOperations(client, config, serializer, deserializer)

Parameters

Name Description
client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

Name Description
api_version

The API version to use for the request. Constant value: "2024-02-01.19.0".

Methods

add

Adds a Certificate to the specified Account.

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

cancel_deletion

Cancels a failed deletion of a Certificate from the specified Account.

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.

delete

Deletes a Certificate from the specified Account.

You cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

get

Gets information about the specified Certificate.

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

list

Lists all of the Certificates that have been added to the specified Account.

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

add

Adds a Certificate to the specified Account.

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

add(certificate, certificate_add_options=None, custom_headers=None, raw=False, **operation_config)

Parameters

Name Description
certificate
Required

The Certificate to be added.

certificate_add_options

Additional parameters for the operation

Default value: None
custom_headers

headers that will be added to the request

Default value: None
raw

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
None,
<xref:msrest.pipeline.ClientRawResponse>

None or ClientRawResponse if raw=true

Exceptions

Type Description

cancel_deletion

Cancels a failed deletion of a Certificate from the specified Account.

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.

cancel_deletion(thumbprint_algorithm, thumbprint, certificate_cancel_deletion_options=None, custom_headers=None, raw=False, **operation_config)

Parameters

Name Description
thumbprint_algorithm
Required
str

The algorithm used to derive the thumbprint parameter. This must be sha1.

thumbprint
Required
str

The thumbprint of the Certificate being deleted.

certificate_cancel_deletion_options

Additional parameters for the operation

Default value: None
custom_headers

headers that will be added to the request

Default value: None
raw

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
None,
<xref:msrest.pipeline.ClientRawResponse>

None or ClientRawResponse if raw=true

Exceptions

Type Description

delete

Deletes a Certificate from the specified Account.

You cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the Azure KeyVault Extension instead.

delete(thumbprint_algorithm, thumbprint, certificate_delete_options=None, custom_headers=None, raw=False, **operation_config)

Parameters

Name Description
thumbprint_algorithm
Required
str

The algorithm used to derive the thumbprint parameter. This must be sha1.

thumbprint
Required
str

The thumbprint of the Certificate to be deleted.

certificate_delete_options

Additional parameters for the operation

Default value: None
custom_headers

headers that will be added to the request

Default value: None
raw

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
None,
<xref:msrest.pipeline.ClientRawResponse>

None or ClientRawResponse if raw=true

Exceptions

Type Description

get

Gets information about the specified Certificate.

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

get(thumbprint_algorithm, thumbprint, certificate_get_options=None, custom_headers=None, raw=False, **operation_config)

Parameters

Name Description
thumbprint_algorithm
Required
str

The algorithm used to derive the thumbprint parameter. This must be sha1.

thumbprint
Required
str

The thumbprint of the Certificate to get.

certificate_get_options

Additional parameters for the operation

Default value: None
custom_headers

headers that will be added to the request

Default value: None
raw

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description
<xref:msrest.pipeline.ClientRawResponse>

Certificate or ClientRawResponse if raw=true

Exceptions

Type Description

list

Lists all of the Certificates that have been added to the specified Account.

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

list(certificate_list_options=None, custom_headers=None, raw=False, **operation_config)

Parameters

Name Description
certificate_list_options

Additional parameters for the operation

Default value: None
custom_headers

headers that will be added to the request

Default value: None
raw

returns the direct response alongside the deserialized response

Default value: False
operation_config
Required

Operation configuration overrides.

Returns

Type Description

An iterator like instance of Certificate

Exceptions

Type Description

Attributes

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>