Bastion Hosts - Create Or Update

Tworzy lub aktualizuje określonego hosta usługi Bastion.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
bastionHostName
path True

string

Nazwa hosta usługi Bastion.

resourceGroupName
path True

string

Nazwa grupy zasobów.

subscriptionId
path True

string

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True

string

Wersja interfejsu API klienta.

Treść żądania

Nazwa Typ Opis
id

string

Identyfikator zasobu.

location

string

Lokalizacja zasobu.

properties.disableCopyPaste

boolean

Włącz/wyłącz funkcję kopiowania/wklejania zasobu hosta usługi Bastion.

properties.dnsName

string

Nazwa FQDN punktu końcowego, w którym jest dostępny host bastionu.

properties.enableFileCopy

boolean

Włącz/wyłącz funkcję kopiowania plików zasobu hosta usługi Bastion.

properties.enableIpConnect

boolean

Włączanie/wyłączanie funkcji IP Connect zasobu hosta usługi Bastion.

properties.enableKerberos

boolean

Włączanie/wyłączanie funkcji Kerberos zasobu hosta usługi Bastion.

properties.enableShareableLink

boolean

Włącz/wyłącz łącze współużytkowalne zasobu hosta usługi Bastion.

properties.enableTunneling

boolean

Włącz/wyłącz funkcję tunelowania zasobu hosta usługi Bastion.

properties.ipConfigurations

BastionHostIPConfiguration[]

Konfiguracja adresu IP zasobu hosta usługi Bastion.

properties.networkAcls

NetworkAcls

properties.scaleUnits

integer

Jednostki skalowania zasobu hosta usługi Bastion.

properties.virtualNetwork

SubResource

Odwołanie do istniejącej sieci wirtualnej wymaganej tylko dla hosta usługi Bastion dla deweloperów.

sku

Sku

Jednostka SKU tego hosta usługi Bastion.

tags

object

Tagi zasobów.

zones

string[]

Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób.

Odpowiedzi

Nazwa Typ Opis
200 OK

BastionHost

Aktualizacja zakończyła się pomyślnie. Operacja zwraca wynikowy zasób hosta usługi Bastion.

201 Created

BastionHost

Tworzenie zakończyło się pomyślnie. Operacja zwraca wynikowy zasób hosta usługi Bastion.

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Create Bastion Host
Create Bastion Host With Zones
Create Developer Bastion Host

Create Bastion Host

Sample Request

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

{
  "properties": {
    "ipConfigurations": [
      {
        "name": "bastionHostIpConfiguration",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"
          },
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"
          }
        }
      }
    ]
  }
}

Sample Response

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

Create Bastion Host With Zones

Sample Request

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

{
  "properties": {
    "ipConfigurations": [
      {
        "name": "bastionHostIpConfiguration",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet"
          },
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName"
          }
        }
      }
    ]
  }
}

Sample Response

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

Create Developer Bastion Host

Sample Request

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

{
  "properties": {
    "virtualNetwork": {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2"
    },
    "networkAcls": {
      "ipRules": [
        {
          "addressPrefix": "1.1.1.1/16"
        }
      ]
    },
    "ipConfigurations": []
  }
}

Sample Response

{
  "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",
    "dnsName": "omnibrain.uswest.bastionglobal.azure.com",
    "virtualNetwork": {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2"
    },
    "networkAcls": {
      "ipRules": [
        {
          "addressPrefix": "1.1.1.1/16"
        }
      ]
    },
    "ipConfigurations": []
  }
}
{
  "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",
    "dnsName": "omnibrain.uswest.bastionglobal.azure.com",
    "virtualNetwork": {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2"
    },
    "networkAcls": {
      "ipRules": [
        {
          "addressPrefix": "1.1.1.1/16"
        }
      ]
    },
    "ipConfigurations": []
  }
}

Definicje

Nazwa Opis
BastionHost

Zasób hosta usługi Bastion.

BastionHostIPConfiguration

Konfiguracja adresu IP hosta usługi Bastion.

BastionHostSkuName

Nazwa tego hosta usługi Bastion.

CloudError

Odpowiedź błędu z usługi.

CloudErrorBody

Odpowiedź błędu z usługi.

IPAllocationMethod

Metoda alokacji adresów IP.

IPRule
NetworkAcls
ProvisioningState

Bieżący stan aprowizacji.

Sku

Jednostka SKU tego hosta usługi Bastion.

