Share via

CertificateOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

BatchManagementClient's

<xref:certificate> attribute.

Inheritance
builtins.object
CertificateOperations

Constructor

CertificateOperations(*args, **kwargs)

Methods

begin_delete

Deletes the specified certificate.

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.
create

Creates a new certificate inside the specified account.

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_by_batch_account

Lists all of the certificates in the specified account.

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

Updates the properties of an existing certificate.

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

begin_delete

Deletes the specified certificate.

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

begin_delete(resource_group_name: str, account_name: str, certificate_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the Batch account. Required.
account_name
Required
str

The name of the Batch account. Required.
certificate_name
Required
str

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. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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(resource_group_name: str, account_name: str, certificate_name: str, **kwargs: Any) -> Certificate

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the Batch account. Required.
account_name
Required
str

The name of the Batch account. Required.
certificate_name
Required
str

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. Required.

Returns

Type Description
Certificate

Certificate or the result of cls(response)

Exceptions

Type Description
HttpResponseError

create

Creates a new certificate inside the specified account.

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

create(resource_group_name: str, account_name: str, certificate_name: str, parameters: _models.CertificateCreateOrUpdateParameters, if_match: str | None = None, if_none_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Certificate

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the Batch account. Required.
account_name
Required
str

The name of the Batch account. Required.
certificate_name
Required
str

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. Required.
parameters
Required
CertificateCreateOrUpdateParameters or IO[bytes]

Additional parameters for certificate creation. Is either a CertificateCreateOrUpdateParameters type or a IO[bytes] type. Required.
if_match
Required
str

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. Default value is None.
if_none_match
Required
str

Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored. Default value is None.

Returns

Type Description
Certificate

Certificate or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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(resource_group_name: str, account_name: str, certificate_name: str, **kwargs: Any) -> Certificate

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the Batch account. Required.
account_name
Required
str

The name of the Batch account. Required.
certificate_name
Required
str

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. Required.

Returns

Type Description
Certificate

Certificate or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_batch_account

Lists all of the certificates in the specified account.

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

list_by_batch_account(resource_group_name: str, account_name: str, maxresults: int | None = None, select: str | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[Certificate]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the Batch account. Required.
account_name
Required
str

The name of the Batch account. Required.
maxresults
Required
int

The maximum number of items to return in the response. Default value is None.
select
Required
str

Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. Default value is None.
filter
Required
str

OData filter expression. Valid properties for filtering are "properties/provisioningState", "properties/provisioningStateTransitionTime", "name". Default value is None.

Returns

Type Description
ItemPaged[Certificate]

An iterator like instance of either Certificate or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update

Updates the properties of an existing certificate.

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

update(resource_group_name: str, account_name: str, certificate_name: str, parameters: _models.CertificateCreateOrUpdateParameters, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Certificate

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the Batch account. Required.
account_name
Required
str

The name of the Batch account. Required.
certificate_name
Required
str

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. Required.
parameters
Required
CertificateCreateOrUpdateParameters or IO[bytes]

Certificate entity to update. Is either a CertificateCreateOrUpdateParameters type or a IO[bytes] type. Required.
if_match
Required
str

The entity state (ETag) version of the certificate to update. This value can be omitted or set to "*" to apply the operation unconditionally. Default value is None.

Returns

Type Description
Certificate

Certificate or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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