Bastion Hosts - List

Ссылка

Service:: Virtual Networks

API Version:: 2023-09-01

Списки все узлы-бастионы в подписке.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/bastionHosts?api-version=2023-09-01

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	BastionHostListResult	Успешно. Операция возвращает список ресурсов узла-бастиона.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List all Bastion Hosts for a given subscription

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/bastionHosts?api-version=2023-09-01


/**
 * Samples for BastionHosts List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/BastionHostListBySubscription
     * .json
     */
    /**
     * Sample code: List all Bastion Hosts for a given subscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllBastionHostsForAGivenSubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getBastionHosts().list(com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python bastion_host_list_by_subscription.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 = NetworkManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.bastion_hosts.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/BastionHostListBySubscription.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

package armnetwork_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/BastionHostListBySubscription.json
func ExampleBastionHostsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBastionHostsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BastionHostListResult = armnetwork.BastionHostListResult{
		// 	Value: []*armnetwork.BastionHost{
		// 		{
		// 			Name: to.Ptr("bastionhost'"),
		// 			Type: to.Ptr("Microsoft.Network/bastionHosts"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'"),
		// 			Location: to.Ptr("West US"),
		// 			Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 			Properties: &armnetwork.BastionHostPropertiesFormat{
		// 				DisableCopyPaste: to.Ptr(false),
		// 				DNSName: to.Ptr("bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com"),
		// 				EnableIPConnect: to.Ptr(false),
		// 				EnableKerberos: to.Ptr(false),
		// 				EnableShareableLink: to.Ptr(false),
		// 				EnableTunneling: to.Ptr(false),
		// 				IPConfigurations: []*armnetwork.BastionHostIPConfiguration{
		// 					{
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration"),
		// 						Name: to.Ptr("bastionHostIpConfiguration"),
		// 						Type: to.Ptr("Microsoft.Network/bastionHosts/bastionHostIpConfigurations"),
		// 						Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 						Properties: &armnetwork.BastionHostIPConfigurationPropertiesFormat{
		// 							PrivateIPAllocationMethod: to.Ptr(armnetwork.IPAllocationMethodDynamic),
		// 							ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 							PublicIPAddress: &armnetwork.SubResource{
		// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"),
		// 							},
		// 							Subnet: &armnetwork.SubResource{
		// 								ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"),
		// 							},
		// 						},
		// 				}},
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				ScaleUnits: to.Ptr[int32](2),
		// 			},
		// 			SKU: &armnetwork.SKU{
		// 				Name: to.Ptr(armnetwork.BastionHostSKUNameStandard),
		// 			},
		// 			Zones: []*string{
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("bastionhostdeveloper'"),
		// 			Type: to.Ptr("Microsoft.Network/bastionHosts"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'"),
		// 			Location: to.Ptr("West US"),
		// 			Etag: to.Ptr("w/\\00000000-0000-0000-0000-000000000000\\"),
		// 			Properties: &armnetwork.BastionHostPropertiesFormat{
		// 				DNSName: to.Ptr("omnibrain.uswest.bastionglobal.azure.com"),
		// 				IPConfigurations: []*armnetwork.BastionHostIPConfiguration{
		// 				},
		// 				NetworkACLs: &armnetwork.BastionHostPropertiesFormatNetworkACLs{
		// 					IPRules: []*armnetwork.IPRule{
		// 						{
		// 							AddressPrefix: to.Ptr("1.1.1.1/16"),
		// 					}},
		// 				},
		// 				ProvisioningState: to.Ptr(armnetwork.ProvisioningStateSucceeded),
		// 				VirtualNetwork: &armnetwork.SubResource{
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2"),
		// 				},
		// 			},
		// 			SKU: &armnetwork.SKU{
		// 				Name: to.Ptr(armnetwork.BastionHostSKUNameDeveloper),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Lists all Bastion Hosts in a subscription.
 *
 * @summary Lists all Bastion Hosts in a subscription.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/BastionHostListBySubscription.json
 */
async function listAllBastionHostsForAGivenSubscription() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.bastionHosts.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;
using Azure.ResourceManager.Network.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/BastionHostListBySubscription.json
// this example is just showing the usage of "BastionHosts_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (BastionHostResource item in subscriptionResource.GetBastionHostsAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BastionHostData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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:: 200

{
  "value": [
    {
      "name": "bastionhost'",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'",
      "type": "Microsoft.Network/bastionHosts",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "sku": {
        "name": "Standard"
      },
      "zones": [],
      "properties": {
        "provisioningState": "Succeeded",
        "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com",
        "scaleUnits": 2,
        "disableCopyPaste": false,
        "enableTunneling": false,
        "enableIpConnect": false,
        "enableShareableLink": false,
        "enableKerberos": false,
        "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"
              }
            }
          }
        ]
      }
    },
    {
      "name": "bastionhostdeveloper'",
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'",
      "type": "Microsoft.Network/bastionHosts",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "sku": {
        "name": "Developer"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "virtualNetwork": {
          "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2"
        },
        "networkAcls": {
          "ipRules": [
            {
              "addressPrefix": "1.1.1.1/16"
            }
          ]
        },
        "dnsName": "omnibrain.uswest.bastionglobal.azure.com",
        "ipConfigurations": []
      }
    }
  ]
}

Определения

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

BastionHost

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

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

BastionHostIPConfiguration

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

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

BastionHostListResult

Ответ на вызов службы API ListBastionHosts.

Имя	Тип	Описание
nextLink	string	URL-адрес для получения следующего набора результатов.
value	BastionHost[]	Список узлов-бастионов в группе ресурсов.

BastionHostSkuName

Имя узла-бастиона.

Имя	Тип	Описание
Basic	string
Developer	string
Standard	string

CloudError

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

Имя	Тип	Описание
error	CloudErrorBody	Текст ошибки облака.

CloudErrorBody

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

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

IPAllocationMethod

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

Имя	Тип	Описание
Dynamic	string
Static	string

IPRule

Имя	Тип	Описание
addressPrefix	string	Указывает IP-адрес или диапазон IP-адресов в формате CIDR. Разрешен только IPV4-адрес.

NetworkAcls

Имя	Тип	Описание
ipRules	IPRule[]	Задает правила списка управления ip-адресами для узла-бастиона разработчика.

ProvisioningState

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

Имя	Тип	Описание
Deleting	string
Failed	string
Succeeded	string
Updating	string

Sku

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

Имя	Тип	Значение по умолчанию	Описание
name	BastionHostSkuName	Standard	Имя узла-бастиона.

SubResource

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

Имя	Тип	Описание
id	string	Идентификатор ресурса.