Dedicated Hosts - Create Or Update

Service:

Compute

API Version:

2024-03-01

Utwórz lub zaktualizuj dedykowanego hosta .

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}?api-version=2024-03-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
hostGroupName	path	True	string	Nazwa dedykowanej grupy hostów.
hostName	path	True	string	Nazwa dedykowanego hosta .
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
location	True	string	Lokalizacja zasobu
sku	True	Sku	Jednostka SKU dedykowanego hosta dla rodziny sprzętu i maszyn wirtualnych. Należy ustawić tylko nazwę. Wyświetl listę jednostek SKU Microsoft.Compute, aby uzyskać listę możliwych wartości.
properties.autoReplaceOnFailure		boolean	Określa, czy dedykowany host ma zostać automatycznie zastąpiony w przypadku awarii. Wartość jest domyślnie ustawiona na wartość "true", jeśli nie zostanie podana.
properties.licenseType		DedicatedHostLicenseTypes	Określa typ licencji oprogramowania, który zostanie zastosowany do maszyn wirtualnych wdrożonych na dedykowanym hoście. Możliwe wartości to: Brak,Windows_Server_Hybrid,Windows_Server_Perpetual. Wartość domyślna to: Brak.
properties.platformFaultDomain		integer	Domena błędów dedykowanego hosta w dedykowanej grupie hostów.
tags		object	Tagi zasobów

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DedicatedHost	OK
201 Created	DedicatedHost	Utworzone
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Create or update a dedicated host .

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myDedicatedHostGroup/hosts/myDedicatedHost?api-version=2024-03-01

{
  "location": "westus",
  "tags": {
    "department": "HR"
  },
  "properties": {
    "platformFaultDomain": 1
  },
  "sku": {
    "name": "DSv3-Type1"
  }
}

Java

import com.azure.resourcemanager.compute.fluent.models.DedicatedHostInner;
import com.azure.resourcemanager.compute.models.Sku;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for DedicatedHosts CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/
     * dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json
     */
    /**
     * Sample code: Create or update a dedicated host .
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateADedicatedHost(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.virtualMachines().manager().serviceClient().getDedicatedHosts().createOrUpdate("myResourceGroup",
            "myDedicatedHostGroup", "myDedicatedHost",
            new DedicatedHostInner().withLocation("westus").withTags(mapOf("department", "HR"))
                .withSku(new Sku().withName("DSv3-Type1")).withPlatformFaultDomain(1),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.compute import ComputeManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-compute
# USAGE
    python dedicated_host_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ComputeManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.dedicated_hosts.begin_create_or_update(
        resource_group_name="myResourceGroup",
        host_group_name="myDedicatedHostGroup",
        host_name="myDedicatedHost",
        parameters={
            "location": "westus",
            "properties": {"platformFaultDomain": 1},
            "sku": {"name": "DSv3-Type1"},
            "tags": {"department": "HR"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcompute_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json
func ExampleDedicatedHostsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDedicatedHostsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myDedicatedHostGroup", "myDedicatedHost", armcompute.DedicatedHost{
		Location: to.Ptr("westus"),
		Tags: map[string]*string{
			"department": to.Ptr("HR"),
		},
		Properties: &armcompute.DedicatedHostProperties{
			PlatformFaultDomain: to.Ptr[int32](1),
		},
		SKU: &armcompute.SKU{
			Name: to.Ptr("DSv3-Type1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DedicatedHost = armcompute.DedicatedHost{
	// 	Name: to.Ptr("myDedicatedHost"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"department": to.Ptr("HR"),
	// 	},
	// 	Properties: &armcompute.DedicatedHostProperties{
	// 		AutoReplaceOnFailure: to.Ptr(false),
	// 		HostID: to.Ptr("{GUID}"),
	// 		LicenseType: to.Ptr(armcompute.DedicatedHostLicenseTypesWindowsServerHybrid),
	// 		PlatformFaultDomain: to.Ptr[int32](1),
	// 	},
	// 	SKU: &armcompute.SKU{
	// 		Name: to.Ptr("DSv3-Type1"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update a dedicated host .
 *
 * @summary Create or update a dedicated host .
 * x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-01/examples/dedicatedHostExamples/DedicatedHost_CreateOrUpdate.json
 */
