Vpn Sites - Create Or Update
Vytvoří prostředek VpnSite, pokud neexistuje, aktualizuje existující vpnSite.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}?api-version=2024-05-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Název skupiny prostředků sítě VpnSite. |
subscription
|
path | True |
string |
Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby. |
vpn
|
path | True |
string |
Název sítě VpnSite, který se vytváří nebo aktualizuje. |
api-version
|
query | True |
string |
Verze rozhraní API klienta. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
location | True |
string |
Umístění prostředku |
id |
string |
ID prostředku. |
|
properties.addressSpace |
AddressSpace, který obsahuje pole rozsahů IP adres. |
||
properties.bgpProperties |
Sada vlastností protokolu bgp. |
||
properties.deviceProperties |
Vlastnosti zařízení. |
||
properties.ipAddress |
string |
IP adresa pro vpn-site. |
|
properties.isSecuritySite |
boolean |
Příznak IsSecuritySite. |
|
properties.o365Policy |
Zásady Office365 |
||
properties.siteKey |
string |
Klíč pro vpn-site, který lze použít pro připojení. |
|
properties.virtualWan |
VirtualWAN, do které vpnSite patří. |
||
properties.vpnSiteLinks |
Seznam všech propojení lokalit vpn |
||
tags |
object |
Značky prostředků |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Žádost byla úspěšná. Vrátí podrobnosti o vytvořeném nebo aktualizovaném webu VpnSite. |
|
201 Created |
Žádost byla úspěšně přijata. Vrátí podrobnosti o vytvořeném nebo aktualizovaném webu VpnSite. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok OAuth2 v Azure Active Directory
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
VpnSiteCreate
Ukázkový požadavek
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1?api-version=2024-05-01
{
"tags": {
"key1": "value1"
},
"location": "West US",
"properties": {
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"isSecuritySite": false,
"vpnSiteLinks": [
{
"name": "vpnSiteLink1",
"properties": {
"ipAddress": "50.50.50.56",
"fqdn": "link1.vpnsite1.contoso.com",
"linkProperties": {
"linkProviderName": "vendor1",
"linkSpeedInMbps": 0
},
"bgpProperties": {
"bgpPeeringAddress": "192.168.0.0",
"asn": 1234
}
}
}
],
"o365Policy": {
"breakOutCategories": {
"allow": true,
"optimize": true,
"default": false
}
}
}
}
Ukázková odpověď
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"location": "West US",
"name": "vpnSite1",
"type": "Microsoft.Network/vpnSites",
"tags": {
"key1": "value1"
},
"properties": {
"provisioningState": "Succeeded",
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"deviceProperties": {
"linkSpeedInMbps": 0
},
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"isSecuritySite": false,
"vpnSiteLinks": [
{
"name": "vpnSiteLink1",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"type": "Microsoft.Network/vpnSites/vpnSiteLinks",
"properties": {
"provisioningState": "Succeeded",
"ipAddress": "50.50.50.56",
"linkProperties": {
"linkProviderName": "vendor1",
"linkSpeedInMbps": 0
},
"bgpProperties": {
"bgpPeeringAddress": "192.168.0.0",
"asn": 1234
}
}
}
]
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"location": "West US",
"name": "vpnSite1",
"type": "Microsoft.Network/vpnSites",
"tags": {
"key1": "value1"
},
"properties": {
"provisioningState": "Succeeded",
"virtualWan": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
},
"deviceProperties": {
"linkSpeedInMbps": 0
},
"addressSpace": {
"addressPrefixes": [
"10.0.0.0/16"
]
},
"isSecuritySite": false,
"vpnSiteLinks": [
{
"name": "vpnSiteLink1",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
"etag": "W/\"00000000-0000-0000-0000-000000000000\"",
"properties": {
"provisioningState": "Succeeded",
"ipAddress": "50.50.50.56",
"linkProperties": {
"linkProviderName": "vendor1",
"linkSpeedInMbps": 0
},
"bgpProperties": {
"bgpPeeringAddress": "192.168.0.0",
"asn": 1234
}
}
}
]
}
}
Definice
Name | Description |
---|---|
Address |
AddressSpace obsahuje pole rozsahů IP adres, které můžou používat podsítě virtuální sítě. |
Bgp |
Podrobnosti o nastavení protokolu BGP. |
Cloud |
Chybová odpověď ze služby. |
Cloud |
Chybová odpověď ze služby. |
Device |
Seznam vlastností zařízení |
Ipam |
Referenční informace o přidělování předpon IpamPool |
IPConfiguration |
Vlastnosti IPConfigurationBgpPeeringAddress. |
O365Break |
Kategorie breakoutů v Office365 |
O365Policy |
Zásady přerušení Office365 |
Provisioning |
Aktuální stav zřizování. |
Sub |
Odkaz na jiný podsourc. |
Vpn |
Podrobnosti nastavení protokolu BGP pro odkaz |
Vpn |
Seznam vlastností zprostředkovatele propojení |
Vpn |
Prostředek VpnSite. |
Vpn |
Prostředek VpnSiteLink. |
AddressSpace
AddressSpace obsahuje pole rozsahů IP adres, které můžou používat podsítě virtuální sítě.
Name | Typ | Description |
---|---|---|
addressPrefixes |
string[] |
Seznam bloků adres vyhrazených pro tuto virtuální síť v zápisu CIDR |
ipamPoolPrefixAllocations |
Seznam fondů IPAM, které přidělují předpony IP adres. |
BgpSettings
Podrobnosti o nastavení protokolu BGP.
Name | Typ | Description |
---|---|---|
asn |
integer (int64) minimum: 0maximum: 4294967295 |
ASN mluvčího protokolu BGP. |
bgpPeeringAddress |
string |
Adresa partnerského vztahu protokolu BGP a identifikátor protokolu BGP tohoto mluvčího protokolu BGP. |
bgpPeeringAddresses |
Adresa partnerského vztahu protokolu BGP s ID konfigurace PROTOKOLU IP pro bránu virtuální sítě. |
|
peerWeight |
integer (int32) |
Váha přidaná do tras získaných z tohoto mluvčího protokolu BGP. |
CloudError
Chybová odpověď ze služby.
Name | Typ | Description |
---|---|---|
error |
Text chyby cloudu. |
CloudErrorBody
Chybová odpověď ze služby.
Name | Typ | Description |
---|---|---|
code |
string |
Identifikátor chyby. Kódy jsou invariantní a mají být využity programově. |
details |
Seznam dalších podrobností o chybě |
|
message |
string |
Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní. |
target |
string |
Cíl konkrétní chyby. Například název vlastnosti v chybě. |
DeviceProperties
Seznam vlastností zařízení
Name | Typ | Description |
---|---|---|
deviceModel |
string |
Model zařízení |
deviceVendor |
string |
Název dodavatele zařízení. |
linkSpeedInMbps |
integer (int32) |
Rychlost propojení. |
IpamPoolPrefixAllocation
Referenční informace o přidělování předpon IpamPool
Name | Typ | Description |
---|---|---|
allocatedAddressPrefixes |
string[] |
Seznam předpon přiřazených IP adres v ipamPool přidruženého prostředku |
numberOfIpAddresses |
string |
Počet IP adres, které se mají přidělit |
pool.id |
string (arm-id) |
ID prostředku přidruženého prostředku Azure IpamPool. |
IPConfigurationBgpPeeringAddress
Vlastnosti IPConfigurationBgpPeeringAddress.
Name | Typ | Description |
---|---|---|
customBgpIpAddresses |
string[] |
Seznam vlastních adres partnerského vztahu protokolu BGP, které patří do konfigurace PROTOKOLU IP. |
defaultBgpIpAddresses |
string[] |
Seznam výchozích adres partnerského vztahu protokolu BGP, které patří do konfigurace PROTOKOLU IP. |
ipconfigurationId |
string |
ID konfigurace PROTOKOLU IP, která patří k bráně. |
tunnelIpAddresses |
string[] |
Seznam veřejných IP adres tunelu, které patří do konfigurace PROTOKOLU IP. |
O365BreakOutCategoryPolicies
Kategorie breakoutů v Office365
Name | Typ | Description |
---|---|---|
allow |
boolean |
Příznak pro řízení povolené kategorie. |
default |
boolean |
Příznak pro řízení výchozí kategorie |
optimize |
boolean |
Příznak pro řízení kategorie optimalizace |
O365PolicyProperties
Zásady přerušení Office365
Name | Typ | Description |
---|---|---|
breakOutCategories |
Kategorie breakoutů v Office365 |
ProvisioningState
Aktuální stav zřizování.
Hodnota | Description |
---|---|
Deleting | |
Failed | |
Succeeded | |
Updating |
SubResource
Odkaz na jiný podsourc.
Name | Typ | Description |
---|---|---|
id |
string |
ID prostředku. |
VpnLinkBgpSettings
Podrobnosti nastavení protokolu BGP pro odkaz
Name | Typ | Description |
---|---|---|
asn |
integer (int64) |
ASN mluvčího protokolu BGP. |
bgpPeeringAddress |
string |
Adresa partnerského vztahu protokolu BGP a identifikátor protokolu BGP tohoto mluvčího protokolu BGP. |
VpnLinkProviderProperties
Seznam vlastností zprostředkovatele propojení
Name | Typ | Description |
---|---|---|
linkProviderName |
string |
Název zprostředkovatele propojení |
linkSpeedInMbps |
integer (int32) |
Rychlost propojení. |
VpnSite
Prostředek VpnSite.
Name | Typ | Description |
---|---|---|
etag |
string |
Jedinečný řetězec jen pro čtení, který se změní při každé aktualizaci prostředku. |
id |
string |
ID prostředku. |
location |
string |
Umístění prostředku |
name |
string |
Název prostředku |
properties.addressSpace |
AddressSpace, který obsahuje pole rozsahů IP adres. |
|
properties.bgpProperties |
Sada vlastností protokolu bgp. |
|
properties.deviceProperties |
Vlastnosti zařízení. |
|
properties.ipAddress |
string |
IP adresa pro vpn-site. |
properties.isSecuritySite |
boolean |
Příznak IsSecuritySite. |
properties.o365Policy |
Zásady Office365 |
|
properties.provisioningState |
Stav zřizování prostředku lokality VPN. |
|
properties.siteKey |
string |
Klíč pro vpn-site, který lze použít pro připojení. |
properties.virtualWan |
VirtualWAN, do které vpnSite patří. |
|
properties.vpnSiteLinks |
Seznam všech propojení lokalit vpn |
|
tags |
object |
Značky prostředků |
type |
string |
Typ prostředku. |
VpnSiteLink
Prostředek VpnSiteLink.
Name | Typ | Description |
---|---|---|
etag |
string |
Jedinečný řetězec jen pro čtení, který se změní při každé aktualizaci prostředku. |
id |
string |
ID prostředku. |
name |
string |
Název prostředku, který je jedinečný v rámci skupiny prostředků. Tento název lze použít pro přístup k prostředku. |
properties.bgpProperties |
Sada vlastností protokolu bgp. |
|
properties.fqdn |
string |
Plně kvalifikovaný název domény vpn-site-link. |
properties.ipAddress |
string |
IP adresa pro vpn-site-link. |
properties.linkProperties |
Vlastnosti zprostředkovatele propojení. |
|
properties.provisioningState |
Stav zřizování prostředku propojení lokality VPN. |
|
type |
string |
Typ prostředku. |