Interface Secrets
public interface Secrets
Resource collection API of Secrets.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Secret resource.void
Delete secret.void
deleteById
(String id) Delete secret.com.azure.core.http.rest.Response<Void>
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) 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.Get secret.com.azure.core.http.rest.Response<Secret>
getByIdWithResponse
(String id, String expand, com.azure.core.util.Context context) Get secret.com.azure.core.http.rest.Response<Secret>
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<Secret>
List secrets in a given user profile.com.azure.core.http.rest.PagedIterable<Secret>
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.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<Secret> 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<Secret> 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<Secret> 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.
-
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.
-
getById
Get secret.- Parameters:
id
- the resource ID.- 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<Secret> getByIdWithResponse(String id, String expand, com.azure.core.util.Context context) Get secret.- Parameters:
id
- the resource ID.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.
-
deleteById
Delete secret.- 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
com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context) Delete secret.- Parameters:
id
- the resource ID.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.
-
define
Begins definition for a new Secret resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Secret definition.
-