Interface ConfigurationStoresClient


public interface ConfigurationStoresClient
An instance of this class provides access to all the operations defined in ConfigurationStoresClient.
  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<ConfigurationStoreInner> list()
      Lists the configuration stores for a given subscription.
      Returns:
      the result of a request to list configuration stores as paginated response with PagedIterable.
      Throws:
      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.
    • list

      com.azure.core.http.rest.PagedIterable<ConfigurationStoreInner> list(String skipToken, com.azure.core.util.Context context)
      Lists the configuration stores for a given subscription.
      Parameters:
      skipToken - A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
      context - The context to associate with this operation.
      Returns:
      the result of a request to list configuration stores 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.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<ConfigurationStoreInner> listByResourceGroup(String resourceGroupName)
      Lists the configuration stores for a given resource group.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      Returns:
      the result of a request to list configuration stores 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.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<ConfigurationStoreInner> listByResourceGroup(String resourceGroupName, String skipToken, com.azure.core.util.Context context)
      Lists the configuration stores for a given resource group.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      skipToken - A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
      context - The context to associate with this operation.
      Returns:
      the result of a request to list configuration stores 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.
    • getByResourceGroup

      ConfigurationStoreInner getByResourceGroup(String resourceGroupName, String configStoreName)
      Gets the properties of the specified configuration store.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      Returns:
      the properties of the specified configuration store.
      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.
    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<ConfigurationStoreInner> getByResourceGroupWithResponse(String resourceGroupName, String configStoreName, com.azure.core.util.Context context)
      Gets the properties of the specified configuration store.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      context - The context to associate with this operation.
      Returns:
      the properties of the specified configuration store along with 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.
    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ConfigurationStoreInner>,ConfigurationStoreInner> beginCreate(String resourceGroupName, String configStoreName, ConfigurationStoreInner configStoreCreationParameters)
      Creates a configuration store with the specified parameters.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      configStoreCreationParameters - The parameters for creating a configuration store.
      Returns:
      the SyncPoller for polling of the configuration store along with all resource properties.
      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.
    • beginCreate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ConfigurationStoreInner>,ConfigurationStoreInner> beginCreate(String resourceGroupName, String configStoreName, ConfigurationStoreInner configStoreCreationParameters, com.azure.core.util.Context context)
      Creates a configuration store with the specified parameters.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      configStoreCreationParameters - The parameters for creating a configuration store.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of the configuration store along with all resource properties.
      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

      ConfigurationStoreInner create(String resourceGroupName, String configStoreName, ConfigurationStoreInner configStoreCreationParameters)
      Creates a configuration store with the specified parameters.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      configStoreCreationParameters - The parameters for creating a configuration store.
      Returns:
      the configuration store along with all resource properties.
      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

      ConfigurationStoreInner create(String resourceGroupName, String configStoreName, ConfigurationStoreInner configStoreCreationParameters, com.azure.core.util.Context context)
      Creates a configuration store with the specified parameters.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      configStoreCreationParameters - The parameters for creating a configuration store.
      context - The context to associate with this operation.
      Returns:
      the configuration store along with all resource properties.
      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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String configStoreName)
      Deletes a configuration store.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String configStoreName, com.azure.core.util.Context context)
      Deletes a configuration store.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      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 configStoreName)
      Deletes a configuration store.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      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 configStoreName, com.azure.core.util.Context context)
      Deletes a configuration store.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      context - The context to associate with this operation.
      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.
    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ConfigurationStoreInner>,ConfigurationStoreInner> beginUpdate(String resourceGroupName, String configStoreName, ConfigurationStoreUpdateParameters configStoreUpdateParameters)
      Updates a configuration store with the specified parameters.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      configStoreUpdateParameters - The parameters for updating a configuration store.
      Returns:
      the SyncPoller for polling of the configuration store along with all resource properties.
      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.
    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ConfigurationStoreInner>,ConfigurationStoreInner> beginUpdate(String resourceGroupName, String configStoreName, ConfigurationStoreUpdateParameters configStoreUpdateParameters, com.azure.core.util.Context context)
      Updates a configuration store with the specified parameters.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      configStoreUpdateParameters - The parameters for updating a configuration store.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of the configuration store along with all resource properties.
      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

      ConfigurationStoreInner update(String resourceGroupName, String configStoreName, ConfigurationStoreUpdateParameters configStoreUpdateParameters)
      Updates a configuration store with the specified parameters.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      configStoreUpdateParameters - The parameters for updating a configuration store.
      Returns:
      the configuration store along with all resource properties.
      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

      ConfigurationStoreInner update(String resourceGroupName, String configStoreName, ConfigurationStoreUpdateParameters configStoreUpdateParameters, com.azure.core.util.Context context)
      Updates a configuration store with the specified parameters.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      configStoreUpdateParameters - The parameters for updating a configuration store.
      context - The context to associate with this operation.
      Returns:
      the configuration store along with all resource properties.
      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.
    • listKeys

      com.azure.core.http.rest.PagedIterable<ApiKeyInner> listKeys(String resourceGroupName, String configStoreName)
      Lists the access key for the specified configuration store.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      Returns:
      the result of a request to list API keys 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.
    • listKeys

      com.azure.core.http.rest.PagedIterable<ApiKeyInner> listKeys(String resourceGroupName, String configStoreName, String skipToken, com.azure.core.util.Context context)
      Lists the access key for the specified configuration store.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      skipToken - A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
      context - The context to associate with this operation.
      Returns:
      the result of a request to list API keys 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.
    • regenerateKey

      ApiKeyInner regenerateKey(String resourceGroupName, String configStoreName, RegenerateKeyParameters regenerateKeyParameters)
      Regenerates an access key for the specified configuration store.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      regenerateKeyParameters - The parameters for regenerating an access key.
      Returns:
      an API key used for authenticating with a configuration store endpoint.
      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.
    • regenerateKeyWithResponse

      com.azure.core.http.rest.Response<ApiKeyInner> regenerateKeyWithResponse(String resourceGroupName, String configStoreName, RegenerateKeyParameters regenerateKeyParameters, com.azure.core.util.Context context)
      Regenerates an access key for the specified configuration store.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      regenerateKeyParameters - The parameters for regenerating an access key.
      context - The context to associate with this operation.
      Returns:
      an API key used for authenticating with a configuration store endpoint along with 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.
    • listDeleted

      com.azure.core.http.rest.PagedIterable<DeletedConfigurationStoreInner> listDeleted()
      Gets information about the deleted configuration stores in a subscription.
      Returns:
      information about the deleted configuration stores in a subscription as paginated response with PagedIterable.
      Throws:
      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.
    • listDeleted

      com.azure.core.http.rest.PagedIterable<DeletedConfigurationStoreInner> listDeleted(com.azure.core.util.Context context)
      Gets information about the deleted configuration stores in a subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      information about the deleted configuration stores in a subscription 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.
    • getDeleted

      DeletedConfigurationStoreInner getDeleted(String location, String configStoreName)
      Gets a deleted Azure app configuration store.
      Parameters:
      location - The location in which uniqueness will be verified.
      configStoreName - The name of the configuration store.
      Returns:
      a deleted Azure app configuration store.
      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.
    • getDeletedWithResponse

      com.azure.core.http.rest.Response<DeletedConfigurationStoreInner> getDeletedWithResponse(String location, String configStoreName, com.azure.core.util.Context context)
      Gets a deleted Azure app configuration store.
      Parameters:
      location - The location in which uniqueness will be verified.
      configStoreName - The name of the configuration store.
      context - The context to associate with this operation.
      Returns:
      a deleted Azure app configuration store along with 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.
    • beginPurgeDeleted

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginPurgeDeleted(String location, String configStoreName)
      Permanently deletes the specified configuration store.
      Parameters:
      location - The location in which uniqueness will be verified.
      configStoreName - The name of the configuration store.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.
    • beginPurgeDeleted

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginPurgeDeleted(String location, String configStoreName, com.azure.core.util.Context context)
      Permanently deletes the specified configuration store.
      Parameters:
      location - The location in which uniqueness will be verified.
      configStoreName - The name of the configuration store.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.
    • purgeDeleted

      void purgeDeleted(String location, String configStoreName)
      Permanently deletes the specified configuration store.
      Parameters:
      location - The location in which uniqueness will be verified.
      configStoreName - The name of the configuration store.
      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.
    • purgeDeleted

      void purgeDeleted(String location, String configStoreName, com.azure.core.util.Context context)
      Permanently deletes the specified configuration store.
      Parameters:
      location - The location in which uniqueness will be verified.
      configStoreName - The name of the configuration store.
      context - The context to associate with this operation.
      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.