SubResource

Odwołanie do innego podźródła.

BastionHost

Zasób hosta usługi Bastion.

Nazwa Typ Wartość domyślna Opis
etag

string

Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.

id

string

Identyfikator zasobu.

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu.

properties.disableCopyPaste

boolean

False

Włącz/wyłącz funkcję kopiowania/wklejania zasobu hosta usługi Bastion.

properties.dnsName

string

Nazwa FQDN punktu końcowego, w którym jest dostępny host bastionu.

properties.enableFileCopy

boolean

False

Włącz/wyłącz funkcję kopiowania plików zasobu hosta usługi Bastion.

properties.enableIpConnect

boolean

False

Włączanie/wyłączanie funkcji IP Connect zasobu hosta usługi Bastion.

properties.enableKerberos

boolean

False

Włączanie/wyłączanie funkcji Kerberos zasobu hosta usługi Bastion.

properties.enableShareableLink

boolean

False

Włącz/wyłącz łącze współużytkowalne zasobu hosta usługi Bastion.

properties.enableTunneling

boolean

False

Włącz/wyłącz funkcję tunelowania zasobu hosta usługi Bastion.

properties.ipConfigurations

BastionHostIPConfiguration[]

Konfiguracja adresu IP zasobu hosta usługi Bastion.

properties.networkAcls

NetworkAcls

properties.provisioningState

ProvisioningState

Stan aprowizacji zasobu hosta bastionu.

properties.scaleUnits

integer

Jednostki skalowania zasobu hosta usługi Bastion.

properties.virtualNetwork

SubResource

Odwołanie do istniejącej sieci wirtualnej wymaganej tylko dla hosta usługi Bastion dla deweloperów.

sku

Sku

Jednostka SKU tego hosta usługi Bastion.

tags

object

Tagi zasobów.

type

string

Typ zasobu.

zones

string[]

Lista stref dostępności oznaczających miejsce, z którego musi pochodzić zasób.

BastionHostIPConfiguration

Konfiguracja adresu IP hosta usługi Bastion.

Nazwa Typ Opis
etag

string

Unikatowy ciąg tylko do odczytu, który zmienia się za każdym razem, gdy zasób jest aktualizowany.

id

string

Identyfikator zasobu.

name

string

Nazwa zasobu, który jest unikatowy w grupie zasobów. Ta nazwa może służyć do uzyskiwania dostępu do zasobu.

properties.privateIPAllocationMethod

IPAllocationMethod

Metoda alokacji prywatnego adresu IP.

properties.provisioningState

ProvisioningState

Stan aprowizacji zasobu konfiguracji adresu IP hosta bastionu.

properties.publicIPAddress

SubResource

Odwołanie do zasobu PublicIP.

properties.subnet

SubResource

Odwołanie do zasobu podsieci.

type

string

Typ konfiguracji adresu IP.

BastionHostSkuName

Nazwa tego hosta usługi Bastion.

Nazwa Typ Opis
Basic

string

Developer

string

Standard

string

CloudError

Odpowiedź błędu z usługi.

Nazwa Typ Opis
error

CloudErrorBody

Treść błędu chmury.

CloudErrorBody

Odpowiedź błędu z usługi.

Nazwa Typ Opis
code

string

Identyfikator błędu. Kody są niezmienne i mają być używane programowo.

details

CloudErrorBody[]

Lista dodatkowych szczegółów dotyczących błędu.

message

string

Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

target

string

Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

IPAllocationMethod

Metoda alokacji adresów IP.

Nazwa Typ Opis
Dynamic

string

Static

string

IPRule

Nazwa Typ Opis
addressPrefix

string

Określa adres IP lub zakres adresów IP w formacie CIDR. Dozwolony jest tylko adres IPV4.

NetworkAcls

Nazwa Typ Opis
ipRules

IPRule[]

Ustawia reguły listy ACL adresów IP dla hosta usługi Developer Bastion.

ProvisioningState

Bieżący stan aprowizacji.

Nazwa Typ Opis
Deleting

string

Failed

string

Succeeded

string

Updating

string

Sku

Jednostka SKU tego hosta usługi Bastion.

Nazwa Typ Wartość domyślna Opis
name

BastionHostSkuName

Standard

Nazwa tego hosta usługi Bastion.

SubResource

Odwołanie do innego podźródła.

Nazwa Typ Opis
id

string

Identyfikator zasobu.