你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

HostEntity interface

表示主机实体。

扩展

属性

additionalData

应属于实体的自定义字段的包,并将呈现给用户。 注意:此属性不会序列化。 它只能由服务器填充。

azureID

VM 的 Azure 资源 ID。 注意:此属性不会序列化。 它只能由服务器填充。

dnsDomain

此主机所属的 DNS 域。 应包含域注释的竞争 DNS 后缀:此属性不会序列化。 它只能由服务器填充。

friendlyName

图形项显示名称,它是图形项实例的简短可读说明。 此属性是可选的,可能是系统生成的。 注意:此属性不会序列化。 它只能由服务器填充。

hostName

不带域后缀的主机名。 注意:此属性不会序列化。 它只能由服务器填充。

isDomainJoined

确定此主机是否属于域。 注意:此属性不会序列化。 它只能由服务器填充。

kind

多态鉴别器,它指定此对象可以的不同类型的

netBiosName

主机名(windows2000 前)。 注意:此属性不会序列化。 它只能由服务器填充。

ntDomain

此主机所属的 NT 域。 注意:此属性不会序列化。 它只能由服务器填充。

omsAgentID

如果主机安装了 OMS 代理,则为 OMS 代理 ID。 注意:此属性不会序列化。 它只能由服务器填充。

osFamily

操作系统类型。

osVersion

操作系统的自由文本表示形式。 此字段用于保存特定版本,其粒度比 OSFamily 或 OSFamily 枚举不支持的未来值更精细:此属性不会序列化。 它只能由服务器填充。

继承属性

id

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此属性不会序列化。 它只能由服务器填充。

name

资源说明的名称:此属性不会序列化。 它只能由服务器填充。

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意:此属性不会序列化。 它只能由服务器填充。

type

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意:此属性不会序列化。 它只能由服务器填充。

属性详细信息

additionalData

应属于实体的自定义字段的包,并将呈现给用户。 注意:此属性不会序列化。 它只能由服务器填充。

additionalData?: {[propertyName: string]: Record<string, unknown>}

属性值

{[propertyName: string]: Record<string, unknown>}

azureID

VM 的 Azure 资源 ID。 注意:此属性不会序列化。 它只能由服务器填充。

azureID?: string

属性值

string

dnsDomain

此主机所属的 DNS 域。 应包含域注释的竞争 DNS 后缀:此属性不会序列化。 它只能由服务器填充。

dnsDomain?: string

属性值

string

friendlyName

图形项显示名称,它是图形项实例的简短可读说明。 此属性是可选的,可能是系统生成的。 注意:此属性不会序列化。 它只能由服务器填充。

friendlyName?: string

属性值

string

hostName

不带域后缀的主机名。 注意:此属性不会序列化。 它只能由服务器填充。

hostName?: string

属性值

string

isDomainJoined

确定此主机是否属于域。 注意:此属性不会序列化。 它只能由服务器填充。

isDomainJoined?: boolean

属性值

boolean

kind

多态鉴别器,它指定此对象可以的不同类型的

kind: "Host"

属性值

"Host"

netBiosName

主机名(windows2000 前)。 注意:此属性不会序列化。 它只能由服务器填充。

netBiosName?: string

属性值

string

ntDomain

此主机所属的 NT 域。 注意:此属性不会序列化。 它只能由服务器填充。

ntDomain?: string

属性值

string

omsAgentID

如果主机安装了 OMS 代理,则为 OMS 代理 ID。 注意:此属性不会序列化。 它只能由服务器填充。

omsAgentID?: string

属性值

string

osFamily

操作系统类型。

osFamily?: OSFamily

属性值

osVersion

操作系统的自由文本表示形式。 此字段用于保存特定版本,其粒度比 OSFamily 或 OSFamily 枚举不支持的未来值更精细:此属性不会序列化。 它只能由服务器填充。

osVersion?: string

属性值

string

继承属性详细信息

id

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意:此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自 Entity.id

name

资源说明的名称:此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自 Entity.name

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意:此属性不会序列化。 它只能由服务器填充。

systemData?: SystemData

属性值

继承自Entity.systemData

type

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意:此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自Entity.type