SecretsClient Interface

public interface SecretsClient

An instance of this class provides access to all the operations defined in SecretsClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<SecretInner>,SecretInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, SecretInner secret)

Create or replace an existing secret.

abstract SyncPoller<PollResult<SecretInner>,SecretInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, SecretInner secret, Context context)

Create or replace an existing secret.

abstract SecretInner createOrUpdate(String resourceGroupName, String labName, String username, String name, SecretInner secret)

Create or replace an existing secret.

abstract SecretInner createOrUpdate(String resourceGroupName, String labName, String username, String name, SecretInner secret, Context context)

Create or replace an existing secret.

abstract void delete(String resourceGroupName, String labName, String username, String name)

Delete secret.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String labName, String username, String name, Context context)

Delete secret.

abstract SecretInner get(String resourceGroupName, String labName, String username, String name)

Get secret.

abstract Response<SecretInner> getWithResponse(String resourceGroupName, String labName, String username, String name, String expand, Context context)

Get secret.

abstract PagedIterable<SecretInner> list(String resourceGroupName, String labName, String username)

List secrets in a given user profile.

abstract PagedIterable<SecretInner> list(String resourceGroupName, String labName, String username, String expand, String filter, Integer top, String orderby, Context context)

List secrets in a given user profile.

abstract SecretInner update(String resourceGroupName, String labName, String username, String name, SecretFragment secret)

Allows modifying tags of secrets.

abstract Response<SecretInner> updateWithResponse(String resourceGroupName, String labName, String username, String name, SecretFragment secret, Context context)

Allows modifying tags of secrets.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<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<T,U> for polling of a secret.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<SecretInner>,SecretInner> beginCreateOrUpdate(String resourceGroupName, String labName, String username, String name, SecretInner secret, 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<T,U> for polling of a secret.

createOrUpdate

public abstract 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.

createOrUpdate

public abstract SecretInner createOrUpdate(String resourceGroupName, String labName, String username, String name, SecretInner secret, 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.

delete

public abstract void delete(String resourceGroupName, String labName, String username, String name)

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.

deleteWithResponse

public abstract Response<Void> deleteWithResponse(String resourceGroupName, String labName, String username, String name, 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:

get

public abstract SecretInner get(String resourceGroupName, String labName, String username, String name)

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.

getWithResponse

public abstract Response<SecretInner> getWithResponse(String resourceGroupName, String labName, String username, String name, String expand, 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<T>.

list

public abstract 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<T>.

list

public abstract PagedIterable<SecretInner> list(String resourceGroupName, String labName, String username, String expand, String filter, Integer top, String orderby, 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<T>.

update

public abstract 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.

updateWithResponse

public abstract Response<SecretInner> updateWithResponse(String resourceGroupName, String labName, String username, String name, SecretFragment secret, 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<T>.

Applies to