Interface KeyValuesClient


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

    • listByConfigurationStore

      com.azure.core.http.rest.PagedIterable<KeyValueInner> listByConfigurationStore(String resourceGroupName, String configStoreName)
      Lists the key-values for a given 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 key-values 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.
    • listByConfigurationStore

      com.azure.core.http.rest.PagedIterable<KeyValueInner> listByConfigurationStore(String resourceGroupName, String configStoreName, String skipToken, com.azure.core.util.Context context)
      Lists the key-values for a given 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 key-values 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.
    • get

      KeyValueInner get(String resourceGroupName, String configStoreName, String keyValueName)
      Gets the properties of the specified key-value.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
      Returns:
      the properties of the specified key-value.
      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<KeyValueInner> getWithResponse(String resourceGroupName, String configStoreName, String keyValueName, com.azure.core.util.Context context)
      Gets the properties of the specified key-value.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
      context - The context to associate with this operation.
      Returns:
      the properties of the specified key-value 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.
    • createOrUpdate

      KeyValueInner createOrUpdate(String resourceGroupName, String configStoreName, String keyValueName)
      Creates a key-value.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
      Returns:
      the key-value resource 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.
    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<KeyValueInner> createOrUpdateWithResponse(String resourceGroupName, String configStoreName, String keyValueName, KeyValueInner keyValueParameters, com.azure.core.util.Context context)
      Creates a key-value.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
      keyValueParameters - The parameters for creating a key-value.
      context - The context to associate with this operation.
      Returns:
      the key-value resource along with all resource properties 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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String configStoreName, String keyValueName)
      Deletes a key-value.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
      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, String keyValueName, com.azure.core.util.Context context)
      Deletes a key-value.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
      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, String keyValueName)
      Deletes a key-value.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
      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, String keyValueName, com.azure.core.util.Context context)
      Deletes a key-value.
      Parameters:
      resourceGroupName - The name of the resource group to which the container registry belongs.
      configStoreName - The name of the configuration store.
      keyValueName - Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
      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.