Package com.azure.resourcemanager.appconfiguration.models

Interface ConfigurationStores

public interface ConfigurationStores
Resource collection API of ConfigurationStores.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<ConfigurationStore> 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<ConfigurationStore> 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<ConfigurationStore> 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<ConfigurationStore> 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

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

    • deleteByResourceGroup

      void deleteByResourceGroup(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.

    • listKeys

      com.azure.core.http.rest.PagedIterable<ApiKey> 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<ApiKey> 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

      ApiKey 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<ApiKey> 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<DeletedConfigurationStore> 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<DeletedConfigurationStore> 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

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

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

    • getById

      ConfigurationStore getById(String id)
      Gets the properties of the specified configuration store.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<ConfigurationStore> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the properties of the specified configuration store.
      Parameters:
      id - the resource ID.
      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.

    • deleteById

      void deleteById(String id)
      Deletes a configuration store.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes a configuration store.
      Parameters:
      id - the resource ID.
      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.

    • define

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