Package com.azure.resourcemanager.apimanagement.models

Interface Certificates

public interface Certificates

Resource collection API of Certificates.

Method Summary

Modifier and Type	Method	Description
CertificateContract.DefinitionStages.Blank	define(String name)	Begins definition for a new CertificateContract resource.
void	delete(String resourceGroupName, String serviceName, String certificateId, String ifMatch)	Deletes specific certificate.
void	deleteById(String id)	Deletes specific certificate.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)	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.
CertificateContract	get(String resourceGroupName, String serviceName, String certificateId)	Gets the details of the certificate specified by its identifier.
CertificateContract	getById(String id)	Gets the details of the certificate specified by its identifier.
com.azure.core.http.rest.Response<CertificateContract>	getByIdWithResponse(String id, com.azure.core.util.Context context)	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.
com.azure.core.http.rest.Response<CertificateContract>	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<CertificateContract>	listByService(String resourceGroupName, String serviceName)	Lists a collection of all certificates in the specified service instance.
com.azure.core.http.rest.PagedIterable<CertificateContract>	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.
CertificateContract	refreshSecret(String resourceGroupName, String serviceName, String certificateId)	From KeyVault, Refresh the certificate being used for authentication with the backend.
com.azure.core.http.rest.Response<CertificateContract>	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<CertificateContract> 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<CertificateContract> 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

CertificateContract 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

com.azure.core.http.rest.Response<CertificateContract> 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.

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

CertificateContract 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

com.azure.core.http.rest.Response<CertificateContract> 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.

getById

CertificateContract getById(String id)

Gets the details of the certificate specified by its identifier.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<CertificateContract> getByIdWithResponse(String id,
                                                                           com.azure.core.util.Context context)

Gets the details of the certificate specified by its identifier.

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

Deletes specific certificate.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               String ifMatch,
                                                               com.azure.core.util.Context context)

Deletes specific certificate.

Parameters:

id - the resource ID.

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.

define

CertificateContract.DefinitionStages.Blank define(String name)

Begins definition for a new CertificateContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new CertificateContract definition.