Interface KeyValues
public interface KeyValues
Resource collection API of KeyValues.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new KeyValue resource.void
Deletes a key-value.void
delete
(String resourceGroupName, String configStoreName, String keyValueName, com.azure.core.util.Context context) Deletes a key-value.void
deleteById
(String id) Deletes a key-value.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes a key-value.Gets the properties of the specified key-value.Gets the properties of the specified key-value.com.azure.core.http.rest.Response<KeyValue>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets the properties of the specified key-value.com.azure.core.http.rest.Response<KeyValue>
getWithResponse
(String resourceGroupName, String configStoreName, String keyValueName, com.azure.core.util.Context context) Gets the properties of the specified key-value.com.azure.core.http.rest.PagedIterable<KeyValue>
listByConfigurationStore
(String resourceGroupName, String configStoreName) Lists the key-values for a given configuration store.com.azure.core.http.rest.PagedIterable<KeyValue>
listByConfigurationStore
(String resourceGroupName, String configStoreName, String skipToken, com.azure.core.util.Context context) Lists the key-values for a given configuration store.
-
Method Details
-
listByConfigurationStore
com.azure.core.http.rest.PagedIterable<KeyValue> 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<KeyValue> 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
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<KeyValue> 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.
-
delete
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.
-
getById
Gets the properties of the specified key-value.- Parameters:
id
- the resource ID.- 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<KeyValue> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets the properties of the specified key-value.- Parameters:
id
- the resource ID.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.
-
deleteById
Deletes a key-value.- 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
Deletes a key-value.- 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
Begins definition for a new KeyValue resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new KeyValue definition.
-