Certificates Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface Certificates

Resource collection API of Certificates.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new CertificateContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String certificateId, String ifMatch) Deletes specific certificate.
abstract void	deleteById(String id) Deletes specific certificate.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes specific certificate.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String certificateId, String ifMatch, Context context) Deletes specific certificate.
abstract CertificateContract	get(String resourceGroupName, String serviceName, String certificateId) Gets the details of the certificate specified by its identifier.
abstract CertificateContract	getById(String id) Gets the details of the certificate specified by its identifier.
abstract Response<CertificateContract>	getByIdWithResponse(String id, Context context) Gets the details of the certificate specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String certificateId) Gets the entity state (Etag) version of the certificate specified by its identifier.
abstract CertificatesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String certificateId, Context context) Gets the entity state (Etag) version of the certificate specified by its identifier.
abstract Response<CertificateContract>	getWithResponse(String resourceGroupName, String serviceName, String certificateId, Context context) Gets the details of the certificate specified by its identifier.
abstract PagedIterable<CertificateContract>	listByService(String resourceGroupName, String serviceName) Lists a collection of all certificates in the specified service instance.
abstract PagedIterable<CertificateContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Boolean isKeyVaultRefreshFailed, Context context) Lists a collection of all certificates in the specified service instance.
abstract CertificateContract	refreshSecret(String resourceGroupName, String serviceName, String certificateId) From KeyVault, Refresh the certificate being used for authentication with the backend.
abstract Response<CertificateContract>	refreshSecretWithResponse(String resourceGroupName, String serviceName, String certificateId, Context context) From KeyVault, Refresh the certificate being used for authentication with the backend.

Method Details

define

public abstract 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.

delete

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

Deletes specific certificate.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

deleteById

public abstract void deleteById(String id)

Deletes specific certificate.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, 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<T>.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String certificateId, String ifMatch, Context context)

Deletes specific certificate.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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

get

public abstract 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. The name is case insensitive.

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.

getById

public abstract 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.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, 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.

getEntityTag

public abstract 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. The name is case insensitive.

serviceName - The name of the API Management service.

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

getEntityTagWithResponse

public abstract CertificatesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String certificateId, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String certificateId, Context context)

Gets the details of the certificate specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

Returns:

paged Certificates list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Boolean isKeyVaultRefreshFailed, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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

refreshSecret

public abstract 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. The name is case insensitive.

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.

refreshSecretWithResponse

public abstract Response refreshSecretWithResponse(String resourceGroupName, String serviceName, String certificateId, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.