Secrets - List
List secrets in a given user profile.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets?api-version=2018-09-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
lab
|
path | True |
string |
The name of the lab. |
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
path | True |
string |
The subscription ID. |
user
|
path | True |
string |
The name of the user profile. |
api-version
|
query | True |
string |
Client API version. |
$expand
|
query |
string |
Specify the $expand query. Example: 'properties($select=value)' |
|
$filter
|
query |
string |
The filter to apply to the operation. Example: '$filter=contains(name,'myName') |
|
$orderby
|
query |
string |
The ordering expression for the results, using OData notation. Example: '$orderby=name desc' |
|
$top
|
query |
integer int32 |
The maximum number of resources to return from the operation. Example: '$top=10' |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
BadRequest |
Security
azure_auth
OAuth2 Implicit Grant
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Access Microsoft Azure |
Examples
Secrets_List
Sample Request
Sample Response
{
"value": [
{
"properties": {
"uniqueIdentifier": "00000000-0000-0000-0000-000000000000"
},
"id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{userName}/secrets/secret1",
"name": "secret1",
"type": "Microsoft.DevTestLab/labs/users/secrets"
},
{
"properties": {
"uniqueIdentifier": "00000000-0000-0000-0000-000000000000"
},
"id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/users/{userName}/secrets/secret2",
"name": "secret2",
"type": "Microsoft.DevTestLab/labs/users/secrets"
}
]
}
Definitions
Name | Description |
---|---|
Cloud |
Error from a REST request. |
Cloud |
Body of an error from a REST request. |
Secret |
A secret. |
Secret |
The response of a list operation. |
CloudError
Error from a REST request.
Name | Type | Description |
---|---|---|
error |
The cloud error that occurred |
CloudErrorBody
Body of an error from a REST request.
Name | Type | Description |
---|---|---|
code |
string |
The error code. |
details |
Inner errors. |
|
message |
string |
The error message. |
target |
string |
The error target. |
Secret
A secret.
Name | Type | Description |
---|---|---|
id |
string |
The identifier of the resource. |
location |
string |
The location of the resource. |
name |
string |
The name of the resource. |
properties.provisioningState |
string |
The provisioning status of the resource. |
properties.uniqueIdentifier |
string |
The unique immutable identifier of a resource (Guid). |
properties.value |
string |
The value of the secret for secret creation. |
tags |
object |
The tags of the resource. |
type |
string |
The type of the resource. |
SecretList
The response of a list operation.
Name | Type | Description |
---|---|---|
nextLink |
string |
Link for next set of results. |
value |
Secret[] |
Results of the list operation. |