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

200

OK

application/json

Schema

Schema

apiVersionstring
kindstring

metadata

object

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

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

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

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

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 must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

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

object

required

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

Example (from schema)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T18:20:57.277Z",
    "deletionTimestamp": "2024-07-02T18:20:57.277Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T18:20:57.277Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "additionalTags": {},
    "allocatePublicIP": true,
    "availabilityZone": {
      "enabled": true,
      "id": "string"
    },
    "image": {
      "gallery": "string",
      "id": "string",
      "name": "string",
      "offer": "string",
      "publisher": "string",
      "resourceGroup": "string",
      "sku": "string",
      "subscriptionId": "string",
      "version": "string"
    },
    "instanceType": "string",
    "location": "string",
    "nics": [
      {
        "index": 0,
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "osDisk": {
      "diskSizeGB": 0,
      "managedDisk": {
        "storageAccountType": "string"
      },
      "osType": "Linux"
    },
    "sshPublicKey": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "lastHeartBeatTimestamp": "2024-07-02T18:20:57.277Z",
      "state": "string"
    },
    "instanceState": "Pending",
    "maintenanceStatus": {
      "action": "string",
      "message": "string",
      "state": "string"
    }
  }
}

Loading...