Bastion Hosts - Create Or Update

Crée ou met à jour l’hôte Bastion spécifié.

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

Paramètres URI

Nom Dans Obligatoire Type Description
bastionHostName
path True

string

Nom de l’hôte Bastion.

resourceGroupName
path True

string

Nom du groupe de ressources.

subscriptionId
path True

string

Informations d’identification d’abonnement qui identifient de façon unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True

string

Version d’API client.

Corps de la demande

Nom Type Description
id

string

ID de la ressource

location

string

Emplacement de la ressource.

properties.disableCopyPaste

boolean

Activer/désactiver la fonctionnalité Copier/Coller de la ressource d’hôte Bastion.

properties.dnsName

string

Nom de domaine complet du point de terminaison sur lequel l’hôte bastion est accessible.

properties.enableFileCopy

boolean

Activer/désactiver la fonctionnalité de copie de fichiers de la ressource d’hôte Bastion.

properties.enableIpConnect

boolean

Activer/désactiver la fonctionnalité De connexion IP de la ressource d’hôte Bastion.

properties.enableKerberos

boolean

Activer/désactiver la fonctionnalité Kerberos de la ressource d’hôte Bastion.

properties.enableShareableLink

boolean

Activer/désactiver le lien partageable de la ressource d’hôte Bastion.

properties.enableTunneling

boolean

Activer/désactiver la fonctionnalité de tunneling de la ressource Hôte Bastion.

properties.ipConfigurations

BastionHostIPConfiguration[]

Configuration IP de la ressource d’hôte Bastion.

properties.networkAcls

NetworkAcls

properties.scaleUnits

integer

Unités de mise à l’échelle de la ressource Hôte Bastion.

properties.virtualNetwork

SubResource

Référence à un réseau virtuel existant requis pour l’hôte Bastion du développeur uniquement.

sku

Sku

Référence sku de cet hôte Bastion.

tags

object

Balises de ressource.

zones

string[]

Liste des zones de disponibilité indiquant d’où doit provenir la ressource.

Réponses

Nom Type Description
200 OK

BastionHost

Mise à jour réussie. L’opération retourne la ressource d’hôte Bastion obtenue.

201 Created

BastionHost

Création réussie. L’opération retourne la ressource d’hôte Bastion obtenue.

Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom Description
BastionHost

Ressource d’hôte Bastion.

BastionHostIPConfiguration

Configuration IP d’un hôte Bastion.

BastionHostSkuName

Nom de cet hôte Bastion.

CloudError

Réponse d’erreur du service.

CloudErrorBody

Réponse d’erreur du service.

IPAllocationMethod

Méthode d’allocation d’adresses IP.

IPRule
NetworkAcls
ProvisioningState

État d’approvisionnement actuel.

Sku

Référence sku de cet hôte Bastion.

SubResource

Référence à une autre sous-ressource.

BastionHost

Ressource d’hôte Bastion.

Nom Type Valeur par défaut Description
etag

string

Chaîne unique en lecture seule qui change chaque fois que la ressource est mise à jour.

id

string

ID de la ressource

location

string

Emplacement de la ressource.

name

string

Nom de la ressource.

properties.disableCopyPaste

boolean

False

Activer/désactiver la fonctionnalité Copier/Coller de la ressource d’hôte Bastion.

properties.dnsName

string

Nom de domaine complet du point de terminaison sur lequel l’hôte bastion est accessible.

properties.enableFileCopy

boolean

False

Activer/désactiver la fonctionnalité de copie de fichiers de la ressource d’hôte Bastion.

properties.enableIpConnect

boolean

False

Activer/désactiver la fonctionnalité De connexion IP de la ressource d’hôte Bastion.

properties.enableKerberos

boolean

False

Activer/désactiver la fonctionnalité Kerberos de la ressource d’hôte Bastion.

properties.enableShareableLink

boolean

False

Activer/désactiver le lien partageable de la ressource d’hôte Bastion.

properties.enableTunneling

boolean

False

Activer/désactiver la fonctionnalité de tunneling de la ressource Hôte Bastion.

properties.ipConfigurations

BastionHostIPConfiguration[]

Configuration IP de la ressource d’hôte Bastion.

properties.networkAcls

NetworkAcls

properties.provisioningState

ProvisioningState

État d’approvisionnement de la ressource hôte bastion.

properties.scaleUnits

integer

Unités de mise à l’échelle de la ressource Hôte Bastion.

properties.virtualNetwork

SubResource

Référence à un réseau virtuel existant requis pour l’hôte Bastion du développeur uniquement.

sku

Sku

Référence sku de cet hôte Bastion.

tags

object

Balises de ressource.

type

string

Type de ressource.

zones

string[]

Liste des zones de disponibilité indiquant d’où doit provenir la ressource.

BastionHostIPConfiguration

Configuration IP d’un hôte Bastion.

Nom Type Description
etag

string

Chaîne unique en lecture seule qui change chaque fois que la ressource est mise à jour.

id

string

ID de la ressource

name

string

Nom de la ressource unique au sein d’un groupe de ressources. Ce nom peut être utilisé pour accéder à la ressource.

properties.privateIPAllocationMethod

IPAllocationMethod

Méthode d’allocation d’adresses IP privées.

properties.provisioningState

ProvisioningState

État d’approvisionnement de la ressource de configuration IP de l’hôte bastion.

properties.publicIPAddress

SubResource

Référence de la ressource PublicIP.

properties.subnet

SubResource

Référence de la ressource de sous-réseau.

type

string

Type de configuration IP.

BastionHostSkuName

Nom de cet hôte Bastion.

Nom Type Description
Basic

string

Developer

string

Standard

string

CloudError

Réponse d’erreur du service.

Nom Type Description
error

CloudErrorBody

Corps d’erreur cloud.

CloudErrorBody

Réponse d’erreur du service.

Nom Type Description
code

string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.

details

CloudErrorBody[]

Liste de détails supplémentaires sur l’erreur.

message

string

Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.

target

string

Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

IPAllocationMethod

Méthode d’allocation d’adresses IP.

Nom Type Description
Dynamic

string

Static

string

IPRule

Nom Type Description
addressPrefix

string

Spécifie l’adresse IP ou la plage d’adresses IP au format CIDR. Seule l’adresse IPV4 est autorisée.

NetworkAcls

Nom Type Description
ipRules

IPRule[]

Définit les règles de liste de contrôle d’accès IP pour l’hôte Bastion du développeur.

ProvisioningState

État d’approvisionnement actuel.

Nom Type Description
Deleting

string

Failed

string

Succeeded

string

Updating

string

Sku

Référence sku de cet hôte Bastion.

Nom Type Valeur par défaut Description
name

BastionHostSkuName

Standard

Nom de cet hôte Bastion.

SubResource

Référence à une autre sous-ressource.

Nom Type Description
id

string

ID de la ressource