Hosts - List

Referencia

Servicio:: AVS

Versión de la API:: 2024-09-01

Enumeración de recursos de host por clúster

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/hosts?api-version=2024-09-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
clusterName	path	True	string pattern: ^[-\w\._]+$	Nombre del clúster
privateCloudName	path	True	string pattern: ^[-\w\._]+$	Nombre de la nube privada
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	HostListResult	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Hosts_List

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1/hosts?api-version=2024-09-01

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1/hosts/esx03-r52.1111111111111111111.westcentralus.prod.azure.com",
      "name": "esx03-r52.1111111111111111111.westcentralus.prod.azure.com",
      "type": "Microsoft.AVS/privateClouds/clusters/hosts",
      "zones": [
        "1"
      ],
      "sku": {
        "name": "av64"
      },
      "properties": {
        "kind": "General",
        "displayName": "esx03-r52.1111111111111111111.westcentralus.prod.azure.com",
        "moRefId": "host-209",
        "fqdn": "esx03-r52.1111111111111111111.westcentralus.prod.azure.com",
        "faultDomain": "1"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1/hosts/esx03-r60.1111111111111111111.westcentralus.prod.azure.com",
      "name": "esx03-r60.1111111111111111111.westcentralus.prod.azure.com",
      "type": "Microsoft.AVS/privateClouds/clusters/hosts",
      "zones": [
        "1"
      ],
      "sku": {
        "name": "av64"
      },
      "properties": {
        "kind": "General",
        "displayName": "esx03-r60.1111111111111111111.westcentralus.prod.azure.com",
        "moRefId": "host-128",
        "maintenance": "Replacement"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1/hosts/esx03-r65.1111111111111111111.westcentralus.prod.azure.com",
      "name": "esx03-r65.1111111111111111111.westcentralus.prod.azure.com",
      "type": "Microsoft.AVS/privateClouds/clusters/hosts",
      "zones": [
        "1"
      ],
      "properties": {
        "kind": "Specialized"
      }
    }
  ]
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Host	Un recurso de host
HostKind	El tipo de anfitrión.
HostListResult	La respuesta de una operación de lista de hosts.
HostMaintenance	El motivo del mantenimiento del host.
HostProvisioningState	Estado de aprovisionamiento del host
Sku	Definición del modelo de recursos que representa la SKU
SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Host

Object

Un recurso de host

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.displayName	string	Nombre para mostrar del host en VMware vCenter.
properties.faultDomain	string
properties.fqdn	string minLength: 1 maxLength: 255	Nombre de dominio completo del host.
properties.kind	HostKind	El tipo de anfitrión
properties.maintenance	HostMaintenance	Si se proporciona, el host está en mantenimiento. El valor es la razón del mantenimiento.
properties.moRefId	string	ID de referencia de objeto administrado de vCenter del host.
properties.provisioningState	HostProvisioningState	El estado del aprovisionamiento de host.
sku	Sku	La SKU (unidad de mantenimiento de existencias) asignada a este recurso.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"
zones	string[]	Zonas de disponibilidad.

HostKind

Enumeración

El tipo de anfitrión.

Valor	Description
General
Specialized

HostListResult

Object

La respuesta de una operación de lista de hosts.

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente de elementos
value	Host[]	Los elementos de host de esta página

HostMaintenance

Enumeración

El motivo del mantenimiento del host.

Valor	Description
Replacement	El host es un host de reemplazo.
Upgrade	El host es para una actualización, como una actualización a ESXi, NSX-T u otro componente.

HostProvisioningState

Enumeración

Estado de aprovisionamiento del host

Valor	Description
Canceled	Se canceló la creación de recursos.
Failed	Error en la creación de recursos.
Succeeded	Se ha creado el recurso.

Sku

Object

Definición del modelo de recursos que representa la SKU

Nombre	Tipo	Description
capacity	integer (int32)	Si la SKU admite el escalado horizontal o horizontal, se debe incluir el entero de capacidad. Si no es posible escalar horizontalmente o reducir horizontalmente el recurso, se puede omitir.
family	string	Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name	string	Nombre de la SKU. Por ejemplo, P3. Normalmente es un código de letra y número
size	string	Tamaño de la SKU. Cuando el campo de nombre es la combinación de nivel y otro valor, este sería el código independiente.
tier	SkuTier	El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

SkuTier

Enumeración

El proveedor de recursos necesita implementar este campo si el servicio tiene más de un nivel, pero no es necesario en put.

Valor	Description
Basic
Free
Premium
Standard

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Hosts - List

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Hosts_List

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Host

HostKind

HostListResult

HostMaintenance

HostProvisioningState

Sku

SkuTier

systemData