Package com.azure.resourcemanager.apimanagement.models

Interface TenantAccess

public interface TenantAccess
Resource collection API of TenantAccess.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<AccessInformationContract> listByService(String resourceGroupName, String serviceName)
      Returns list of access infos - for Git and Management endpoints.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      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<AccessInformationContract> 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. The name is case insensitive.
      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.

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

    • getEntityTag

      void getEntityTag(String resourceGroupName, String serviceName, AccessIdName accessName)
      Tenant access metadata.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      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.

    • getWithResponse

      com.azure.core.http.rest.Response<AccessInformationContract> 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. The name is case insensitive.
      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.

    • get

      AccessInformationContract get(String resourceGroupName, String serviceName, AccessIdName accessName)
      Get tenant access information details without secrets.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      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.

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

    • regeneratePrimaryKey

      void regeneratePrimaryKey(String resourceGroupName, String serviceName, AccessIdName accessName)
      Regenerate primary access key.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      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. The name is case insensitive.
      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. The name is case insensitive.
      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.

    • listSecretsWithResponse

      com.azure.core.http.rest.Response<AccessInformationSecretsContract> 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. The name is case insensitive.
      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.

    • listSecrets

      AccessInformationSecretsContract listSecrets(String resourceGroupName, String serviceName, AccessIdName accessName)
      Get tenant access information details.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      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.

    • getById

      AccessInformationContract getById(String id)
      Get tenant access information details without secrets.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<AccessInformationContract> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get tenant access information details without secrets.
      Parameters:
      id - the resource ID.
      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.

    • define

      AccessInformationContract.DefinitionStages.Blank define(AccessIdName name)
      Begins definition for a new AccessInformationContract resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new AccessInformationContract definition.