async function createOrUpdateADedicatedHost() {
  const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "myResourceGroup";
  const hostGroupName = "myDedicatedHostGroup";
  const hostName = "myDedicatedHost";
  const parameters = {
    location: "westus",
    platformFaultDomain: 1,
    sku: { name: "DSv3-Type1" },
    tags: { department: "HR" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ComputeManagementClient(credential, subscriptionId);
  const result = await client.dedicatedHosts.beginCreateOrUpdateAndWait(
    resourceGroupName,
    hostGroupName,
    hostName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "name": "myDedicatedHost",
  "location": "westus",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost",
  "tags": {
    "department": "HR"
  },
  "sku": {
    "name": "DSv3-Type1"
  },
  "properties": {
    "platformFaultDomain": 1,
    "autoReplaceOnFailure": true,
    "hostId": "{GUID}"
  }
}

Status code:

200

{
  "properties": {
    "platformFaultDomain": 1,
    "autoReplaceOnFailure": false,
    "licenseType": "Windows_Server_Hybrid",
    "hostId": "{GUID}"
  },
  "location": "westus",
  "tags": {
    "department": "HR"
  },
  "name": "myDedicatedHost",
  "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost",
  "sku": {
    "name": "DSv3-Type1"
  }
}

Definicje

Nazwa	Opis
ApiError	Błąd interfejsu API.
ApiErrorBase	Baza błędów interfejsu API.
CloudError	Odpowiedź na błąd z usługi Compute.
DedicatedHost	Określa informacje o dedykowanym hoście.
DedicatedHostAllocatableVM	Reprezentuje dedykowaną pojemność hosta nie w pełni wykorzystywaną pod względem określonego rozmiaru maszyny wirtualnej.
DedicatedHostAvailableCapacity	Dedykowana pojemność hosta nie w pełni wykorzystywana.
DedicatedHostInstanceView	Widok wystąpienia dedykowanego hosta.
DedicatedHostLicenseTypes	Określa typ licencji oprogramowania, który zostanie zastosowany do maszyn wirtualnych wdrożonych na dedykowanym hoście. Możliwe wartości to: Brak,Windows_Server_Hybrid,Windows_Server_Perpetual. Wartość domyślna to: Brak.
InnerError	Szczegóły błędu wewnętrznego.
InstanceViewStatus	Stan widoku wystąpienia.
Sku	Opisuje jednostkę SKU zestawu skalowania maszyn wirtualnych. UWAGA: Jeśli nowa jednostka SKU maszyny wirtualnej nie jest obsługiwana na sprzęcie, zestaw skalowania jest obecnie włączony, przed zmodyfikowaniem nazwy jednostki SKU należy cofnąć przydział maszyn wirtualnych w zestawie skalowania.
StatusLevelTypes	Kod poziomu.
SubResourceReadOnly

ApiError

Błąd interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ApiErrorBase[]	Szczegóły błędu interfejsu API
innererror	InnerError	Wewnętrzny błąd interfejsu API
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

ApiErrorBase

Baza błędów interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

CloudError

Odpowiedź na błąd z usługi Compute.

Nazwa	Typ	Opis
error	ApiError	Błąd interfejsu API.

DedicatedHost

Określa informacje o dedykowanym hoście.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
location	string	Lokalizacja zasobu
name	string	Nazwa zasobu
properties.autoReplaceOnFailure	boolean	Określa, czy dedykowany host ma zostać automatycznie zastąpiony w przypadku awarii. Wartość jest domyślnie ustawiona na wartość "true", jeśli nie zostanie podana.
properties.hostId	string	Unikatowy identyfikator wygenerowany i przypisany do dedykowanego hosta przez platformę. Nie zmienia się przez cały okres istnienia hosta.
properties.instanceView	DedicatedHostInstanceView	Widok dedykowanego wystąpienia hosta.
properties.licenseType	DedicatedHostLicenseTypes	Określa typ licencji oprogramowania, który zostanie zastosowany do maszyn wirtualnych wdrożonych na dedykowanym hoście. Możliwe wartości to: Brak,Windows_Server_Hybrid,Windows_Server_Perpetual. Wartość domyślna to: Brak.
properties.platformFaultDomain	integer	Domena błędów dedykowanego hosta w dedykowanej grupie hostów.
properties.provisioningState	string	Stan aprowizacji, który pojawia się tylko w odpowiedzi.
properties.provisioningTime	string	Data pierwszej aprowizacji hosta.
properties.timeCreated	string	Określa czas utworzenia zasobu dedykowanego hosta. Minimalna wersja interfejsu API: 2021-11-01.
properties.virtualMachines	SubResourceReadOnly[]	Lista odwołań do wszystkich maszyn wirtualnych w dedykowanym hoście.
sku	Sku	Jednostka SKU dedykowanego hosta dla rodziny sprzętu i maszyn wirtualnych. Należy ustawić tylko nazwę. Wyświetl listę jednostek SKU Microsoft.Compute, aby uzyskać listę możliwych wartości.
tags	object	Tagi zasobów
type	string	Typ zasobu

DedicatedHostAllocatableVM

Reprezentuje dedykowaną pojemność hosta nie w pełni wykorzystywaną pod względem określonego rozmiaru maszyny wirtualnej.

Nazwa	Typ	Opis
count	number	Maksymalna liczba maszyn wirtualnych o rozmiarze vmSize, które mogą mieścić się w pozostałej pojemności dedykowanego hosta.
vmSize	string	Rozmiar maszyny wirtualnej, pod względem którego jest reprezentowana nie w pełni wykorzystywana pojemność.

DedicatedHostAvailableCapacity

Dedykowana pojemność hosta nie w pełni wykorzystywana.

Nazwa	Typ	Opis
allocatableVMs	DedicatedHostAllocatableVM[]	Nie w pełni wykorzystywana pojemność dedykowanego hosta reprezentowana przez każdy rozmiar maszyny wirtualnej, który może zostać wdrożony na dedykowanym hoście.

DedicatedHostInstanceView

Widok wystąpienia dedykowanego hosta.

Nazwa	Typ	Opis
assetId	string	Określa unikatowy identyfikator dedykowanej maszyny fizycznej, na której znajduje się dedykowany host.
availableCapacity	DedicatedHostAvailableCapacity	Nie w pełni wykorzystywana pojemność dedykowanego hosta.
statuses	InstanceViewStatus[]	Informacje o stanie zasobu.

DedicatedHostLicenseTypes

Określa typ licencji oprogramowania, który zostanie zastosowany do maszyn wirtualnych wdrożonych na dedykowanym hoście. Możliwe wartości to: Brak,Windows_Server_Hybrid,Windows_Server_Perpetual. Wartość domyślna to: Brak.

Nazwa	Typ	Opis
None	string
Windows_Server_Hybrid	string
Windows_Server_Perpetual	string

InnerError

Szczegóły błędu wewnętrznego.

Nazwa	Typ	Opis
errordetail	string	Wewnętrzny komunikat o błędzie lub zrzut wyjątku.
exceptiontype	string	Typ wyjątku.

InstanceViewStatus

Stan widoku wystąpienia.

Nazwa	Typ	Opis
code	string	Kod stanu.
displayStatus	string	Krótka etykieta lokalizowalna dla stanu.
level	StatusLevelTypes	Kod poziomu.
message	string	Szczegółowy komunikat o stanie, w tym alerty i komunikaty o błędach.
time	string	Czas stanu.

Sku

Opisuje jednostkę SKU zestawu skalowania maszyn wirtualnych. UWAGA: Jeśli nowa jednostka SKU maszyny wirtualnej nie jest obsługiwana na sprzęcie, zestaw skalowania jest obecnie włączony, przed zmodyfikowaniem nazwy jednostki SKU należy cofnąć przydział maszyn wirtualnych w zestawie skalowania.

Nazwa	Typ	Opis
capacity	integer	Określa liczbę maszyn wirtualnych w zestawie skalowania.
name	string	Nazwa jednostki SKU.
tier	string	Określa warstwę maszyn wirtualnych w zestawie skalowania. Możliwe wartości: Standardowa Podstawowa

StatusLevelTypes

Kod poziomu.

Nazwa	Typ	Opis
Error	string
Info	string
Warning	string

SubResourceReadOnly

Nazwa	Typ	Opis
id	string	Identyfikator zasobu