Bastion Hosts - List By Resource Group

Referencia

Service:: Virtual Networks

API Version:: 2023-09-01

Listas todos los hosts de Bastion de un grupo de recursos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Las credenciales de suscripción que identifican de forma exclusiva la suscripción a Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de API del cliente.

Respuestas

Nombre	Tipo	Description
200 OK	BastionHostListResult	Correcto. La operación devuelve una lista de recursos de BastionHost.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
BastionHost	Recurso de host bastión.
BastionHostIPConfiguration	Configuración de IP de un host de Bastion.
BastionHostListResult	Respuesta para la llamada del servicio api ListBastionHosts.
BastionHostSkuName	Nombre de este host de Bastion.
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
IPAllocationMethod	Método de asignación de direcciones IP.
IPRule
NetworkAcls
ProvisioningState	Estado de aprovisionamiento actual.
Sku	SKU de este host de Bastion.
SubResource	Referencia a otro subrecurso.

BastionHost

Recurso de host bastión.

Nombre	Tipo	Valor predeterminado	Description
etag	string		Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string		Identificador del recurso.
location	string		Ubicación del recurso
name	string		Nombre del recurso.
properties.disableCopyPaste	boolean	False	Habilite o deshabilite la característica Copiar y pegar del recurso host de Bastion.
properties.dnsName	string		FQDN para el punto de conexión en el que es accesible el host bastión.
properties.enableFileCopy	boolean	False	Habilite o deshabilite la característica Copia de archivos del recurso host de Bastion.
properties.enableIpConnect	boolean	False	Habilite o deshabilite la característica Conexión IP del recurso host de Bastion.
properties.enableKerberos	boolean	False	Habilite o deshabilite la característica Kerberos del recurso host de Bastion.
properties.enableShareableLink	boolean	False	Habilite o deshabilite el vínculo que se puede compartir del recurso host de Bastion.
properties.enableTunneling	boolean	False	Habilite o deshabilite la característica tunelización del recurso host de Bastion.
properties.ipConfigurations	BastionHostIPConfiguration[]		Configuración de IP del recurso host de Bastion.
properties.networkAcls	NetworkAcls
properties.provisioningState	ProvisioningState		Estado de aprovisionamiento del recurso de host bastión.
properties.scaleUnits	integer		Unidades de escalado para el recurso host de Bastion.
properties.virtualNetwork	SubResource		Referencia a una red virtual existente necesaria solo para el host de Bastion para desarrolladores.
sku	Sku		SKU de este host de Bastion.
tags	object		Etiquetas del recurso.
type	string		Tipo de recurso.
zones	string[]		Una lista de zonas de disponibilidad que indica dónde debe proceder el recurso.

BastionHostIPConfiguration

Configuración de IP de un host de Bastion.

Nombre	Tipo	Description
etag	string	Cadena de solo lectura única que cambia cada vez que se actualiza el recurso.
id	string	Identificador del recurso.
name	string	Nombre del recurso que es único dentro de un grupo de recursos. Este nombre se puede usar para acceder al recurso.
properties.privateIPAllocationMethod	IPAllocationMethod	Método de asignación de IP privada.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento del recurso de configuración de IP del host bastión.
properties.publicIPAddress	SubResource	Referencia del recurso PublicIP.
properties.subnet	SubResource	Referencia del recurso de subred.
type	string	Tipo de configuración ip.

BastionHostListResult

Respuesta para la llamada del servicio api ListBastionHosts.

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de resultados.
value	BastionHost[]	Lista de hosts de Bastion en un grupo de recursos.

BastionHostSkuName

Nombre de este host de Bastion.

Nombre	Tipo	Description
Basic	string
Developer	string
Standard	string

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Cuerpo del error en la nube.

CloudErrorBody

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para su presentación en una interfaz de usuario.
target	string	Destino del error determinado. Por ejemplo, el nombre de la propiedad en error.

IPAllocationMethod

Método de asignación de direcciones IP.

Nombre	Tipo	Description
Dynamic	string
Static	string

IPRule

Nombre	Tipo	Description
addressPrefix	string	Especifica la dirección IP o el intervalo IP en formato CIDR. Solo se permite la dirección IPV4.

NetworkAcls

Nombre	Tipo	Description
ipRules	IPRule[]	Establece las reglas de ACL de IP para el host de Bastion para desarrolladores.

ProvisioningState

Estado de aprovisionamiento actual.

Nombre	Tipo	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

Sku

SKU de este host de Bastion.

Nombre	Tipo	Valor predeterminado	Description
name	BastionHostSkuName	Standard	Nombre de este host de Bastion.

SubResource

Referencia a otro subrecurso.

Nombre	Tipo	Description
id	string	Identificador del recurso.