NSX-T Data Center REST API

Update a Azure account information

This api updates a Azure account which is added to cloud service manager.
Have to pass one of the authorization methods in auth_method property as part of
request body followed by appropriate data.

Request:

Method:

PUT

URI Path(s):

/api/v1/csm/azure/accounts/<account-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

AzureAccount+

AzureAccount (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
auth_method	Azure account authorization method This property conveys the authorization method to use. Appropriate credentials/parameters will be expected based on this method selection.	string	Readonly Enum: CREDENTIALS
auth_users	Authrized Users List of authorized users.	array of CloudUserInfo	Readonly
cloud_type	Cloud Type	string	Required Enum: AWS, AZURE, GOOGLE, AZURE_GOV_US, AWS_GOV_US_EAST, AWS_GOV_US_WEST
credentials	Azure Credentials Credentials of Azure Account.	AzureCredentials	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
instance_stats	Instance statistics Stores statistics of the number of managed, unmanaged and error virtual machines.	InstanceStats	Readonly
last_inventory_sync_date	Last inventory sync date Time when last inventory syncing completed.	integer	Readonly
regions_config	List of regions configuration for the cloud account Configured list of regions to be used for the cloud account.	RegionListConfig
regions_count	Azure Regions Count Count of the Azure regions which have atleast one virtual network created.	integer	Readonly
resource_type	Must be set to the value AzureAccount	string
status	Azure Account Status Status of the Azure Account.	AzureAccountStatus	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tenant_id	Tenant ID Tenant ID of the cloud account.	string	Readonly
vnet_stats	Virtual Network Statistics Stores statistics of the number of MANAGED and UNMANAGED virtual networks.	VnetStats	Readonly

Example Request:

PUT https://<nsx-csm>/api/v1/csm/azure/accounts/9174ffd1-41b1-42d6-a28d { "cloud_type":"AZURE", "display_name": "Account XYZ" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AzureAccount+

AzureAccount (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
auth_method	Azure account authorization method This property conveys the authorization method to use. Appropriate credentials/parameters will be expected based on this method selection.	string	Readonly Enum: CREDENTIALS
auth_users	Authrized Users List of authorized users.	array of CloudUserInfo	Readonly
cloud_type	Cloud Type	string	Required Enum: AWS, AZURE, GOOGLE, AZURE_GOV_US, AWS_GOV_US_EAST, AWS_GOV_US_WEST
credentials	Azure Credentials Credentials of Azure Account.	AzureCredentials	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
instance_stats	Instance statistics Stores statistics of the number of managed, unmanaged and error virtual machines.	InstanceStats	Readonly
last_inventory_sync_date	Last inventory sync date Time when last inventory syncing completed.	integer	Readonly
regions_config	List of regions configuration for the cloud account Configured list of regions to be used for the cloud account.	RegionListConfig
regions_count	Azure Regions Count Count of the Azure regions which have atleast one virtual network created.	integer	Readonly
resource_type	Must be set to the value AzureAccount	string
status	Azure Account Status Status of the Azure Account.	AzureAccountStatus	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tenant_id	Tenant ID Tenant ID of the cloud account.	string	Readonly
vnet_stats	Virtual Network Statistics Stores statistics of the number of MANAGED and UNMANAGED virtual networks.	VnetStats	Readonly

Example Response:

{ "id": "9174ffd1-41b1-42d6-a28d", "display_name": "Account XYZ", "tenant_id": "123", "cloud_type": "AZURE", "cloud_tags_enabled": true, "instance_stats": { "total": 92, "managed": 0, "unmanaged": 82, "error": 0, "powered_off": 10 }, "auth_method": "CREDENTIALS", "credentials": { "tenant_id": "123", "subscription_id": "456", "client_id": "789", "gateway_role": "NSX role" }, "vnet_stats": { "managed": 1, "unmanaged": 42 }, "regions_count": 2, "status": { "inventory_sync_status": "IN_PROGRESS", "credentials_status": "VALID", "inventory_sync_step": "SYNCING_VMS" }, "_protection": "NOT_PROTECTED" }

Required Permissions:

crud

Feature:

cloud_accounts

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable