Share via

BareMetalMachineKeySet interface

  • Reference
Package:
@azure/arm-networkcloud

BareMetalMachineKeySet represents the bare metal machine key set.

Extends
TrackedResource

Properties

azureGroupId

The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.
detailedStatus

The more detailed status of the key set. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.
expiration

The date and time after which the users in this key set will be removed from the bare metal machines.
extendedLocation

The extended location of the cluster associated with the resource.
jumpHostsAllowed

The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.
lastValidation

The last time this key set was validated. NOTE: This property will not be serialized. It can only be populated by the server.
osGroupName

The name of the group that users will be assigned to on the operating system of the machines.
privilegeLevel

The access level allowed for the users in this key set.
provisioningState

The provisioning state of the bare metal machine key set. NOTE: This property will not be serialized. It can only be populated by the server.
userList

The unique list of permitted users.
userListStatus

The status evaluation of each user. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

azureGroupId

The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access.

azureGroupId: string

Property Value

string

detailedStatus

The more detailed status of the key set. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatusMessage?: string

Property Value

string

expiration

The date and time after which the users in this key set will be removed from the bare metal machines.

expiration: Date

Property Value

Date

extendedLocation

The extended location of the cluster associated with the resource.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

jumpHostsAllowed

The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users.

jumpHostsAllowed: string[]

Property Value

string[]

lastValidation

The last time this key set was validated. NOTE: This property will not be serialized. It can only be populated by the server.

lastValidation?: Date

Property Value

Date

osGroupName

The name of the group that users will be assigned to on the operating system of the machines.

osGroupName?: string

Property Value

string

privilegeLevel

The access level allowed for the users in this key set.

privilegeLevel: string

Property Value

string

provisioningState

The provisioning state of the bare metal machine key set. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

userList

The unique list of permitted users.

userList: KeySetUser[]

Property Value

KeySetUser[]

userListStatus

The status evaluation of each user. NOTE: This property will not be serialized. It can only be populated by the server.

userListStatus?: KeySetUserStatus[]

Property Value

KeySetUserStatus[]

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type