Package com.azure.resourcemanager.apimanagement.fluent

Interface TenantAccessClient

public interface TenantAccessClient

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

Method Summary

Modifier and Type	Method	Description
AccessInformationContractInner	create(String resourceGroupName, String serviceName, AccessIdName accessName, String ifMatch, AccessInformationCreateParameters parameters)	Update tenant access information details.
TenantAccessCreateResponse	createWithResponse(String resourceGroupName, String serviceName, AccessIdName accessName, String ifMatch, AccessInformationCreateParameters parameters, com.azure.core.util.Context context)	Update tenant access information details.
AccessInformationContractInner	get(String resourceGroupName, String serviceName, AccessIdName accessName)	Get tenant access information details without secrets.
void	getEntityTag(String resourceGroupName, String serviceName, AccessIdName accessName)	Tenant access metadata.
TenantAccessGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, AccessIdName accessName, com.azure.core.util.Context context)	Tenant access metadata.
TenantAccessGetResponse	getWithResponse(String resourceGroupName, String serviceName, AccessIdName accessName, com.azure.core.util.Context context)	Get tenant access information details without secrets.
com.azure.core.http.rest.PagedIterable<AccessInformationContractInner>	listByService(String resourceGroupName, String serviceName)	Returns list of access infos - for Git and Management endpoints.
com.azure.core.http.rest.PagedIterable<AccessInformationContractInner>	listByService(String resourceGroupName, String serviceName, String filter, com.azure.core.util.Context context)	Returns list of access infos - for Git and Management endpoints.
AccessInformationSecretsContractInner	listSecrets(String resourceGroupName, String serviceName, AccessIdName accessName)	Get tenant access information details.
TenantAccessListSecretsResponse	listSecretsWithResponse(String resourceGroupName, String serviceName, AccessIdName accessName, com.azure.core.util.Context context)	Get tenant access information details.
void	regeneratePrimaryKey(String resourceGroupName, String serviceName, AccessIdName accessName)	Regenerate primary access key.
com.azure.core.http.rest.Response<Void>	regeneratePrimaryKeyWithResponse(String resourceGroupName, String serviceName, AccessIdName accessName, com.azure.core.util.Context context)	Regenerate primary access key.
void	regenerateSecondaryKey(String resourceGroupName, String serviceName, AccessIdName accessName)	Regenerate secondary access key.
com.azure.core.http.rest.Response<Void>	regenerateSecondaryKeyWithResponse(String resourceGroupName, String serviceName, AccessIdName accessName, com.azure.core.util.Context context)	Regenerate secondary access key.
AccessInformationContractInner	update(String resourceGroupName, String serviceName, AccessIdName accessName, String ifMatch, AccessInformationUpdateParameters parameters)	Update tenant access information details.
TenantAccessUpdateResponse	updateWithResponse(String resourceGroupName, String serviceName, AccessIdName accessName, String ifMatch, AccessInformationUpdateParameters parameters, com.azure.core.util.Context context)	Update tenant access information details.

Method Detail

listByService

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

Returns list of access infos - for Git and Management endpoints.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

paged AccessInformation 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<AccessInformationContractInner> listByService(String resourceGroupName,
                                                                                     String serviceName,
                                                                                     String filter,
                                                                                     com.azure.core.util.Context context)

Returns list of access infos - for Git and Management endpoints.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

filter - Not used.

context - The context to associate with this operation.

Returns:

paged AccessInformation 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,
                  AccessIdName accessName)

Tenant access metadata.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

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

TenantAccessGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                          String serviceName,
                                                          AccessIdName accessName,
                                                          com.azure.core.util.Context context)

Tenant access metadata.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

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

AccessInformationContractInner get(String resourceGroupName,
                                   String serviceName,
                                   AccessIdName accessName)

Get tenant access information details without secrets.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

Returns:

tenant access information details without secrets.

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

TenantAccessGetResponse getWithResponse(String resourceGroupName,
                                        String serviceName,
                                        AccessIdName accessName,
                                        com.azure.core.util.Context context)

Get tenant access information details without secrets.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

context - The context to associate with this operation.

Returns:

tenant access information details without secrets.

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.

create

AccessInformationContractInner create(String resourceGroupName,
                                      String serviceName,
                                      AccessIdName accessName,
                                      String ifMatch,
                                      AccessInformationCreateParameters parameters)

Update tenant access information details.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

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.

parameters - Parameters supplied to retrieve the Tenant Access Information.

Returns:

tenant Settings.

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.

createWithResponse

TenantAccessCreateResponse createWithResponse(String resourceGroupName,
                                              String serviceName,
                                              AccessIdName accessName,
                                              String ifMatch,
                                              AccessInformationCreateParameters parameters,
                                              com.azure.core.util.Context context)

Update tenant access information details.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

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.

parameters - Parameters supplied to retrieve the Tenant Access Information.

context - The context to associate with this operation.

Returns:

tenant Settings.

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.

update

AccessInformationContractInner update(String resourceGroupName,
                                      String serviceName,
                                      AccessIdName accessName,
                                      String ifMatch,
                                      AccessInformationUpdateParameters parameters)

Update tenant access information details.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

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.

parameters - Parameters supplied to retrieve the Tenant Access Information.

Returns:

tenant Settings.

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.

updateWithResponse

TenantAccessUpdateResponse updateWithResponse(String resourceGroupName,
                                              String serviceName,
                                              AccessIdName accessName,
                                              String ifMatch,
                                              AccessInformationUpdateParameters parameters,
                                              com.azure.core.util.Context context)

Update tenant access information details.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

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.

parameters - Parameters supplied to retrieve the Tenant Access Information.

context - The context to associate with this operation.

Returns:

tenant Settings.

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.

regeneratePrimaryKey

void regeneratePrimaryKey(String resourceGroupName,
                          String serviceName,
                          AccessIdName accessName)

Regenerate primary access key.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

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.

regeneratePrimaryKeyWithResponse

com.azure.core.http.rest.Response<Void> regeneratePrimaryKeyWithResponse(String resourceGroupName,
                                                                         String serviceName,
                                                                         AccessIdName accessName,
                                                                         com.azure.core.util.Context context)

Regenerate primary access key.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

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.

regenerateSecondaryKey

void regenerateSecondaryKey(String resourceGroupName,
                            String serviceName,
                            AccessIdName accessName)

Regenerate secondary access key.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

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.

regenerateSecondaryKeyWithResponse

com.azure.core.http.rest.Response<Void> regenerateSecondaryKeyWithResponse(String resourceGroupName,
                                                                           String serviceName,
                                                                           AccessIdName accessName,
                                                                           com.azure.core.util.Context context)

Regenerate secondary access key.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

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.

listSecrets

AccessInformationSecretsContractInner listSecrets(String resourceGroupName,
                                                  String serviceName,
                                                  AccessIdName accessName)

Get tenant access information details.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

Returns:

tenant access information 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.

listSecretsWithResponse

TenantAccessListSecretsResponse listSecretsWithResponse(String resourceGroupName,
                                                        String serviceName,
                                                        AccessIdName accessName,
                                                        com.azure.core.util.Context context)

Get tenant access information details.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

accessName - The identifier of the Access configuration.

context - The context to associate with this operation.

Returns:

tenant access information 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.