Private Clouds - List Admin Credentials

Service:

AVS

API Version:

2023-09-01

List the admin credentials for the private cloud

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/listAdminCredentials?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
privateCloudName	path	True	string	Name of the private cloud Regex pattern: ^[-\w\._]+$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	AdminCredentials	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

PrivateClouds_ListAdminCredentials

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/listAdminCredentials?api-version=2023-09-01

Sample Response

Status code:

200

{
  "nsxtPassword": "$(1X4Dkk",
  "nsxtUsername": "admin",
  "vcenterPassword": "<vcenterPassword>",
  "vcenterUsername": "cloudadmin@vsphere.local"
}

Definitions

Name	Description
AdminCredentials	Administrative credentials for accessing vCenter and NSX-T
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

AdminCredentials

Administrative credentials for accessing vCenter and NSX-T

Name	Type	Description
nsxtPassword	string	NSX-T Manager password
nsxtUsername	string	NSX-T Manager username
vcenterPassword	string	vCenter admin password
vcenterUsername	string	vCenter admin username

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.