Package com.azure.resourcemanager.apimanagement.fluent

Interface GatewayCertificateAuthoritiesClient

public interface GatewayCertificateAuthoritiesClient

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

Method Summary

Modifier and Type	Method	Description
GatewayCertificateAuthorityContractInner	createOrUpdate(String resourceGroupName, String serviceName, String gatewayId, String certificateId, GatewayCertificateAuthorityContractInner parameters)	Assign Certificate entity to Gateway entity as Certificate Authority.
GatewayCertificateAuthoritiesCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String gatewayId, String certificateId, GatewayCertificateAuthorityContractInner parameters, String ifMatch, com.azure.core.util.Context context)	Assign Certificate entity to Gateway entity as Certificate Authority.
void	delete(String resourceGroupName, String serviceName, String gatewayId, String certificateId, String ifMatch)	Remove relationship between Certificate Authority and Gateway entity.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String gatewayId, String certificateId, String ifMatch, com.azure.core.util.Context context)	Remove relationship between Certificate Authority and Gateway entity.
GatewayCertificateAuthorityContractInner	get(String resourceGroupName, String serviceName, String gatewayId, String certificateId)	Get assigned Gateway Certificate Authority details.
void	getEntityTag(String resourceGroupName, String serviceName, String gatewayId, String certificateId)	Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.
GatewayCertificateAuthoritiesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String gatewayId, String certificateId, com.azure.core.util.Context context)	Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.
GatewayCertificateAuthoritiesGetResponse	getWithResponse(String resourceGroupName, String serviceName, String gatewayId, String certificateId, com.azure.core.util.Context context)	Get assigned Gateway Certificate Authority details.
com.azure.core.http.rest.PagedIterable<GatewayCertificateAuthorityContractInner>	listByService(String resourceGroupName, String serviceName, String gatewayId)	Lists the collection of Certificate Authorities for the specified Gateway entity.
com.azure.core.http.rest.PagedIterable<GatewayCertificateAuthorityContractInner>	listByService(String resourceGroupName, String serviceName, String gatewayId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists the collection of Certificate Authorities for the specified Gateway entity.

Method Detail

listByService

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

Lists the collection of Certificate Authorities for the specified Gateway entity.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

Returns:

paged Gateway certificate authority 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<GatewayCertificateAuthorityContractInner> listByService(String resourceGroupName,
                                                                                               String serviceName,
                                                                                               String gatewayId,
                                                                                               String filter,
                                                                                               Integer top,
                                                                                               Integer skip,
                                                                                               com.azure.core.util.Context context)

Lists the collection of Certificate Authorities for the specified Gateway entity.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | eq, ne | |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Gateway certificate authority 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 gatewayId,
                  String certificateId)

Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

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

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

Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

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

get

GatewayCertificateAuthorityContractInner get(String resourceGroupName,
                                             String serviceName,
                                             String gatewayId,
                                             String certificateId)

Get assigned Gateway Certificate Authority details.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

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

Returns:

assigned Gateway Certificate Authority 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.

getWithResponse

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

Get assigned Gateway Certificate Authority details.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

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:

assigned Gateway Certificate Authority 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.

createOrUpdate

GatewayCertificateAuthorityContractInner createOrUpdate(String resourceGroupName,
                                                        String serviceName,
                                                        String gatewayId,
                                                        String certificateId,
                                                        GatewayCertificateAuthorityContractInner parameters)

Assign Certificate entity to Gateway entity as Certificate Authority.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

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

parameters - Gateway certificate authority details.

Returns:

gateway certificate authority 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

GatewayCertificateAuthoritiesCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                                               String serviceName,
                                                                               String gatewayId,
                                                                               String certificateId,
                                                                               GatewayCertificateAuthorityContractInner parameters,
                                                                               String ifMatch,
                                                                               com.azure.core.util.Context context)

Assign Certificate entity to Gateway entity as Certificate Authority.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

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

parameters - Gateway certificate authority details.

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:

gateway certificate authority 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 gatewayId,
            String certificateId,
            String ifMatch)

Remove relationship between Certificate Authority and Gateway entity.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

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 gatewayId,
                                                           String certificateId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Remove relationship between Certificate Authority and Gateway entity.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.

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.