Freigeben über


Bastion Hosts - Get

Ruft den angegebenen Bastion-Host ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
bastionHostName
path True

string

Der Name des Bastion-Hosts.

resourceGroupName
path True

string

Der Name der Ressourcengruppe.

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

BastionHost

Anforderung erfolgreich. Der Vorgang gibt eine BastionHost-Ressource zurück.

Other Status Codes

CloudError

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

Get Bastion Host
Get Bastion Host With Private Only
Get Bastion Host With Zones
Get Developer Bastion Host

Get Bastion Host

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'?api-version=2024-05-01

Beispiel für eine Antwort

{
  "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",
  "tags": {
    "key1": "value1"
  },
  "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,
    "enableSessionRecording": false,
    "enablePrivateOnlyBastion": 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"
          }
        }
      }
    ]
  }
}

Get Bastion Host With Private Only

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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": {
    "key1": "value1"
  },
  "sku": {
    "name": "Premium"
  },
  "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,
    "enableSessionRecording": false,
    "enablePrivateOnlyBastion": true,
    "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"
          }
        }
      }
    ]
  }
}

Get Bastion Host With Zones

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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": {
    "key1": "value1"
  },
  "sku": {
    "name": "Standard"
  },
  "zones": [
    "1",
    "2"
  ],
  "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,
    "enableSessionRecording": false,
    "enablePrivateOnlyBastion": 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"
          }
        }
      }
    ]
  }
}

Get Developer Bastion Host

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'?api-version=2024-05-01

Beispiel für eine Antwort

{
  "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.

BastionHostSkuName

Der Name der Sku dieses Bastion-Hosts.

CloudError

Eine Fehlerantwort des Diensts.

CloudErrorBody

Eine Fehlerantwort des Diensts.

IPAllocationMethod

IP-Adresszuweisungsmethode.

IPRule
NetworkAcls
ProvisioningState

Der aktuelle Bereitstellungsstatus.

Sku

Die Sku dieses Bastion Host.

SubResource

Verweisen 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

Ressourcenname.

properties.disableCopyPaste

boolean

False

Aktivieren/Deaktivieren sie die Funktion "Kopieren/Einfügen" der Bastion Host-Ressource.

properties.dnsName

string

FQDN für den Endpunkt, auf den der Bastionhost zugreifen kann.

properties.enableFileCopy

boolean

False

Aktivieren/Deaktivieren der Dateikopie-Funktion der Bastion-Hostressource.

properties.enableIpConnect

boolean

False

Aktivieren/Deaktivieren der IP Connect-Funktion der Bastion-Hostressource.

properties.enableKerberos

boolean

False

Aktivieren/Deaktivieren der Kerberos-Funktion der Bastion-Hostressource.

properties.enablePrivateOnlyBastion

boolean

False

Aktivieren/Deaktivieren des Features "Nur privat" der Bastion-Hostressource.

properties.enableSessionRecording

boolean

False

Aktivieren/Deaktivieren der Sitzungsaufzeichnungsfunktion der Bastion-Hostressource.

properties.enableShareableLink

boolean

False

Freigabefähige Verknüpfung der Bastion-Hostressource aktivieren/deaktivieren.

properties.enableTunneling

boolean

False

Aktivieren/Deaktivieren des Tunnelingfeatures der Bastion-Hostressource.

properties.ipConfigurations

BastionHostIPConfiguration[]

IP-Konfiguration der Bastion Host-Ressource.

properties.networkAcls

NetworkAcls

properties.provisioningState

ProvisioningState

Der Bereitstellungsstatus der Bastion-Hostressource.

properties.scaleUnits

integer

Die Skalierungseinheiten für die Bastion Host-Ressource.

properties.virtualNetwork

SubResource

Verweis auf ein vorhandenes virtuelles Netzwerk, das nur für Entwickler-Bastion-Host erforderlich ist.

sku

Sku

Die Sku dieses Bastion Host.

tags

object

Ressourcentags.

type

string

Ressourcentyp.

zones

string[]

Eine Liste der Verfügbarkeitszonen, aus denen die Ressource stammen 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 Bastion-Host-IP-Konfigurationsressource.

properties.publicIPAddress

SubResource

Verweis auf die PublicIP-Ressource. Null für nur private Bastion

properties.subnet

SubResource

Verweis auf die Subnetzressource.

type

string

IP-Konfigurationstyp.

BastionHostSkuName

Der Name der Sku dieses Bastion-Hosts.

Name Typ Beschreibung
Basic

string

Developer

string

Premium

string

Standard

string

CloudError

Eine Fehlerantwort des Diensts.

Name Typ Beschreibung
error

CloudErrorBody

Cloudfehlertext.

CloudErrorBody

Eine Fehlerantwort des Diensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.

details

CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.

message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

target

string

Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

IPAllocationMethod

IP-Adresszuweisungsmethode.

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 Entwickler-Bastion-Host fest.

ProvisioningState

Der aktuelle Bereitstellungsstatus.

Name Typ Beschreibung
Deleting

string

Failed

string

Succeeded

string

Updating

string

Sku

Die Sku dieses Bastion Host.

Name Typ Standardwert Beschreibung
name

BastionHostSkuName

Standard

Der Name der Sku dieses Bastion-Hosts.

SubResource

Verweisen auf eine andere Unterressource.

Name Typ Beschreibung
id

string

Ressourcen-ID.