Package com.azure.resourcemanager.apimanagement.fluent

Interface CertificatesClient

public interface CertificatesClient

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

Method Summary

Modifier and Type	Method	Description
CertificateContractInner	createOrUpdate(String resourceGroupName, String serviceName, String certificateId, CertificateCreateOrUpdateParameters parameters)	Creates or updates the certificate being used for authentication with the backend.
CertificatesCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String certificateId, CertificateCreateOrUpdateParameters parameters, String ifMatch, com.azure.core.util.Context context)	Creates or updates the certificate being used for authentication with the backend.
void	delete(String resourceGroupName, String serviceName, String certificateId, String ifMatch)	Deletes specific certificate.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String certificateId, String ifMatch, com.azure.core.util.Context context)	Deletes specific certificate.
CertificateContractInner	get(String resourceGroupName, String serviceName, String certificateId)	Gets the details of the certificate specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String certificateId)	Gets the entity state (Etag) version of the certificate specified by its identifier.
CertificatesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String certificateId, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the certificate specified by its identifier.
CertificatesGetResponse	getWithResponse(String resourceGroupName, String serviceName, String certificateId, com.azure.core.util.Context context)	Gets the details of the certificate specified by its identifier.
com.azure.core.http.rest.PagedIterable<CertificateContractInner>	listByService(String resourceGroupName, String serviceName)	Lists a collection of all certificates in the specified service instance.
com.azure.core.http.rest.PagedIterable<CertificateContractInner>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Boolean isKeyVaultRefreshFailed, com.azure.core.util.Context context)	Lists a collection of all certificates in the specified service instance.
CertificateContractInner	refreshSecret(String resourceGroupName, String serviceName, String certificateId)	From KeyVault, Refresh the certificate being used for authentication with the backend.
CertificatesRefreshSecretResponse	refreshSecretWithResponse(String resourceGroupName, String serviceName, String certificateId, com.azure.core.util.Context context)	From KeyVault, Refresh the certificate being used for authentication with the backend.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<CertificateContractInner> listByService(String resourceGroupName,
                                                                               String serviceName)

Lists a collection of all certificates in the specified service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

paged Certificates list representation as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByService

com.azure.core.http.rest.PagedIterable<CertificateContractInner> listByService(String resourceGroupName,
                                                                               String serviceName,
                                                                               String filter,
                                                                               Integer top,
                                                                               Integer skip,
                                                                               Boolean isKeyVaultRefreshFailed,
                                                                               com.azure.core.util.Context context)

Lists a collection of all certificates in the specified service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| expirationDate | filter | ge, le, eq, ne, gt, lt | |</br>.

top - Number of records to return.

skip - Number of records to skip.

isKeyVaultRefreshFailed - When set to true, the response contains only certificates entities which failed refresh.

context - The context to associate with this operation.

Returns:

paged Certificates list representation as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntityTag

void getEntityTag(String resourceGroupName,
                  String serviceName,
                  String certificateId)

Gets the entity state (Etag) version of the certificate specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntityTagWithResponse

CertificatesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                          String serviceName,
                                                          String certificateId,
                                                          com.azure.core.util.Context context)

Gets the entity state (Etag) version of the certificate specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the entity state (Etag) version of the certificate specified by its identifier.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

CertificateContractInner get(String resourceGroupName,
                             String serviceName,
                             String certificateId)

Gets the details of the certificate specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.

Returns:

the details of the certificate specified by its identifier.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

CertificatesGetResponse getWithResponse(String resourceGroupName,
                                        String serviceName,
                                        String certificateId,
                                        com.azure.core.util.Context context)

Gets the details of the certificate specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the details of the certificate specified by its identifier.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

CertificateContractInner createOrUpdate(String resourceGroupName,
                                        String serviceName,
                                        String certificateId,
                                        CertificateCreateOrUpdateParameters parameters)

Creates or updates the certificate being used for authentication with the backend.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.

parameters - Create or Update parameters.

Returns:

certificate details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponse

CertificatesCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                              String serviceName,
                                                              String certificateId,
                                                              CertificateCreateOrUpdateParameters parameters,
                                                              String ifMatch,
                                                              com.azure.core.util.Context context)

Creates or updates the certificate being used for authentication with the backend.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.

parameters - Create or Update parameters.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

certificate details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String serviceName,
            String certificateId,
            String ifMatch)

Deletes specific certificate.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String certificateId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes specific certificate.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

refreshSecret

CertificateContractInner refreshSecret(String resourceGroupName,
                                       String serviceName,
                                       String certificateId)

From KeyVault, Refresh the certificate being used for authentication with the backend.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.

Returns:

certificate details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

refreshSecretWithResponse

CertificatesRefreshSecretResponse refreshSecretWithResponse(String resourceGroupName,
                                                            String serviceName,
                                                            String certificateId,
                                                            com.azure.core.util.Context context)

From KeyVault, Refresh the certificate being used for authentication with the backend.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

certificateId - Identifier of the certificate entity. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

certificate details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.