REST Resource: projects.locations.spokes

Resource: Spoke

A Spoke is an abstraction of a network attachment being attached to a Hub. A Spoke can be underlying a VPN tunnel, a VLAN (interconnect) attachment, a Router appliance, etc.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "hub": string,
  "linkedVpnTunnels": [
    string
  ],
  "linkedInterconnectAttachments": [
    string
  ],
  "linkedRouterApplianceInstances": [
    {
      object (RouterApplianceInstance)
    }
  ],
  "uniqueId": string,
  "state": enum (State)
}
Fields
name

string

Immutable. The name of a Spoke resource.

createTime

string (Timestamp format)

The time when the Spoke was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

The time when the Spoke was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

User-defined labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

description

string

Short description of the spoke resource

hub

string

The resource URL of the hub resource that the spoke is attached to

linkedVpnTunnels[]

string

The URIs of linked VPN tunnel resources

linkedInterconnectAttachments[]

string

The URIs of linked interconnect attachment resources

linkedRouterApplianceInstances[]

object (RouterApplianceInstance)

The URIs of linked Router appliance resources

uniqueId

string

Output only. Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets a different uniqueId.

state

enum (State)

Output only. The current lifecycle state of this Hub.

RouterApplianceInstance

RouterAppliance represents a Router appliance which is specified by a VM URI and a NIC address.

JSON representation
{
  "virtualMachine": string,
  "ipAddress": string,
  "networkInterface": string
}
Fields
virtualMachine

string

The URI of the virtual machine resource

ipAddress

string

The IP address of the network interface to use for peering.

networkInterface
(deprecated)

string

Methods

create

Creates a new Spoke in a given project and location.

delete

Deletes a single Spoke.

get

Gets details of a single Spoke.

getIamPolicy

Gets the access control policy for a resource.

list

Lists Spokes in a given project and location.

patch

Updates the parameters of a single Spoke.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.