Bastion Hosts - Get

リファレンス

Service:: Virtual Networks

API Version:: 2022-09-01

指定した Bastion ホストを取得します。

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

URI パラメーター

Name	In	Required	Type	Description
bastionHostName	path	True	string	Bastion ホストの名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプションの資格情報。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API バージョン。

応答

Name	Type	Description
200 OK	BastionHost	要求が成功しました。操作は BastionHost リソースを返します。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

Name	Description
user_impersonation	ユーザーアカウントを偽装する

例

Get Bastion Host

Sample Request

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

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_get.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.get(
        resource_group_name="rg1",
        bastion_host_name="bastionhosttenant'",
    )
    print(response)


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

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

/**
 * This sample demonstrates how to Gets the specified Bastion Host.
 *
 * @summary Gets the specified Bastion Host.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2022-09-01/examples/BastionHostGet.json
 */
async function getBastionHost() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const bastionHostName = "bastionhosttenant'";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const result = await client.bastionHosts.get(resourceGroupName, bastionHostName);
  console.log(result);
}

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

{
  "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"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com",
    "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"
          }
        }
      }
    ]
  }
}

定義

BastionHost	Bastion ホストリソース。
BastionHostIPConfiguration	Bastion ホストの IP 構成。
BastionHostSkuName	この Bastion ホストの名前。
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
IPAllocationMethod	IP アドレスの割り当て方法。
ProvisioningState	現在のプロビジョニング状態。
Sku	この Bastion ホストの SKU。
SubResource	別のサブリソースへの参照。

BastionHost

Bastion ホストリソース。

Name	Type	Default Value	Description
etag	string		リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string		リソースの ID
location	string		リソースの場所。
name	string		リソース名。
properties.disableCopyPaste	boolean	False	Bastion ホストリソースのコピー/貼り付け機能を有効または無効にします。
properties.dnsName	string		bastion ホストにアクセスできるエンドポイントの FQDN。
properties.enableFileCopy	boolean	False	Bastion ホストリソースのファイルコピー機能を有効または無効にします。
properties.enableIpConnect	boolean	False	Bastion ホストリソースの IP 接続機能を有効または無効にします。
properties.enableShareableLink	boolean	False	Bastion ホストリソースの共有可能リンクを有効または無効にします。
properties.enableTunneling	boolean	False	Bastion ホストリソースのトンネリング機能を有効または無効にします。
properties.ipConfigurations	BastionHostIPConfiguration[]		Bastion ホストリソースの IP 構成。
properties.provisioningState	ProvisioningState		bastion ホストリソースのプロビジョニング状態。
properties.scaleUnits	integer		Bastion ホストリソースのスケールユニット。
sku	Sku		この Bastion ホストの SKU。
tags	object		リソースタグ。
type	string		リソースの種類。

BastionHostIPConfiguration

Bastion ホストの IP 構成。

Name	Type	Description
etag	string	リソースが更新されるたびに変更される一意の読み取り専用文字列。
id	string	リソースの ID
name	string	リソースグループ内で一意であるリソースの名前。この名前は、リソースへのアクセスに使用できます。
properties.privateIPAllocationMethod	IPAllocationMethod	プライベート IP 割り当て方法。
properties.provisioningState	ProvisioningState	bastion ホスト IP 構成リソースのプロビジョニング状態。
properties.publicIPAddress	SubResource	PublicIP リソースの参照。
properties.subnet	SubResource	サブネットリソースの参照。
type	string	IP 構成の種類。

BastionHostSkuName

この Bastion ホストの名前。

Name	Type	Description
Basic	string
Standard	string

CloudError

サービスからのエラー応答。

Name	Type	Description
error	CloudErrorBody	クラウドエラー本文。

CloudErrorBody

サービスからのエラー応答。

Name	Type	Description
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

IPAllocationMethod

IP アドレスの割り当て方法。

Name	Type	Description
Dynamic	string
Static	string

ProvisioningState

現在のプロビジョニング状態。

Name	Type	Description
Deleting	string
Failed	string
Succeeded	string
Updating	string

Sku

この Bastion ホストの SKU。

Name	Type	Default Value	Description
name	BastionHostSkuName	Standard	この Bastion ホストの名前。

SubResource

別のサブリソースへの参照。

Name	Type	Description
id	string	リソースの ID