Skip to main content

Returns the specified Azure machine

GET 
/v1/cloudconfigs/azure/:configUid/machinePools/:machinePoolName/machines/:machineUid

Returns a Azure machine for the specified uid.

Request​

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

    machinePoolName stringrequired

    Machine pool name

    machineUid stringrequired

    Machine uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses​

OK

Schema
    kindstring
    metadata object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations object

    Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set

    property name*string
    creationTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    deletionTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    labels object

    Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

    property name*string
    lastModifiedTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    namestring

    Name of the resource

    uidstring

    UID is the unique identifier generated for the resource. This is not an input field for any request.

    Populated by the system. Read-only.

    spec object

    Azure cloud VM definition spec

    additionalTags object
    property name*string
    allocatePublicIPboolean
    availabilityZone object

    Azure Machine Spec Availability zone

    enabledboolean
    idstring
    image object

    Azure Machine Spec Image

    gallerystring
    idstring
    namestring
    offerstring
    publisherstring
    resourceGroupstring
    skustring
    subscriptionIdstring
    versionstring
    instanceTypestringrequired
    locationstringrequired
    nics object[]
  • Array [
    • indexint8
    privateIPsstring[]
    publicIpstring
  • ]
    • osDisk objectrequired
    diskSizeGBint32
    managedDisk object
    storageAccountTypestring
    osTypestring

    Possible values: [Linux, Windows]

    Default value: Linux

    sshPublicKeystring
    status object

    cloud machine status

    health object

    Machine health state

    conditions object[]
  • Array [
    • messagestring
    reasonstring
    statusstring
    typestring
  • ]
    • lastHeartBeatTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    statestring
    instanceStatestring

    Possible values: [Pending, Provisioning, Provisioned, Running, Deleting, Deleted, Failed, Unknown]

    maintenanceStatus object

    Machine maintenance status

    actionstring
    messagestring
    statestring
Loading...