V Centers - Get

Gets a vCenter.
Implements vCenter GET method.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/vcenters/{vcenterName}?api-version=2023-12-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The Resource Group Name.

subscriptionId
path True

string

The Subscription ID.

vcenterName
path True

string

Name of the vCenter.

api-version
query True

string

Client Api Version.

Responses

Name Type Description
200 OK

VCenter

Success

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

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

GetVCenter

Sample request

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/vcenters/ContosoVCenter?api-version=2023-12-01

Sample response

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/ContosoVCenter",
  "name": "ContosoVCenter",
  "type": "Microsoft.ConnectedVMwarevSphere/VCenters",
  "location": "East US",
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso"
  },
  "properties": {
    "fqdn": "ContosoVMware.contoso.com",
    "port": 1234,
    "credentials": {
      "username": "tempuser"
    },
    "version": "1.0",
    "instanceUuid": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "provisioningState": "Succeeded"
  }
}

Definitions

Name Description
createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

ExtendedLocation

The extended location.

ProvisioningState

Gets the provisioning state.

ResourceStatus

The resource status information.

systemData

Metadata pertaining to creation and last modification of the resource.

VCenter

Defines the vCenter.

VICredential

Username / Password Credentials to connect to vcenter.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

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.

ExtendedLocation

The extended location.

Name Type Description
name

string

The extended location name.

type

string

The extended location type.

ProvisioningState

Gets the provisioning state.

Name Type Description
Accepted

string

Canceled

string

Created

string

Deleting

string

Failed

string

Provisioning

string

Succeeded

string

Updating

string

ResourceStatus

The resource status information.

Name Type Description
lastUpdatedAt

string

The last update time for this condition.

message

string

A human readable message indicating details about the status.

reason

string

The reason for the condition's status.

severity

string

Severity with which to treat failures of this type of condition.

status

string

Status of the condition.

type

string

The type of the condition.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

VCenter

Defines the vCenter.

Name Type Description
extendedLocation

ExtendedLocation

Gets or sets the extended location.

id

string

Gets or sets the Id.

kind

string

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

location

string

Gets or sets the location.

name

string

Gets or sets the name.

properties.connectionStatus

string

Gets or sets the connection status to the vCenter.

properties.credentials

VICredential

Username / Password Credentials to connect to vcenter.

properties.customResourceName

string

Gets the name of the corresponding resource in Kubernetes.

properties.fqdn

string

Gets or sets the FQDN/IPAddress of the vCenter.

properties.instanceUuid

string

Gets or sets the instance UUID of the vCenter.

properties.port

integer

Gets or sets the port of the vCenter.

properties.provisioningState

ProvisioningState

Gets the provisioning state.

properties.statuses

ResourceStatus[]

The resource status information.

properties.uuid

string

Gets or sets a unique identifier for this resource.

properties.version

string

Gets or sets the version of the vCenter.

systemData

systemData

The system data.

tags

object

Gets or sets the Resource tags.

type

string

Gets or sets the type of the resource.

VICredential

Username / Password Credentials to connect to vcenter.

Name Type Description
password

string

Gets or sets the password to connect with the vCenter.

username

string

Gets or sets username to connect with the vCenter.