|
| 1 | +{ |
| 2 | + "swagger": "2.0", |
| 3 | + "info": { |
| 4 | + "title": "HybridNetworkManagementClient", |
| 5 | + "description": "The definitions in this swagger specification will be used to manage the Hybrid Network resources.", |
| 6 | + "version": "2021-05-01" |
| 7 | + }, |
| 8 | + "host": "management.azure.com", |
| 9 | + "schemes": [ |
| 10 | + "https" |
| 11 | + ], |
| 12 | + "consumes": [ |
| 13 | + "application/json" |
| 14 | + ], |
| 15 | + "produces": [ |
| 16 | + "application/json" |
| 17 | + ], |
| 18 | + "security": [ |
| 19 | + { |
| 20 | + "azure_auth": [ |
| 21 | + "user_impersonation" |
| 22 | + ] |
| 23 | + } |
| 24 | + ], |
| 25 | + "securityDefinitions": { |
| 26 | + "azure_auth": { |
| 27 | + "type": "oauth2", |
| 28 | + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", |
| 29 | + "flow": "implicit", |
| 30 | + "description": "Azure Active Directory OAuth2 Flow.", |
| 31 | + "scopes": { |
| 32 | + "user_impersonation": "impersonate your user account" |
| 33 | + } |
| 34 | + } |
| 35 | + }, |
| 36 | + "paths": {}, |
| 37 | + "definitions": { |
| 38 | + "SubResource": { |
| 39 | + "properties": { |
| 40 | + "id": { |
| 41 | + "type": "string", |
| 42 | + "description": "Resource ID." |
| 43 | + } |
| 44 | + }, |
| 45 | + "description": "Reference to another sub resource.", |
| 46 | + "x-ms-azure-resource": true |
| 47 | + }, |
| 48 | + "ProvisioningState": { |
| 49 | + "type": "string", |
| 50 | + "readOnly": true, |
| 51 | + "description": "The current provisioning state.", |
| 52 | + "enum": [ |
| 53 | + "Unknown", |
| 54 | + "Succeeded", |
| 55 | + "Accepted", |
| 56 | + "Deleting", |
| 57 | + "Failed", |
| 58 | + "Canceled", |
| 59 | + "Deleted" |
| 60 | + ], |
| 61 | + "x-ms-enum": { |
| 62 | + "name": "ProvisioningState", |
| 63 | + "modelAsString": true |
| 64 | + } |
| 65 | + }, |
| 66 | + "VendorProvisioningState": { |
| 67 | + "type": "string", |
| 68 | + "description": "The current vendor provisioning state.", |
| 69 | + "enum": [ |
| 70 | + "Unknown", |
| 71 | + "NotProvisioned", |
| 72 | + "Provisioning", |
| 73 | + "Provisioned", |
| 74 | + "Deprovisioned", |
| 75 | + "UserDataValidationFailed" |
| 76 | + ], |
| 77 | + "x-ms-enum": { |
| 78 | + "name": "VendorProvisioningState", |
| 79 | + "modelAsString": true |
| 80 | + } |
| 81 | + }, |
| 82 | + "TagsObject": { |
| 83 | + "properties": { |
| 84 | + "tags": { |
| 85 | + "type": "object", |
| 86 | + "additionalProperties": { |
| 87 | + "type": "string" |
| 88 | + }, |
| 89 | + "description": "Resource tags." |
| 90 | + } |
| 91 | + }, |
| 92 | + "description": "Tags object for patch operations." |
| 93 | + }, |
| 94 | + "NetworkInterface": { |
| 95 | + "description": "Network interface properties.", |
| 96 | + "properties": { |
| 97 | + "networkInterfaceName": { |
| 98 | + "type": "string", |
| 99 | + "description": "The name of the network interface." |
| 100 | + }, |
| 101 | + "macAddress": { |
| 102 | + "type": "string", |
| 103 | + "description": "The MAC address of the network interface." |
| 104 | + }, |
| 105 | + "ipConfigurations": { |
| 106 | + "type": "array", |
| 107 | + "items": { |
| 108 | + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" |
| 109 | + }, |
| 110 | + "description": "A list of IP configurations of the network interface." |
| 111 | + }, |
| 112 | + "vmSwitchType": { |
| 113 | + "type": "string", |
| 114 | + "description": "The type of the VM switch.", |
| 115 | + "enum": [ |
| 116 | + "Unknown", |
| 117 | + "Management", |
| 118 | + "Wan", |
| 119 | + "Lan" |
| 120 | + ], |
| 121 | + "x-ms-enum": { |
| 122 | + "name": "VMSwitchType", |
| 123 | + "modelAsString": true |
| 124 | + } |
| 125 | + } |
| 126 | + } |
| 127 | + }, |
| 128 | + "NetworkInterfaceIPConfiguration": { |
| 129 | + "description": "Network interface IP configuration properties.", |
| 130 | + "properties": { |
| 131 | + "ipAllocationMethod": { |
| 132 | + "type": "string", |
| 133 | + "description": "IP address allocation method.", |
| 134 | + "enum": [ |
| 135 | + "Unknown", |
| 136 | + "Static", |
| 137 | + "Dynamic" |
| 138 | + ], |
| 139 | + "x-ms-enum": { |
| 140 | + "name": "IPAllocationMethod", |
| 141 | + "modelAsString": true |
| 142 | + } |
| 143 | + }, |
| 144 | + "ipAddress": { |
| 145 | + "type": "string", |
| 146 | + "description": "The value of the IP address." |
| 147 | + }, |
| 148 | + "subnet": { |
| 149 | + "type": "string", |
| 150 | + "description": "The value of the subnet." |
| 151 | + }, |
| 152 | + "gateway": { |
| 153 | + "type": "string", |
| 154 | + "description": "The value of the gateway." |
| 155 | + }, |
| 156 | + "ipVersion": { |
| 157 | + "type": "string", |
| 158 | + "description": "IP address version.", |
| 159 | + "enum": [ |
| 160 | + "Unknown", |
| 161 | + "IPv4" |
| 162 | + ], |
| 163 | + "x-ms-enum": { |
| 164 | + "name": "IPVersion", |
| 165 | + "modelAsString": true |
| 166 | + } |
| 167 | + }, |
| 168 | + "dnsServers": { |
| 169 | + "type": "array", |
| 170 | + "description": "The list of DNS servers IP addresses.", |
| 171 | + "items": { |
| 172 | + "type": "string" |
| 173 | + } |
| 174 | + } |
| 175 | + } |
| 176 | + }, |
| 177 | + "UserDataTemplate": { |
| 178 | + "type": "object", |
| 179 | + "description": "The user data template." |
| 180 | + }, |
| 181 | + "UserDataParameters": { |
| 182 | + "type": "object", |
| 183 | + "description": "The user data parameters." |
| 184 | + }, |
| 185 | + "ManagedApplicationParameters": { |
| 186 | + "type": "object", |
| 187 | + "description": "The parameters for the managed application." |
| 188 | + }, |
| 189 | + "SkuType": { |
| 190 | + "type": "string", |
| 191 | + "description": "Sku type.", |
| 192 | + "enum": [ |
| 193 | + "Unknown", |
| 194 | + "EvolvedPacketCore", |
| 195 | + "SDWAN", |
| 196 | + "Firewall" |
| 197 | + ], |
| 198 | + "x-ms-enum": { |
| 199 | + "name": "SkuType", |
| 200 | + "modelAsString": true |
| 201 | + } |
| 202 | + }, |
| 203 | + "OsProfile": { |
| 204 | + "properties": { |
| 205 | + "adminUsername": { |
| 206 | + "type": "string", |
| 207 | + "description": "Specifies the name of the administrator account. <br><br> **Windows-only restriction:** Cannot end in \".\" <br><br> **Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\". <br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length (Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters <br><br><li> For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)<br><li> For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." |
| 208 | + }, |
| 209 | + "linuxConfiguration": { |
| 210 | + "$ref": "#/definitions/LinuxConfiguration", |
| 211 | + "description": "Specifies the Linux operating system settings on the virtual machine. <br><br>For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) <br><br> For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." |
| 212 | + }, |
| 213 | + "customData": { |
| 214 | + "type": "string", |
| 215 | + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes. <br><br> **Note: Do not pass any secrets or passwords in customData property** <br><br> This property cannot be updated after the VM is created. <br><br> customData is passed to the VM to be saved as a file. For more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/) <br><br> For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" |
| 216 | + }, |
| 217 | + "customDataRequired": { |
| 218 | + "type": "boolean", |
| 219 | + "default": true, |
| 220 | + "description": "Indicates if custom data is required to deploy this role." |
| 221 | + } |
| 222 | + }, |
| 223 | + "description": "Specifies the operating system settings for the role instance." |
| 224 | + }, |
| 225 | + "LinuxConfiguration": { |
| 226 | + "properties": { |
| 227 | + "ssh": { |
| 228 | + "$ref": "#/definitions/SshConfiguration", |
| 229 | + "description": "Specifies the ssh key configuration for a Linux OS." |
| 230 | + } |
| 231 | + }, |
| 232 | + "description": "Specifies the Linux operating system settings on the virtual machine." |
| 233 | + }, |
| 234 | + "SshConfiguration": { |
| 235 | + "properties": { |
| 236 | + "publicKeys": { |
| 237 | + "type": "array", |
| 238 | + "items": { |
| 239 | + "$ref": "#/definitions/SshPublicKey" |
| 240 | + }, |
| 241 | + "description": "The list of SSH public keys used to authenticate with linux based VMs." |
| 242 | + } |
| 243 | + }, |
| 244 | + "description": "SSH configuration for Linux based VMs running on Azure" |
| 245 | + }, |
| 246 | + "SshPublicKey": { |
| 247 | + "properties": { |
| 248 | + "path": { |
| 249 | + "type": "string", |
| 250 | + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" |
| 251 | + }, |
| 252 | + "keyData": { |
| 253 | + "type": "string", |
| 254 | + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." |
| 255 | + } |
| 256 | + }, |
| 257 | + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." |
| 258 | + } |
| 259 | + } |
| 260 | +} |
0 commit comments