Bastion Hosts - Update Tags

Ссылка

Service:: Virtual Networks

API Version:: 2021-08-01

Обновления тегов для ресурса BastionHost

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}?api-version=2021-08-01

Параметры URI

Name	In	Required	Type	Description
bastionHostName	path	True	string	Имя узла Бастиона.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписку. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Текст запроса

Name	Type	Description
tags	object	Теги ресурсов.

Ответы

Name	Type	Description
200 OK	BastionHost	Обновление выполнено успешно. Операция возвращает полученный ресурс BastionHost.
202 Accepted		Принято и операция будет завершена асинхронно.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

Patch Bastion Host

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant?api-version=2021-08-01

{
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.network.models.TagsObject;
import java.util.HashMap;
import java.util.Map;

/** Samples for BastionHosts UpdateTags. */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/BastionHostPatch.json
     */
    /**
     * Sample code: Patch Bastion Host.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void patchBastionHost(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .networks()
            .manager()
            .serviceClient()
            .getBastionHosts()
            .updateTags(
                "rg1",
                "bastionhosttenant",
                new TagsObject().withTags(mapOf("tag1", "value1", "tag2", "value2")),
                Context.NONE);
    }

    @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;
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armnetwork_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/network/armnetwork"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/BastionHostPatch.json
func ExampleBastionHostsClient_BeginUpdateTags() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armnetwork.NewBastionHostsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginUpdateTags(ctx,
		"rg1",
		"bastionhosttenant",
		armnetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		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)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

/**
 * This sample demonstrates how to Updates Tags for BastionHost resource
 *
 * @summary Updates Tags for BastionHost resource
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2021-08-01/examples/BastionHostPatch.json
 */
async function patchBastionHost() {
  const subscriptionId = "subid";
  const resourceGroupName = "rg1";
  const bastionHostName = "bastionhosttenant";
  const parameters = { tags: { tag1: "value1", tag2: "value2" } };
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.bastionHosts.beginUpdateTagsAndWait(
    resourceGroupName,
    bastionHostName,
    parameters
  );
  console.log(result);
}

patchBastionHost().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 202

Status code:: 200

{
  "name": "bastionhosttenant",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'",
  "type": "Microsoft.Network/bastionHosts",
  "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
  "location": "West US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com",
    "ipConfigurations": [
      {
        "name": "bastionHostIpConfiguration",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration",
        "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
        "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"
          },
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"
          }
        }
      }
    ]
  },
  "sku": {
    "name": "Standard"
  }
}

Определения

BastionHost	Ресурс узла Бастиона.
BastionHostIPConfiguration	IP-конфигурация узла Бастиона.
BastionHostSkuName	Имя этого узла Бастиона.
CloudError	Ответ об ошибке службы.
CloudErrorBody	Ответ об ошибке службы.
IPAllocationMethod	Метод выделения IP-адресов.
ProvisioningState	Текущее состояние подготовки.
Sku	Номер SKU этого узла Бастиона.
SubResource	Ссылка на другой подресурс.
TagsObject	Объект Tags для операций исправления.

BastionHost

Ресурс узла Бастиона.

Name	Type	Default Value	Description
etag	string		Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса.
id	string		Идентификатор ресурса.
location	string		Расположение ресурса.
name	string		Имя ресурса.
properties.disableCopyPaste	boolean	False	Включение и отключение функции копирования и вставки ресурса узла Бастиона.
properties.dnsName	string		Полное доменное имя конечной точки, на которой доступен узел бастиона.
properties.enableFileCopy	boolean	False	Включение и отключение функции копирования файлов ресурса узла Бастиона.
properties.enableIpConnect	boolean	False	Включение и отключение функции IP-Подключение ресурса узла Бастиона.
properties.enableShareableLink	boolean	False	Включение и отключение ссылки на общий доступ ресурса узла Бастиона.
properties.enableTunneling	boolean	False	Включение и отключение туннелирования ресурса узла Бастиона.
properties.ipConfigurations	BastionHostIPConfiguration[]		IP-конфигурация ресурса узла Бастиона.
properties.provisioningState	ProvisioningState		Состояние подготовки ресурса узла бастиона.
properties.scaleUnits	integer		Единицы масштабирования для ресурса узла Бастиона.
sku	Sku		Номер SKU этого узла Бастиона.
tags	object		Теги ресурсов.
type	string		Тип ресурса.

BastionHostIPConfiguration

IP-конфигурация узла Бастиона.

Name	Type	Description
etag	string	Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса.
id	string	Идентификатор ресурса.
name	string	Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
properties.privateIPAllocationMethod	IPAllocationMethod	Метод выделения частных IP-адресов.
properties.provisioningState	ProvisioningState	Состояние подготовки ресурса IP-конфигурации узла бастиона.
properties.publicIPAddress	SubResource	Ссылка на ресурс PublicIP.
properties.subnet	SubResource	Ссылка на ресурс подсети.
type	string	Тип ip-конфигурации.

BastionHostSkuName

Имя этого узла Бастиона.

Name	Type	Description
Basic	string
Standard	string

CloudError

Ответ об ошибке службы.

Name	Type	Description
error	CloudErrorBody	Текст ошибки облака.

CloudErrorBody

Ответ об ошибке службы.

Name	Type	Description
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

IPAllocationMethod

Метод выделения IP-адресов.

Name	Type	Description
Dynamic	string
Static	string

ProvisioningState

Текущее состояние подготовки.

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

Sku

Номер SKU этого узла Бастиона.

Name	Type	Default Value	Description
name	BastionHostSkuName	Standard	Имя этого узла Бастиона.

SubResource

Ссылка на другой подресурс.

Name	Type	Description
id	string	Идентификатор ресурса.

TagsObject

Объект Tags для операций исправления.

Name	Type	Description
tags	object	Теги ресурсов.