Bastion Hosts - List

Referenz

Service:: Virtual Networks

API Version:: 2023-09-01

Listen alle Bastion-Hosts in einem Abonnement.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Die Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	BastionHostListResult	Erfolg. Der Vorgang gibt eine Liste der Bastion Host-Ressourcen zurück.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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": []
      }
    }
  ]
}

Definitionen

Name	Beschreibung
BastionHost	Bastion Host-Ressource.
BastionHostIPConfiguration	IP-Konfiguration eines Bastion-Hosts.
BastionHostListResult	Antwort für listBastionHosts-API-Dienstaufruf.
BastionHostSkuName	Der Name dieses Bastionhosts.
CloudError	Eine Fehlerantwort vom Dienst.
CloudErrorBody	Eine Fehlerantwort vom Dienst.
IPAllocationMethod	IP-Adresszuordnungsmethode.
IPRule
NetworkAcls
ProvisioningState	Der aktuelle Bereitstellungsstatus.
Sku	Die SKU dieses Bastionhosts.
SubResource	Verweis auf eine andere Unterressource.

BastionHost

Bastion Host-Ressource.

Name	Typ	Standardwert	Beschreibung
etag	string		Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string		Ressourcen-ID
location	string		Ressourcenspeicherort
name	string		Name der Ressource.
properties.disableCopyPaste	boolean	False	Aktivieren/Deaktivieren des Kopier-/Einfügefeatures der Bastion Host-Ressource.
properties.dnsName	string		FQDN für den Endpunkt, auf den auf den Bastionhost zugegriffen werden kann.
properties.enableFileCopy	boolean	False	Aktivieren/Deaktivieren der Dateikopierfunktion der Bastion Host-Ressource.
properties.enableIpConnect	boolean	False	Aktivieren/Deaktivieren der IP Connect-Funktion der Bastion Host-Ressource.
properties.enableKerberos	boolean	False	Aktivieren/Deaktivieren der Kerberos-Funktion der Bastion Host-Ressource.
properties.enableShareableLink	boolean	False	Aktivieren/Deaktivieren sie shareable Link der Bastion Host-Ressource.
properties.enableTunneling	boolean	False	Aktivieren/Deaktivieren des Tunnelingfeatures der Bastion Host-Ressource.
properties.ipConfigurations	BastionHostIPConfiguration[]		IP-Konfiguration der Bastion Host-Ressource.
properties.networkAcls	NetworkAcls
properties.provisioningState	ProvisioningState		Der Bereitstellungsstatus der Bastionhostressource.
properties.scaleUnits	integer		Die Skalierungseinheiten für die Bastion Host-Ressource.
properties.virtualNetwork	SubResource		Verweis auf ein vorhandenes virtuelles Netzwerk, das nur für Developer Bastion Host erforderlich ist.
sku	Sku		Die SKU dieses Bastionhosts.
tags	object		Ressourcentags.
type	string		Der Ressourcentyp.
zones	string[]		Eine Liste der Verfügbarkeitszonen, die angibt, wo die Ressource herkommen muss.

BastionHostIPConfiguration

IP-Konfiguration eines Bastion-Hosts.

Name	Typ	Beschreibung
etag	string	Eine eindeutige schreibgeschützte Zeichenfolge, die sich ändert, wenn die Ressource aktualisiert wird.
id	string	Ressourcen-ID
name	string	Name der Ressource, die innerhalb einer Ressourcengruppe eindeutig ist. Dieser Name kann für den Zugriff auf die Ressource verwendet werden.
properties.privateIPAllocationMethod	IPAllocationMethod	Private IP-Zuordnungsmethode.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der IP-Konfigurationsressource des Bastionhosts.
properties.publicIPAddress	SubResource	Referenz der PublicIP-Ressource.
properties.subnet	SubResource	Verweis auf die Subnetzressource.
type	string	IP-Konfigurationstyp.

BastionHostListResult

Antwort für listBastionHosts-API-Dienstaufruf.

Name	Typ	Beschreibung
nextLink	string	URL, um den nächsten Satz von Ergebnissen zu erhalten.
value	BastionHost[]	Liste der Bastion-Hosts in einer Ressourcengruppe.

BastionHostSkuName

Der Name dieses Bastionhosts.

Name	Typ	Beschreibung
Basic	string
Developer	string
Standard	string

CloudError

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
error	CloudErrorBody	Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort vom Dienst.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
target	string	Das Ziel des bestimmten Fehlers. Beispiel: Der Name der -Eigenschaft, die einen Fehler aufweist.

IPAllocationMethod

IP-Adresszuordnungsmethode.

Name	Typ	Beschreibung
Dynamic	string
Static	string

IPRule

Name	Typ	Beschreibung
addressPrefix	string	Gibt den IP- oder IP-Bereich im CIDR-Format an. Nur IPV4-Adresse ist zulässig.

NetworkAcls

Name	Typ	Beschreibung
ipRules	IPRule[]	Legt die IP-ACL-Regeln für Developer Bastion Host fest.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Deleting	string
Failed	string
Succeeded	string
Updating	string

Sku

Die SKU dieses Bastionhosts.

Name	Typ	Standardwert	Beschreibung
name	BastionHostSkuName	Standard	Der Name dieses Bastionhosts.

SubResource

Verweis auf eine andere Unterressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID