Bastion Hosts - List By Resource Group

Reference

Service:: Virtual Networks

API Version:: 2023-09-01

Seznamy všechny hostitele Bastionu ve skupině prostředků.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze klientského rozhraní API

Odpovědi

Name	Typ	Description
200 OK	BastionHostListResult	Úspěch. Operace vrátí seznam prostředků BastionHost.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List all Bastion Hosts for a given resource group

Sample Request

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


/**
 * Samples for BastionHosts ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/
     * BastionHostListByResourceGroup.json
     */
    /**
     * Sample code: List all Bastion Hosts for a given resource group.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllBastionHostsForAGivenResourceGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.networks().manager().serviceClient().getBastionHosts().listByResourceGroup("rg1",
            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_resource_group.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_by_resource_group(
        resource_group_name="rg1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/BastionHostListByResourceGroup.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/BastionHostListByResourceGroup.json
func ExampleBastionHostsClient_NewListByResourceGroupPager() {
	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().NewListByResourceGroupPager("rg1", 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{
		// 			},
		// 	}},
		// }
	}
}

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 resource group.
 *
 * @summary Lists all Bastion Hosts in a resource group.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/BastionHostListByResourceGroup.json
 */
async function listAllBastionHostsForAGivenResourceGroup() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.bastionHosts.listByResourceGroup(resourceGroupName)) {
    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/BastionHostListByResourceGroup.json
// this example is just showing the usage of "BastionHosts_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this BastionHostResource
BastionHostCollection collection = resourceGroupResource.GetBastionHosts();

// invoke the operation and iterate over the result
await foreach (BastionHostResource item in collection.GetAllAsync())
{
    // 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"
              }
            }
          }
        ]
      }
    }
  ]
}

Definice

Name	Description
BastionHost	Prostředek hostitele Bastionu.
BastionHostIPConfiguration	Konfigurace IP adresy hostitele Bastion.
BastionHostListResult	Odpověď na volání služby rozhraní API ListBastionHosts
BastionHostSkuName	Název tohoto hostitele bastionu.
CloudError	Chybová odpověď ze služby.
CloudErrorBody	Chybová odpověď ze služby.
IPAllocationMethod	Metoda přidělování IP adres.
IPRule
NetworkAcls
ProvisioningState	Aktuální stav zřizování.
Sku	Skladová položka tohoto hostitele Bastion.
SubResource	Odkaz na jiný dílčí zdroj.

BastionHost

Prostředek hostitele Bastionu.

Name	Typ	Výchozí hodnota	Description
etag	string		Jedinečný řetězec jen pro čtení, který se mění při každé aktualizaci prostředku.
id	string		ID prostředku.
location	string		Umístění prostředku.
name	string		Název prostředku.
properties.disableCopyPaste	boolean	False	Povolte nebo zakažte funkci kopírování a vkládání prostředku Bastion Host.
properties.dnsName	string		Plně kvalifikovaný název domény pro koncový bod, na kterém je hostitel bastionu přístupný.
properties.enableFileCopy	boolean	False	Povolte nebo zakažte funkci kopírování souborů prostředku Bastion Host.
properties.enableIpConnect	boolean	False	Povolte nebo zakažte funkci IP Connect prostředku Bastion Host.
properties.enableKerberos	boolean	False	Povolte nebo zakažte funkci Kerberos prostředku Bastion Host.
properties.enableShareableLink	boolean	False	Povolte nebo zakažte odkaz sdíletelný pro prostředek hostitele Bastionu.
properties.enableTunneling	boolean	False	Povolte nebo zakažte funkci tunelování prostředku Bastion Host.
properties.ipConfigurations	BastionHostIPConfiguration[]		Konfigurace IP prostředku Bastion Host.
properties.networkAcls	NetworkAcls
properties.provisioningState	ProvisioningState		Stav zřizování prostředku hostitele bastionu
properties.scaleUnits	integer		Jednotky škálování prostředku Bastion Host.
properties.virtualNetwork	SubResource		Odkaz na existující virtuální síť vyžadovanou pouze pro vývojáře Bastion Host.
sku	Sku		Skladová položka tohoto hostitele Bastion.
tags	object		Značky prostředků.
type	string		Typ prostředku.
zones	string[]		Seznam zón dostupnosti označující, odkud má prostředek pocházet.

BastionHostIPConfiguration

Konfigurace IP adresy hostitele Bastion.

Name	Typ	Description
etag	string	Jedinečný řetězec jen pro čtení, který se mění při každé aktualizaci prostředku.
id	string	ID prostředku.
name	string	Název prostředku, který je jedinečný v rámci skupiny prostředků. Tento název se dá použít pro přístup k prostředku.
properties.privateIPAllocationMethod	IPAllocationMethod	Metoda přidělování privátníCH IP adres.
properties.provisioningState	ProvisioningState	Stav zřizování prostředku konfigurace IP adresy hostitele bastionu
properties.publicIPAddress	SubResource	Odkaz na prostředek PublicIP.
properties.subnet	SubResource	Odkaz na prostředek podsítě.
type	string	Typ konfigurace IP adresy.

BastionHostListResult

Odpověď na volání služby rozhraní API ListBastionHosts

Name	Typ	Description
nextLink	string	Adresa URL pro získání další sady výsledků
value	BastionHost[]	Seznam hostitelů Bastionu ve skupině prostředků

BastionHostSkuName

Název tohoto hostitele bastionu.

Name	Typ	Description
Basic	string
Developer	string
Standard	string

CloudError

Chybová odpověď ze služby.

Name	Typ	Description
error	CloudErrorBody	Text chyby cloudu

CloudErrorBody

Chybová odpověď ze služby.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využívány programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

IPAllocationMethod

Metoda přidělování IP adres.

Name	Typ	Description
Dynamic	string
Static	string

IPRule

Name	Typ	Description
addressPrefix	string	Určuje rozsah IP adres nebo IP adres ve formátu CIDR. Je povolena pouze adresa IPV4.

NetworkAcls

Name	Typ	Description
ipRules	IPRule[]	Nastaví pravidla seznamu IP ACL pro vývojáře Bastion Host.

ProvisioningState

Aktuální stav zřizování.

Name	Typ	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

Sku

Skladová položka tohoto hostitele Bastion.

Name	Typ	Výchozí hodnota	Description
name	BastionHostSkuName	Standard	Název tohoto hostitele bastionu.

SubResource

Odkaz na jiný dílčí zdroj.

Name	Typ	Description
id	string	ID prostředku.