Create Azure VNet site.
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/azure_vnet_sites';const options = { method: 'POST', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"metadata":{"annotations":{},"description":"example","disable":true,"labels":{},"name":"example","namespace":"example"},"spec":{"address":"example","admin_password":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"alternate_region":"example","azure_cred":{"name":"example","namespace":"example"},"azure_region":"example","block_all_services":{},"blocked_services":{"blocked_sevice":[{"dns":{},"network_type":"VIRTUAL_NETWORK_SITE_LOCAL","ssh":{},"web_user_interface":{}}]},"coordinates":{"latitude":1,"longitude":1},"custom_dns":{"inside_nameserver":"example","outside_nameserver":"example"},"default_blocked_services":{},"disk_size":0,"ingress_egress_gw":{"accelerated_networking":{"disable":{},"enable":{}},"active_enhanced_firewall_policies":{"enhanced_firewall_policies":[{"name":"example","namespace":"example"}]},"active_forward_proxy_policies":{"forward_proxy_policies":[{"name":"example","namespace":"example"}]},"active_network_policies":{"network_policies":[{"name":"example","namespace":"example"}]},"az_nodes":[{"azure_az":"example","inside_subnet":{"subnet":{"subnet_name":"example","subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}},"outside_subnet":{"subnet":{"subnet_name":"example","subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}}}],"azure_certified_hw":"example","dc_cluster_group_inside_vn":{"name":"example","namespace":"example"},"dc_cluster_group_outside_vn":{"name":"example","namespace":"example"},"forward_proxy_allow_all":{},"global_network_list":{"global_network_connections":[{"sli_to_global_dr":{"global_vn":{"name":"example","namespace":"example"}},"slo_to_global_dr":{"global_vn":{"name":"example","namespace":"example"}}}]},"hub":{"express_route_disabled":{},"express_route_enabled":{"advertise_to_route_server":{},"auto_asn":{},"connections":[{"circuit_id":"example","metadata":{"description":"example","name":"example"},"other_subscription":{"authorized_key":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"circuit_id":"example"},"weight":1}],"custom_asn":1,"do_not_advertise_to_route_server":{},"gateway_subnet":{"auto":{},"subnet":{"subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}},"route_server_subnet":{"auto":{},"subnet":{"subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}},"site_registration_over_express_route":{"cloudlink_network_name":"example"},"site_registration_over_internet":{},"sku_ergw1az":{},"sku_ergw2az":{},"sku_high_perf":{},"sku_standard":{}},"spoke_vnets":[{"auto":{},"labels":{},"manual":{},"vnet":{"f5_orchestrated_routing":{},"manual_routing":{},"resource_group":"example","vnet_name":"example"}}]},"inside_static_routes":{"static_route_list":[{"custom_static_route":{"attrs":["ROUTE_ATTR_NO_OP"],"labels":{},"nexthop":{"interface":[{"name":"example","namespace":"example"}],"nexthop_address":{"ipv4":{"addr":"example"},"ipv6":{"addr":"example"}},"type":"NEXT_HOP_DEFAULT_GATEWAY"},"subnets":[{"ipv4":{"plen":1,"prefix":"example"},"ipv6":{"plen":1,"prefix":"example"}}]},"simple_static_route":"example"}]},"no_dc_cluster_group":{},"no_forward_proxy":{},"no_global_network":{},"no_inside_static_routes":{},"no_network_policy":{},"no_outside_static_routes":{},"not_hub":{},"outside_static_routes":{"static_route_list":[{"custom_static_route":{"attrs":["ROUTE_ATTR_NO_OP"],"labels":{},"nexthop":{"interface":[{"name":"example","namespace":"example"}],"nexthop_address":{"ipv4":{"addr":"example"},"ipv6":{"addr":"example"}},"type":"NEXT_HOP_DEFAULT_GATEWAY"},"subnets":[{"ipv4":{"plen":1,"prefix":"example"},"ipv6":{"plen":1,"prefix":"example"}}]},"simple_static_route":"example"}]},"performance_enhancement_mode":{"perf_mode_l3_enhanced":{"jumbo":{},"no_jumbo":{}},"perf_mode_l7_enhanced":{}},"sm_connection_public_ip":{},"sm_connection_pvt_ip":{}},"ingress_egress_gw_ar":{"accelerated_networking":{"disable":{},"enable":{}},"active_enhanced_firewall_policies":{"enhanced_firewall_policies":[{"name":"example","namespace":"example"}]},"active_forward_proxy_policies":{"forward_proxy_policies":[{"name":"example","namespace":"example"}]},"active_network_policies":{"network_policies":[{"name":"example","namespace":"example"}]},"azure_certified_hw":"example","dc_cluster_group_inside_vn":{"name":"example","namespace":"example"},"dc_cluster_group_outside_vn":{"name":"example","namespace":"example"},"forward_proxy_allow_all":{},"global_network_list":{"global_network_connections":[{"sli_to_global_dr":{"global_vn":{"name":"example","namespace":"example"}},"slo_to_global_dr":{"global_vn":{"name":"example","namespace":"example"}}}]},"hub":{"express_route_disabled":{},"express_route_enabled":{"advertise_to_route_server":{},"auto_asn":{},"connections":[{"circuit_id":"example","metadata":{"description":"example","name":"example"},"other_subscription":{"authorized_key":{"blindfold_secret_info":{"decryption_provider":"example","location":"example","store_provider":"example"},"clear_secret_info":{"provider":"example","url":"https://example.com"},"blindfold_secret_info_internal":{"decryption_provider":"example","location":"example","store_provider":"example"},"secret_encoding_type":"EncodingNone","vault_secret_info":{"key":"example","location":"example","provider":"example","secret_encoding":"EncodingNone","version":1},"wingman_secret_info":{"name":"example"}},"circuit_id":"example"},"weight":1}],"custom_asn":1,"do_not_advertise_to_route_server":{},"gateway_subnet":{"auto":{},"subnet":{"subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}},"route_server_subnet":{"auto":{},"subnet":{"subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}},"site_registration_over_express_route":{"cloudlink_network_name":"example"},"site_registration_over_internet":{},"sku_ergw1az":{},"sku_ergw2az":{},"sku_high_perf":{},"sku_standard":{}},"spoke_vnets":[{"auto":{},"labels":{},"manual":{},"vnet":{"f5_orchestrated_routing":{},"manual_routing":{},"resource_group":"example","vnet_name":"example"}}]},"inside_static_routes":{"static_route_list":[{"custom_static_route":{"attrs":["ROUTE_ATTR_NO_OP"],"labels":{},"nexthop":{"interface":[{"name":"example","namespace":"example"}],"nexthop_address":{"ipv4":{"addr":"example"},"ipv6":{"addr":"example"}},"type":"NEXT_HOP_DEFAULT_GATEWAY"},"subnets":[{"ipv4":{"plen":1,"prefix":"example"},"ipv6":{"plen":1,"prefix":"example"}}]},"simple_static_route":"example"}]},"no_dc_cluster_group":{},"no_forward_proxy":{},"no_global_network":{},"no_inside_static_routes":{},"no_network_policy":{},"no_outside_static_routes":{},"node":{"fault_domain":1,"inside_subnet":{"subnet":{"subnet_name":"example","subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}},"node_number":1,"outside_subnet":{"subnet":{"subnet_name":"example","subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}},"update_domain":1},"not_hub":{},"outside_static_routes":{"static_route_list":[{"custom_static_route":{"attrs":["ROUTE_ATTR_NO_OP"],"labels":{},"nexthop":{"interface":[{"name":"example","namespace":"example"}],"nexthop_address":{"ipv4":{"addr":"example"},"ipv6":{"addr":"example"}},"type":"NEXT_HOP_DEFAULT_GATEWAY"},"subnets":[{"ipv4":{"plen":1,"prefix":"example"},"ipv6":{"plen":1,"prefix":"example"}}]},"simple_static_route":"example"}]},"performance_enhancement_mode":{"perf_mode_l3_enhanced":{"jumbo":{},"no_jumbo":{}},"perf_mode_l7_enhanced":{}},"sm_connection_public_ip":{},"sm_connection_pvt_ip":{}},"ingress_gw":{"accelerated_networking":null,"az_nodes":[{"azure_az":"example","local_subnet":{"subnet":{"subnet_name":"example","subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}}}],"azure_certified_hw":"example","performance_enhancement_mode":null},"ingress_gw_ar":{"accelerated_networking":{"disable":{},"enable":{}},"azure_certified_hw":"example","node":{"fault_domain":1,"local_subnet":{"subnet":{"subnet_name":"example","subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}},"node_number":1,"update_domain":1},"performance_enhancement_mode":{"perf_mode_l3_enhanced":{"jumbo":{},"no_jumbo":{}},"perf_mode_l7_enhanced":{}}},"kubernetes_upgrade_drain":{"disable_upgrade_drain":{},"enable_upgrade_drain":{"disable_vega_upgrade_mode":{},"drain_max_unavailable_node_count":1,"drain_node_timeout":1,"enable_vega_upgrade_mode":{}}},"log_receiver":{"name":"example","namespace":"example"},"logs_streaming_disabled":{},"machine_type":"","no_worker_nodes":{},"nodes_per_az":1,"offline_survivability_mode":{"enable_offline_survivability_mode":{},"no_offline_survivability_mode":{}},"os":{"default_os_version":{},"operating_system_version":"example"},"resource_group":"example","ssh_key":"example","sw":{"default_sw_version":{},"volterra_software_version":"example"},"tags":{},"total_nodes":1,"vnet":{"existing_vnet":{"f5_orchestrated_routing":{},"manual_routing":{},"resource_group":"example","vnet_name":"example"},"new_vnet":{"autogenerate":{},"name":"example","primary_ipv4":"example"}},"voltstack_cluster":{"accelerated_networking":{"disable":{},"enable":{}},"active_enhanced_firewall_policies":{"enhanced_firewall_policies":[{"name":"example","namespace":"example"}]},"active_forward_proxy_policies":{"forward_proxy_policies":[{"name":"example","namespace":"example"}]},"active_network_policies":{"network_policies":[{"name":"example","namespace":"example"}]},"az_nodes":[{"azure_az":"example","local_subnet":{"subnet":{"subnet_name":"example","subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}}}],"azure_certified_hw":"example","dc_cluster_group":{"name":"example","namespace":"example"},"default_storage":{},"forward_proxy_allow_all":{},"global_network_list":{"global_network_connections":[{"sli_to_global_dr":{"global_vn":{"name":"example","namespace":"example"}},"slo_to_global_dr":{"global_vn":{"name":"example","namespace":"example"}}}]},"k8s_cluster":{"name":"example","namespace":"example"},"no_dc_cluster_group":{},"no_forward_proxy":{},"no_global_network":{},"no_k8s_cluster":{},"no_network_policy":{},"no_outside_static_routes":{},"outside_static_routes":{"static_route_list":[{"custom_static_route":{"attrs":["ROUTE_ATTR_NO_OP"],"labels":{},"nexthop":{"interface":[{"name":"example","namespace":"example"}],"nexthop_address":{"ipv4":{"addr":"example"},"ipv6":{"addr":"example"}},"type":"NEXT_HOP_DEFAULT_GATEWAY"},"subnets":[{"ipv4":{"plen":1,"prefix":"example"},"ipv6":{"plen":1,"prefix":"example"}}]},"simple_static_route":"example"}]},"sm_connection_public_ip":{},"sm_connection_pvt_ip":{},"storage_class_list":{"storage_classes":[{"default_storage_class":true,"storage_class_name":"example"}]}},"voltstack_cluster_ar":{"accelerated_networking":{"disable":{},"enable":{}},"active_enhanced_firewall_policies":{"enhanced_firewall_policies":[{"name":"example","namespace":"example"}]},"active_forward_proxy_policies":{"forward_proxy_policies":[{"name":"example","namespace":"example"}]},"active_network_policies":{"network_policies":[{"name":"example","namespace":"example"}]},"azure_certified_hw":"example","dc_cluster_group":{"name":"example","namespace":"example"},"default_storage":{},"forward_proxy_allow_all":{},"global_network_list":{"global_network_connections":[{"sli_to_global_dr":{"global_vn":{"name":"example","namespace":"example"}},"slo_to_global_dr":{"global_vn":{"name":"example","namespace":"example"}}}]},"k8s_cluster":{"name":"example","namespace":"example"},"no_dc_cluster_group":{},"no_forward_proxy":{},"no_global_network":{},"no_k8s_cluster":{},"no_network_policy":{},"no_outside_static_routes":{},"node":{"fault_domain":1,"local_subnet":{"subnet":{"subnet_name":"example","subnet_resource_grp":"example","vnet_resource_group":{}},"subnet_param":{"ipv4":"example"}},"node_number":1,"update_domain":1},"outside_static_routes":{"static_route_list":[{"custom_static_route":{"attrs":["ROUTE_ATTR_NO_OP"],"labels":{},"nexthop":{"interface":[{"name":"example","namespace":"example"}],"nexthop_address":{"ipv4":{"addr":"example"},"ipv6":{"addr":"example"}},"type":"NEXT_HOP_DEFAULT_GATEWAY"},"subnets":[{"ipv4":{"plen":1,"prefix":"example"},"ipv6":{"plen":1,"prefix":"example"}}]},"simple_static_route":"example"}]},"sm_connection_public_ip":{},"sm_connection_pvt_ip":{},"storage_class_list":{"storage_classes":[{"default_storage_class":true,"storage_class_name":"example"}]}},"disable_encryption":{},"enable_encryption":{"disk_encryption_set_id":"example","resource_group":"example"}}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/azure_vnet_sites \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "metadata": { "annotations": {}, "description": "example", "disable": true, "labels": {}, "name": "example", "namespace": "example" }, "spec": { "address": "example", "admin_password": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "alternate_region": "example", "azure_cred": { "name": "example", "namespace": "example" }, "azure_region": "example", "block_all_services": {}, "blocked_services": { "blocked_sevice": [ { "dns": {}, "network_type": "VIRTUAL_NETWORK_SITE_LOCAL", "ssh": {}, "web_user_interface": {} } ] }, "coordinates": { "latitude": 1, "longitude": 1 }, "custom_dns": { "inside_nameserver": "example", "outside_nameserver": "example" }, "default_blocked_services": {}, "disk_size": 0, "ingress_egress_gw": { "accelerated_networking": { "disable": {}, "enable": {} }, "active_enhanced_firewall_policies": { "enhanced_firewall_policies": [ { "name": "example", "namespace": "example" } ] }, "active_forward_proxy_policies": { "forward_proxy_policies": [ { "name": "example", "namespace": "example" } ] }, "active_network_policies": { "network_policies": [ { "name": "example", "namespace": "example" } ] }, "az_nodes": [ { "azure_az": "example", "inside_subnet": { "subnet": { "subnet_name": "example", "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } }, "outside_subnet": { "subnet": { "subnet_name": "example", "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } } } ], "azure_certified_hw": "example", "dc_cluster_group_inside_vn": { "name": "example", "namespace": "example" }, "dc_cluster_group_outside_vn": { "name": "example", "namespace": "example" }, "forward_proxy_allow_all": {}, "global_network_list": { "global_network_connections": [ { "sli_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } }, "slo_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } } } ] }, "hub": { "express_route_disabled": {}, "express_route_enabled": { "advertise_to_route_server": {}, "auto_asn": {}, "connections": [ { "circuit_id": "example", "metadata": { "description": "example", "name": "example" }, "other_subscription": { "authorized_key": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "circuit_id": "example" }, "weight": 1 } ], "custom_asn": 1, "do_not_advertise_to_route_server": {}, "gateway_subnet": { "auto": {}, "subnet": { "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } }, "route_server_subnet": { "auto": {}, "subnet": { "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } }, "site_registration_over_express_route": { "cloudlink_network_name": "example" }, "site_registration_over_internet": {}, "sku_ergw1az": {}, "sku_ergw2az": {}, "sku_high_perf": {}, "sku_standard": {} }, "spoke_vnets": [ { "auto": {}, "labels": {}, "manual": {}, "vnet": { "f5_orchestrated_routing": {}, "manual_routing": {}, "resource_group": "example", "vnet_name": "example" } } ] }, "inside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] }, "simple_static_route": "example" } ] }, "no_dc_cluster_group": {}, "no_forward_proxy": {}, "no_global_network": {}, "no_inside_static_routes": {}, "no_network_policy": {}, "no_outside_static_routes": {}, "not_hub": {}, "outside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] }, "simple_static_route": "example" } ] }, "performance_enhancement_mode": { "perf_mode_l3_enhanced": { "jumbo": {}, "no_jumbo": {} }, "perf_mode_l7_enhanced": {} }, "sm_connection_public_ip": {}, "sm_connection_pvt_ip": {} }, "ingress_egress_gw_ar": { "accelerated_networking": { "disable": {}, "enable": {} }, "active_enhanced_firewall_policies": { "enhanced_firewall_policies": [ { "name": "example", "namespace": "example" } ] }, "active_forward_proxy_policies": { "forward_proxy_policies": [ { "name": "example", "namespace": "example" } ] }, "active_network_policies": { "network_policies": [ { "name": "example", "namespace": "example" } ] }, "azure_certified_hw": "example", "dc_cluster_group_inside_vn": { "name": "example", "namespace": "example" }, "dc_cluster_group_outside_vn": { "name": "example", "namespace": "example" }, "forward_proxy_allow_all": {}, "global_network_list": { "global_network_connections": [ { "sli_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } }, "slo_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } } } ] }, "hub": { "express_route_disabled": {}, "express_route_enabled": { "advertise_to_route_server": {}, "auto_asn": {}, "connections": [ { "circuit_id": "example", "metadata": { "description": "example", "name": "example" }, "other_subscription": { "authorized_key": { "blindfold_secret_info": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "clear_secret_info": { "provider": "example", "url": "https://example.com" }, "blindfold_secret_info_internal": { "decryption_provider": "example", "location": "example", "store_provider": "example" }, "secret_encoding_type": "EncodingNone", "vault_secret_info": { "key": "example", "location": "example", "provider": "example", "secret_encoding": "EncodingNone", "version": 1 }, "wingman_secret_info": { "name": "example" } }, "circuit_id": "example" }, "weight": 1 } ], "custom_asn": 1, "do_not_advertise_to_route_server": {}, "gateway_subnet": { "auto": {}, "subnet": { "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } }, "route_server_subnet": { "auto": {}, "subnet": { "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } }, "site_registration_over_express_route": { "cloudlink_network_name": "example" }, "site_registration_over_internet": {}, "sku_ergw1az": {}, "sku_ergw2az": {}, "sku_high_perf": {}, "sku_standard": {} }, "spoke_vnets": [ { "auto": {}, "labels": {}, "manual": {}, "vnet": { "f5_orchestrated_routing": {}, "manual_routing": {}, "resource_group": "example", "vnet_name": "example" } } ] }, "inside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] }, "simple_static_route": "example" } ] }, "no_dc_cluster_group": {}, "no_forward_proxy": {}, "no_global_network": {}, "no_inside_static_routes": {}, "no_network_policy": {}, "no_outside_static_routes": {}, "node": { "fault_domain": 1, "inside_subnet": { "subnet": { "subnet_name": "example", "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } }, "node_number": 1, "outside_subnet": { "subnet": { "subnet_name": "example", "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } }, "update_domain": 1 }, "not_hub": {}, "outside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] }, "simple_static_route": "example" } ] }, "performance_enhancement_mode": { "perf_mode_l3_enhanced": { "jumbo": {}, "no_jumbo": {} }, "perf_mode_l7_enhanced": {} }, "sm_connection_public_ip": {}, "sm_connection_pvt_ip": {} }, "ingress_gw": { "accelerated_networking": null, "az_nodes": [ { "azure_az": "example", "local_subnet": { "subnet": { "subnet_name": "example", "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } } } ], "azure_certified_hw": "example", "performance_enhancement_mode": null }, "ingress_gw_ar": { "accelerated_networking": { "disable": {}, "enable": {} }, "azure_certified_hw": "example", "node": { "fault_domain": 1, "local_subnet": { "subnet": { "subnet_name": "example", "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } }, "node_number": 1, "update_domain": 1 }, "performance_enhancement_mode": { "perf_mode_l3_enhanced": { "jumbo": {}, "no_jumbo": {} }, "perf_mode_l7_enhanced": {} } }, "kubernetes_upgrade_drain": { "disable_upgrade_drain": {}, "enable_upgrade_drain": { "disable_vega_upgrade_mode": {}, "drain_max_unavailable_node_count": 1, "drain_node_timeout": 1, "enable_vega_upgrade_mode": {} } }, "log_receiver": { "name": "example", "namespace": "example" }, "logs_streaming_disabled": {}, "machine_type": "", "no_worker_nodes": {}, "nodes_per_az": 1, "offline_survivability_mode": { "enable_offline_survivability_mode": {}, "no_offline_survivability_mode": {} }, "os": { "default_os_version": {}, "operating_system_version": "example" }, "resource_group": "example", "ssh_key": "example", "sw": { "default_sw_version": {}, "volterra_software_version": "example" }, "tags": {}, "total_nodes": 1, "vnet": { "existing_vnet": { "f5_orchestrated_routing": {}, "manual_routing": {}, "resource_group": "example", "vnet_name": "example" }, "new_vnet": { "autogenerate": {}, "name": "example", "primary_ipv4": "example" } }, "voltstack_cluster": { "accelerated_networking": { "disable": {}, "enable": {} }, "active_enhanced_firewall_policies": { "enhanced_firewall_policies": [ { "name": "example", "namespace": "example" } ] }, "active_forward_proxy_policies": { "forward_proxy_policies": [ { "name": "example", "namespace": "example" } ] }, "active_network_policies": { "network_policies": [ { "name": "example", "namespace": "example" } ] }, "az_nodes": [ { "azure_az": "example", "local_subnet": { "subnet": { "subnet_name": "example", "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } } } ], "azure_certified_hw": "example", "dc_cluster_group": { "name": "example", "namespace": "example" }, "default_storage": {}, "forward_proxy_allow_all": {}, "global_network_list": { "global_network_connections": [ { "sli_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } }, "slo_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } } } ] }, "k8s_cluster": { "name": "example", "namespace": "example" }, "no_dc_cluster_group": {}, "no_forward_proxy": {}, "no_global_network": {}, "no_k8s_cluster": {}, "no_network_policy": {}, "no_outside_static_routes": {}, "outside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] }, "simple_static_route": "example" } ] }, "sm_connection_public_ip": {}, "sm_connection_pvt_ip": {}, "storage_class_list": { "storage_classes": [ { "default_storage_class": true, "storage_class_name": "example" } ] } }, "voltstack_cluster_ar": { "accelerated_networking": { "disable": {}, "enable": {} }, "active_enhanced_firewall_policies": { "enhanced_firewall_policies": [ { "name": "example", "namespace": "example" } ] }, "active_forward_proxy_policies": { "forward_proxy_policies": [ { "name": "example", "namespace": "example" } ] }, "active_network_policies": { "network_policies": [ { "name": "example", "namespace": "example" } ] }, "azure_certified_hw": "example", "dc_cluster_group": { "name": "example", "namespace": "example" }, "default_storage": {}, "forward_proxy_allow_all": {}, "global_network_list": { "global_network_connections": [ { "sli_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } }, "slo_to_global_dr": { "global_vn": { "name": "example", "namespace": "example" } } } ] }, "k8s_cluster": { "name": "example", "namespace": "example" }, "no_dc_cluster_group": {}, "no_forward_proxy": {}, "no_global_network": {}, "no_k8s_cluster": {}, "no_network_policy": {}, "no_outside_static_routes": {}, "node": { "fault_domain": 1, "local_subnet": { "subnet": { "subnet_name": "example", "subnet_resource_grp": "example", "vnet_resource_group": {} }, "subnet_param": { "ipv4": "example" } }, "node_number": 1, "update_domain": 1 }, "outside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "labels": {}, "nexthop": { "interface": [ { "name": "example", "namespace": "example" } ], "nexthop_address": { "ipv4": { "addr": "example" }, "ipv6": { "addr": "example" } }, "type": "NEXT_HOP_DEFAULT_GATEWAY" }, "subnets": [ { "ipv4": { "plen": 1, "prefix": "example" }, "ipv6": { "plen": 1, "prefix": "example" } } ] }, "simple_static_route": "example" } ] }, "sm_connection_public_ip": {}, "sm_connection_pvt_ip": {}, "storage_class_list": { "storage_classes": [ { "default_storage_class": true, "storage_class_name": "example" } ] } }, "disable_encryption": {}, "enable_encryption": { "disk_encryption_set_id": "example", "resource_group": "example" } } }'Shape of the Azure VNet site specification.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Namespace This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""
Request Bodyrequired
Section titled “Request Bodyrequired”This is the input message of the ‘Create’ RPC.
object
object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
object
Human readable description for the object.
A value of true will administratively disable the object.
Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.
object
This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.
This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""
object
Site’s geographical address that can be used to determine its latitude and longitude.
object
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
Exclusive with [azure_region] Name of the Azure region which does not support availability zones.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Exclusive with [alternate_region] Name of the Azure region which supports availability zones.
object
object
Blocking or denial configuration
Disable a node local service on this site.
object
object
object
object
object
Latitude of the site location.
Longitude of site location.
object
Optional DNS server IP to be used for name resolution in inside network.
Optional DNS server IP to be used for name resolution in outside network.
object
Disk size to be used for this instance in GiB. 80 is 80 GiB.
object
object
object
object
object
Ordered List of Enhanced Firewall Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Forward Proxy Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Firewall Policies active for this network firewall
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Only Single AZ or Three AZ(s) nodes are supported currently.
Required: YES.
Parameters for creating two interface Node in one AZ.
object
A zone depicting a grouping of datacenters within an Azure region. Expecting numeric input Required: YES.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Name for Azure certified hardware. Required: YES.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
Global network connections
Required: YES.
Global network connection.
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
object
object
Add the ExpressRoute Circuit Connections to this site
Required: YES.
Express Route Connection Configuration.
object
Exclusive with [other_subscription] ExpressRoute Circuit is in same subscription as the site.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.
object
object
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
Circuit ID.
The weight (or priority) for the routes received from this connection. The default value is 10.
Exclusive with [auto_asn] Set custom ASN for F5XC Site.
object
object
object
object
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
object
object
object
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
object
Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support. Required: YES.
object
object
object
object
object
Spoke VNet Peering.
VNet peering to Azure VNet site.
object
object
Add Labels for each of the VNets peered with transit VNet, these labels can be used in firewall policy These labels used must be from known key and label defined in shared namespace.
object
object
object
object
object
Resource group of existing VNet Required: YES.
Name of existing VNet Required: YES.
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
object
object
object
object
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
object
object
object
object
object
object
object
object
object
Ordered List of Enhanced Firewall Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Forward Proxy Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Firewall Policies active for this network firewall
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Name for Azure certified hardware. Required: YES.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
Global network connections
Required: YES.
Global network connection.
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
object
object
Add the ExpressRoute Circuit Connections to this site
Required: YES.
Express Route Connection Configuration.
object
Exclusive with [other_subscription] ExpressRoute Circuit is in same subscription as the site.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.
object
object
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
Circuit ID.
The weight (or priority) for the routes received from this connection. The default value is 10.
Exclusive with [auto_asn] Set custom ASN for F5XC Site.
object
object
object
object
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
object
object
object
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
object
Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support. Required: YES.
object
object
object
object
object
Spoke VNet Peering.
VNet peering to Azure VNet site.
object
object
Add Labels for each of the VNets peered with transit VNet, these labels can be used in firewall policy These labels used must be from known key and label defined in shared namespace.
object
object
object
object
object
Resource group of existing VNet Required: YES.
Name of existing VNet Required: YES.
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
object
object
object
object
Namuber of fault domains to be used while creating the availability set.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Number of main nodes to create, either 1 or 3. Required: YES.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Namuber of update domains to be used while creating the availability set.
object
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
object
object
object
object
object
object
object
object
Only Single AZ or Three AZ(s) nodes are supported currently.
Required: YES.
Parameters for creating Single interface Node in one AZ.
object
A zone depicting a grouping of datacenters within an Azure region. Expecting numeric input Required: YES.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Name for Azure certified hardware. Required: YES.
object
object
object
object
object
object
object
object
object
Name for Azure certified hardware. Required: YES.
object
Namuber of fault domains to be used while creating the availability set.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Number of main nodes to create, either 1 or 3. Required: YES.
Namuber of update domains to be used while creating the availability set.
object
object
object
object
object
object
object
object
object
Exclusive with []
Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes. (Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is recommended to use the default value).
Required: YES.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Select Instance size based on performance needed. The default setting for Accelerated Networking is enabled, thus make sure you select a Virtual Machine that supports accelerated networking or disable the setting under, Select Ingress Gateway or Ingress/Egress Gateway
advanced OPTIONS. Required: YES.
object
Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.
object
object
object
object
object
Exclusive with [default_os_version] Specify a OS version to be used e.g. 9.2024.6.
Azure resource group for resources that will be created Required: YES.
Public SSH key for accessing the site. Required: YES.
object
object
Exclusive with [default_sw_version] Specify a F5XC Software Version to be used e.g. Crt-20210329-1002.
Azure Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in Azure console.
object
Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ’s used in the Site.
object
object
object
object
Resource group of existing VNet Required: YES.
Name of existing VNet Required: YES.
object
object
Exclusive with [autogenerate] Specify the VNet Name.
IPv4 CIDR block for this VNet. It has to be private address space. Required: YES.
object
object
object
object
object
Ordered List of Enhanced Firewall Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Forward Proxy Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Firewall Policies active for this network firewall
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Only Single AZ or Three AZ(s) nodes are supported currently.
Required: YES.
Parameters for creating Single interface Node in one AZ.
object
A zone depicting a grouping of datacenters within an Azure region. Expecting numeric input Required: YES.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Name for Azure certified hardware. Required: YES.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
Global network connections
Required: YES.
Global network connection.
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
object
object
object
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
List of custom storage classes.
Configuration of custom storage class.
object
Make this storage class default storage class for the K8s cluster.
Name of the storage class as it will appear in K8s. Required: YES.
object
object
object
object
object
Ordered List of Enhanced Firewall Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Forward Proxy Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Firewall Policies active for this network firewall
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Name for Azure certified hardware. Required: YES.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
Global network connections
Required: YES.
Global network connection.
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
object
object
object
object
Namuber of fault domains to be used while creating the availability set.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Number of main nodes to create, either 1 or 3. Required: YES.
Namuber of update domains to be used while creating the availability set.
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
List of custom storage classes.
Configuration of custom storage class.
object
Make this storage class default storage class for the K8s cluster.
Name of the storage class as it will appear in K8s. Required: YES.
object
object
Azure Disk Encryption Set to be used to encrypt the disk attached to the VM
Required: YES.
The resource group in which the Disk Encryption Set is present
Required: YES.
Responses
Section titled “Responses”A successful response.
object
object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
object
Human readable description for the object.
A value of true will administratively disable the object.
Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.
object
This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.
This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""
object
Site’s geographical address that can be used to determine its latitude and longitude.
object
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
Exclusive with [azure_region] Name of the Azure region which does not support availability zones.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Exclusive with [alternate_region] Name of the Azure region which supports availability zones.
object
object
Blocking or denial configuration
Disable a node local service on this site.
object
object
object
object
object
object
Route Server ASN.
Route Server IPs.
Azure Node Name.
Node Instance Name.
object
Node ID Information Required: YES.
Node Instance Name used by dataplane.
Azure VM Private IPs used by the nodes Required: YES.
Azure VM Public IPs used by the nodes Required: YES.
Azure Spoke VNet Prefix Information.
Azure VNet IP prefixes Info.
object
An unordered list of IP prefixes. Required: YES.
object
object
object
Resource group of existing VNet Required: YES.
Name of existing VNet Required: YES.
object
VNet Resource ID.
VNet Name
object
Latitude of the site location.
Longitude of site location.
object
Optional DNS server IP to be used for name resolution in inside network.
Optional DNS server IP to be used for name resolution in outside network.
object
Disk size to be used for this instance in GiB. 80 is 80 GiB.
Description of error on site.
object
object
object
object
object
Ordered List of Enhanced Firewall Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Forward Proxy Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Firewall Policies active for this network firewall
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Only Single AZ or Three AZ(s) nodes are supported currently.
Required: YES.
Parameters for creating two interface Node in one AZ.
object
A zone depicting a grouping of datacenters within an Azure region. Expecting numeric input Required: YES.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Name for Azure certified hardware. Required: YES.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
Global network connections
Required: YES.
Global network connection.
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
object
object
Add the ExpressRoute Circuit Connections to this site
Required: YES.
Express Route Connection Configuration.
object
Exclusive with [other_subscription] ExpressRoute Circuit is in same subscription as the site.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.
object
object
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
Circuit ID.
The weight (or priority) for the routes received from this connection. The default value is 10.
Exclusive with [auto_asn] Set custom ASN for F5XC Site.
object
object
object
object
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
object
object
object
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
object
Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support. Required: YES.
object
object
object
object
object
Spoke VNet Peering.
VNet peering to Azure VNet site.
object
object
Add Labels for each of the VNets peered with transit VNet, these labels can be used in firewall policy These labels used must be from known key and label defined in shared namespace.
object
object
object
object
object
Resource group of existing VNet Required: YES.
Name of existing VNet Required: YES.
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
object
object
object
object
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
object
object
object
object
object
object
object
object
object
Ordered List of Enhanced Firewall Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Forward Proxy Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Firewall Policies active for this network firewall
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Name for Azure certified hardware. Required: YES.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
Global network connections
Required: YES.
Global network connection.
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
object
object
Add the ExpressRoute Circuit Connections to this site
Required: YES.
Express Route Connection Configuration.
object
Exclusive with [other_subscription] ExpressRoute Circuit is in same subscription as the site.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.
object
object
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.
object
Name of the Secret Management Access object that contains information about the backend Secret Management service.
Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.
Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.
object
X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.
X-displayName: “Location” x-required Path to secret in Vault.
X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.
X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.
object
X-displayName: “Name” x-required Name of the secret.
Circuit ID.
The weight (or priority) for the routes received from this connection. The default value is 10.
Exclusive with [auto_asn] Set custom ASN for F5XC Site.
object
object
object
object
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
object
object
object
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
object
Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support. Required: YES.
object
object
object
object
object
Spoke VNet Peering.
VNet peering to Azure VNet site.
object
object
Add Labels for each of the VNets peered with transit VNet, these labels can be used in firewall policy These labels used must be from known key and label defined in shared namespace.
object
object
object
object
object
Resource group of existing VNet Required: YES.
Name of existing VNet Required: YES.
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
object
object
object
object
Namuber of fault domains to be used while creating the availability set.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Number of main nodes to create, either 1 or 3. Required: YES.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Namuber of update domains to be used while creating the availability set.
object
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
object
object
object
object
object
object
object
object
Only Single AZ or Three AZ(s) nodes are supported currently.
Required: YES.
Parameters for creating Single interface Node in one AZ.
object
A zone depicting a grouping of datacenters within an Azure region. Expecting numeric input Required: YES.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Name for Azure certified hardware. Required: YES.
object
object
object
object
object
object
object
object
object
Name for Azure certified hardware. Required: YES.
object
Namuber of fault domains to be used while creating the availability set.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Number of main nodes to create, either 1 or 3. Required: YES.
Namuber of update domains to be used while creating the availability set.
object
object
object
object
object
object
object
object
object
Exclusive with []
Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes. (Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is recommended to use the default value).
Required: YES.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Select Instance size based on performance needed. The default setting for Accelerated Networking is enabled, thus make sure you select a Virtual Machine that supports accelerated networking or disable the setting under, Select Ingress Gateway or Ingress/Egress Gateway
advanced OPTIONS. Required: YES.
object
Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.
object
object
object
Azure resource group for resources that will be created Required: YES.
Errors on site including suggested action.
Site Error.
object
Error Description.
Suggested Action.
Public SSH key for accessing the site. Required: YES.
Suggested action for customer on error.
Azure Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in Azure console.
object
Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ’s used in the Site.
object
object
object
object
Resource group of existing VNet Required: YES.
Name of existing VNet Required: YES.
object
object
Exclusive with [autogenerate] Specify the VNet Name.
IPv4 CIDR block for this VNet. It has to be private address space. Required: YES.
object
object
object
object
object
Ordered List of Enhanced Firewall Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Forward Proxy Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Firewall Policies active for this network firewall
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Only Single AZ or Three AZ(s) nodes are supported currently.
Required: YES.
Parameters for creating Single interface Node in one AZ.
object
A zone depicting a grouping of datacenters within an Azure region. Expecting numeric input Required: YES.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Name for Azure certified hardware. Required: YES.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
Global network connections
Required: YES.
Global network connection.
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
object
object
object
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
List of custom storage classes.
Configuration of custom storage class.
object
Make this storage class default storage class for the K8s cluster.
Name of the storage class as it will appear in K8s. Required: YES.
object
object
object
object
object
Ordered List of Enhanced Firewall Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Forward Proxy Policies active
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
Ordered List of Firewall Policies active for this network firewall
Required: YES.
This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
Name for Azure certified hardware. Required: YES.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
Global network connections
Required: YES.
Global network connection.
object
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
object
object
object
object
object
object
object
Namuber of fault domains to be used while creating the availability set.
object
object
Name of existing subnet. Required: YES.
Exclusive with [vnet_resource_group] Specify name of Resource Group.
object
object
IPv4 subnet prefix for this subnet Required: YES.
Number of main nodes to create, either 1 or 3. Required: YES.
Namuber of update domains to be used while creating the availability set.
object
List of Static routes
Required: YES.
Different ways to configure static routes.
object
object
List of route attributes associated with the static route.
Add Labels for this Static Route, these labels can be used in network policy.
object
object
Nexthop is network interface when type is “Network-Interface”
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
IPv4 Address in string form with dot-decimal notation.
object
IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’
List of route prefixes
Required: YES.
IP Address used to specify an IPv4 or IPv6 subnet addresses.
object
object
Prefix-length of the IPv4 subnet. Must be <= 32.
Prefix part of the IPv4 subnet in string form with dot-decimal notation.
object
Prefix length of the IPv6 subnet. Must be <= 128.
Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”
Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.
object
object
object
List of custom storage classes.
Configuration of custom storage class.
object
Make this storage class default storage class for the K8s cluster.
Name of the storage class as it will appear in K8s. Required: YES.
object
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
A value identifying the class of the user or service which created this configuration object.
A value identifying the exact user or service that created this configuration object.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only.
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
object
Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
Initializer is information about an initializer that has not yet completed.
object
Name of the service that is responsible for initializing this object.
object
Suggested HTTP return code for this status, 0 if not set.
A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.
Status of the operation. One of: “Success” or “Failure”.
Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).
object
ModificationTimestamp is a timestamp representing the server time when this object was last modified.
Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.
object
Kind of the view object.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
UID of the view object.
Tenant to which this configuration object belongs to. The value for this is found from presented credentials.
Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.
Example
{ "spec": { "admin_password": { "secret_encoding_type": "EncodingNone", "vault_secret_info": { "secret_encoding": "EncodingNone" } }, "block_all_services": {}, "blocked_services": { "blocked_sevice": [ { "network_type": "VIRTUAL_NETWORK_SITE_LOCAL" } ] }, "disk_size": 0, "ingress_egress_gw": { "hub": { "express_route_enabled": { "connections": [ { "other_subscription": { "authorized_key": { "secret_encoding_type": "EncodingNone", "vault_secret_info": { "secret_encoding": "EncodingNone" } } } } ] } }, "inside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "nexthop": { "type": "NEXT_HOP_DEFAULT_GATEWAY" } } } ] }, "outside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "nexthop": { "type": "NEXT_HOP_DEFAULT_GATEWAY" } } } ] } }, "ingress_egress_gw_ar": { "hub": { "express_route_enabled": { "connections": [ { "other_subscription": { "authorized_key": { "secret_encoding_type": "EncodingNone", "vault_secret_info": { "secret_encoding": "EncodingNone" } } } } ] } }, "inside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "nexthop": { "type": "NEXT_HOP_DEFAULT_GATEWAY" } } } ] }, "outside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "nexthop": { "type": "NEXT_HOP_DEFAULT_GATEWAY" } } } ] } }, "ingress_gw": { "accelerated_networking": null, "performance_enhancement_mode": null }, "logs_streaming_disabled": {}, "machine_type": "", "no_worker_nodes": {}, "site_state": "ONLINE", "tags": {}, "validation_state": "VALIDATION_STATE_NONE", "voltstack_cluster": { "outside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "nexthop": { "type": "NEXT_HOP_DEFAULT_GATEWAY" } } } ] } }, "voltstack_cluster_ar": { "outside_static_routes": { "static_route_list": [ { "custom_static_route": { "attrs": [ "ROUTE_ATTR_NO_OP" ], "nexthop": { "type": "NEXT_HOP_DEFAULT_GATEWAY" } } } ] } } }}Returned when operation is not authorized.
Examplegenerated
exampleReturned when there is no permission to access resource.
Examplegenerated
exampleReturned when resource is not found.
Examplegenerated
exampleReturned when operation on resource is conflicting with current value.
Examplegenerated
exampleReturned when operation has been rejected as it is happening too frequently.
Examplegenerated
exampleReturned when server encountered an error in processing API.
Examplegenerated
exampleReturned when service is unavailable temporarily.
Examplegenerated
exampleReturned when server timed out processing request.
Examplegenerated
example