BareMetalMachineKeySet interface

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.
detailedStatusMessage

The descriptive message about the current detailed status.
etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
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 resource. This property is required when creating 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.
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.
privilegeLevelName

The name of the access level to apply when the privilege level is set to Other.
provisioningState

The provisioning state of the bare metal machine key set.
userList

The unique list of permitted users.
userListStatus

The status evaluation of each user.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status.

detailedStatusMessage?: string

Property Value

string

etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")

etag?: 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 resource. This property is required when creating 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.

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

privilegeLevelName

The name of the access level to apply when the privilege level is set to Other.

privilegeLevelName?: string

Property Value

string

provisioningState

The provisioning state of the bare metal machine key set.

provisioningState?: string

Property Value

string

userList

The unique list of permitted users.

userList: KeySetUser[]

Property Value

KeySetUser[]

userListStatus

The status evaluation of each user.

userListStatus?: KeySetUserStatus[]

Property Value

KeySetUserStatus[]

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

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

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type