Interface SecretsClient
public interface SecretsClient
An instance of this class provides access to all the operations defined in SecretsClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SecretInner>,
SecretInner> beginCreateOrUpdate
(String resourceGroupName, String labName, String username, String name, SecretInner secret) Create or replace an existing secret.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SecretInner>,
SecretInner> beginCreateOrUpdate
(String resourceGroupName, String labName, String username, String name, SecretInner secret, com.azure.core.util.Context context) Create or replace an existing secret.createOrUpdate
(String resourceGroupName, String labName, String username, String name, SecretInner secret) Create or replace an existing secret.createOrUpdate
(String resourceGroupName, String labName, String username, String name, SecretInner secret, com.azure.core.util.Context context) Create or replace an existing secret.void
Delete secret.com.azure.core.http.rest.Response<Void>
deleteWithResponse
(String resourceGroupName, String labName, String username, String name, com.azure.core.util.Context context) Delete secret.Get secret.com.azure.core.http.rest.Response<SecretInner>
getWithResponse
(String resourceGroupName, String labName, String username, String name, String expand, com.azure.core.util.Context context) Get secret.com.azure.core.http.rest.PagedIterable<SecretInner>
List secrets in a given user profile.com.azure.core.http.rest.PagedIterable<SecretInner>
list
(String resourceGroupName, String labName, String username, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context) List secrets in a given user profile.update
(String resourceGroupName, String labName, String username, String name, SecretFragment secret) Allows modifying tags of secrets.com.azure.core.http.rest.Response<SecretInner>
updateWithResponse
(String resourceGroupName, String labName, String username, String name, SecretFragment secret, com.azure.core.util.Context context) Allows modifying tags of secrets.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<SecretInner> list(String resourceGroupName, String labName, String username) List secrets in a given user profile.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.- Returns:
- the response of a list operation 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.
-
list
com.azure.core.http.rest.PagedIterable<SecretInner> list(String resourceGroupName, String labName, String username, String expand, String filter, Integer top, String orderby, com.azure.core.util.Context context) List secrets in a given user profile.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.expand
- Specify the $expand query. Example: 'properties($select=value)'.filter
- The filter to apply to the operation. Example: '$filter=contains(name,'myName').top
- The maximum number of resources to return from the operation. Example: '$top=10'.orderby
- The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.context
- The context to associate with this operation.- Returns:
- the response of a list operation 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.
-
getWithResponse
com.azure.core.http.rest.Response<SecretInner> getWithResponse(String resourceGroupName, String labName, String username, String name, String expand, com.azure.core.util.Context context) Get secret.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the secret.expand
- Specify the $expand query. Example: 'properties($select=value)'.context
- The context to associate with this operation.- Returns:
- secret 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.
-
get
Get secret.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the secret.- Returns:
- secret.
- 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SecretInner>,SecretInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, SecretInner secret) Create or replace an existing secret. This operation can take a while to complete.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the secret.secret
- A secret.- Returns:
- the
SyncPoller
for polling of a secret. - 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SecretInner>,SecretInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, SecretInner secret, com.azure.core.util.Context context) Create or replace an existing secret. This operation can take a while to complete.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the secret.secret
- A secret.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of a secret. - 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
SecretInner createOrUpdate(String resourceGroupName, String labName, String username, String name, SecretInner secret) Create or replace an existing secret. This operation can take a while to complete.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the secret.secret
- A secret.- Returns:
- a secret.
- 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
SecretInner createOrUpdate(String resourceGroupName, String labName, String username, String name, SecretInner secret, com.azure.core.util.Context context) Create or replace an existing secret. This operation can take a while to complete.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the secret.secret
- A secret.context
- The context to associate with this operation.- Returns:
- a secret.
- 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.
-
deleteWithResponse
com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String labName, String username, String name, com.azure.core.util.Context context) Delete secret.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the secret.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.
-
delete
Delete secret.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the secret.- 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.
-
updateWithResponse
com.azure.core.http.rest.Response<SecretInner> updateWithResponse(String resourceGroupName, String labName, String username, String name, SecretFragment secret, com.azure.core.util.Context context) Allows modifying tags of secrets. All other properties will be ignored.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the secret.secret
- A secret.context
- The context to associate with this operation.- Returns:
- a secret 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.
-
update
SecretInner update(String resourceGroupName, String labName, String username, String name, SecretFragment secret) Allows modifying tags of secrets. All other properties will be ignored.- Parameters:
resourceGroupName
- The name of the resource group.labName
- The name of the lab.username
- The name of the user profile.name
- The name of the secret.secret
- A secret.- Returns:
- a secret.
- 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.
-