Share via

CertificatesClient Interface

Package:
com.azure.resourcemanager.batch.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-batch:2.0.0

public interface CertificatesClient

An instance of this class provides access to all the operations defined in CertificatesClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, String certificateName)

Deletes the specified certificate.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, String certificateName, Context context)

Deletes the specified certificate.
abstract CertificateInner cancelDeletion(String resourceGroupName, String accountName, String certificateName)

Cancels a failed deletion of a certificate from the specified account.
abstract CertificatesCancelDeletionResponse cancelDeletionWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)

Cancels a failed deletion of a certificate from the specified account.
abstract CertificateInner create(String resourceGroupName, String accountName, String certificateName, CertificateCreateOrUpdateParameters parameters)

Creates a new certificate inside the specified account.
abstract CertificatesCreateResponse createWithResponse(String resourceGroupName, String accountName, String certificateName, CertificateCreateOrUpdateParameters parameters, String ifMatch, String ifNoneMatch, Context context)

Creates a new certificate inside the specified account.
abstract void delete(String resourceGroupName, String accountName, String certificateName)

Deletes the specified certificate.
abstract void delete(String resourceGroupName, String accountName, String certificateName, Context context)

Deletes the specified certificate.
abstract CertificateInner get(String resourceGroupName, String accountName, String certificateName)

Gets information about the specified certificate.
abstract CertificatesGetResponse getWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)

Gets information about the specified certificate.
abstract PagedIterable<CertificateInner> listByBatchAccount(String resourceGroupName, String accountName)

Lists all of the certificates in the specified account.
abstract PagedIterable<CertificateInner> listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)

Lists all of the certificates in the specified account.
abstract CertificateInner update(String resourceGroupName, String accountName, String certificateName, CertificateCreateOrUpdateParameters parameters)

Updates the properties of an existing certificate.
abstract CertificatesUpdateResponse updateWithResponse(String resourceGroupName, String accountName, String certificateName, CertificateCreateOrUpdateParameters parameters, String ifMatch, Context context)

Updates the properties of an existing certificate.

Method Details

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, String certificateName)

Deletes the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String accountName, String certificateName, Context context)

Deletes the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

cancelDeletion

public abstract CertificateInner cancelDeletion(String resourceGroupName, String accountName, String certificateName)

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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.

Returns:

contains information about a certificate.

cancelDeletionWithResponse

public abstract CertificatesCancelDeletionResponse cancelDeletionWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)

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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.
context - The context to associate with this operation.

Returns:

contains information about a certificate.

create

public abstract CertificateInner create(String resourceGroupName, String accountName, String certificateName, CertificateCreateOrUpdateParameters parameters)

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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.
parameters - Additional parameters for certificate creation.

Returns:

contains information about a certificate.

createWithResponse

public abstract CertificatesCreateResponse createWithResponse(String resourceGroupName, String accountName, String certificateName, CertificateCreateOrUpdateParameters parameters, String ifMatch, String ifNoneMatch, Context context)

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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.
parameters - Additional parameters for certificate creation.
ifMatch - 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.
ifNoneMatch - Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored.
context - The context to associate with this operation.

Returns:

contains information about a certificate.

delete

public abstract void delete(String resourceGroupName, String accountName, String certificateName)

Deletes the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.

delete

public abstract void delete(String resourceGroupName, String accountName, String certificateName, Context context)

Deletes the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.
context - The context to associate with this operation.

get

public abstract CertificateInner get(String resourceGroupName, String accountName, String certificateName)

Gets information about the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.

Returns:

contains information about a certificate.

getWithResponse

public abstract CertificatesGetResponse getWithResponse(String resourceGroupName, String accountName, String certificateName, Context context)

Gets information about the specified certificate. Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.
context - The context to associate with this operation.

Returns:

contains information about a certificate.

listByBatchAccount

public abstract PagedIterable<CertificateInner> listByBatchAccount(String resourceGroupName, String accountName)

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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.

Returns:

values returned by the List operation as paginated response with PagedIterable<T>.

listByBatchAccount

public abstract PagedIterable<CertificateInner> listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)

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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
maxresults - The maximum number of items to return in the response.
select - Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection.
filter - OData filter expression. Valid properties for filtering are "properties/provisioningState", "properties/provisioningStateTransitionTime", "name".
context - The context to associate with this operation.

Returns:

values returned by the List operation as paginated response with PagedIterable<T>.

update

public abstract CertificateInner update(String resourceGroupName, String accountName, String certificateName, CertificateCreateOrUpdateParameters parameters)

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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.
parameters - Certificate entity to update.

Returns:

contains information about a certificate.

updateWithResponse

public abstract CertificatesUpdateResponse updateWithResponse(String resourceGroupName, String accountName, String certificateName, CertificateCreateOrUpdateParameters parameters, String ifMatch, Context context)

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](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

Parameters:

resourceGroupName - The name of the resource group that contains the Batch account.
accountName - The name of the Batch account.
certificateName - 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.
parameters - Certificate entity to update.
ifMatch - The entity state (ETag) version of the certificate to update. This value can be omitted or set to "*" to apply the operation unconditionally.
context - The context to associate with this operation.

Returns:

contains information about a certificate.

Applies to