Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Network: fix descriptions & remove unused/duplicate definitions #5243

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1463,7 +1463,7 @@
"timeout": {
"type": "integer",
"format": "int32",
"description": "the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds."
"description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds."
},
"unhealthyThreshold": {
"type": "integer",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@
},
"provisioningState":{
"description":"The provisioning state of the resource.",
"$ref":"#/definitions/ProvisioningState"
"$ref":"./network.json#/definitions/ProvisioningState"
anton-evseev marked this conversation as resolved.
Show resolved Hide resolved
}
},
"description":"Properties of IP configuration of an Azure Firewall."
Expand Down Expand Up @@ -334,7 +334,7 @@
},
"provisioningState":{
"description":"The provisioning state of the resource.",
"$ref":"#/definitions/ProvisioningState"
"$ref":"./network.json#/definitions/ProvisioningState"
},
"threatIntelMode":{
"description":"The operation mode for Threat Intelligence.",
Expand Down Expand Up @@ -415,7 +415,7 @@
},
"provisioningState":{
"description":"The provisioning state of the resource.",
"$ref":"#/definitions/ProvisioningState"
"$ref":"./network.json#/definitions/ProvisioningState"
}
},
"description":"Properties of the application rule collection."
Expand Down Expand Up @@ -526,7 +526,7 @@
},
"provisioningState":{
"description":"The provisioning state of the resource.",
"$ref":"#/definitions/ProvisioningState"
"$ref":"./network.json#/definitions/ProvisioningState"
}
},
"description":"Properties of the NAT rule collection."
Expand Down Expand Up @@ -648,7 +648,7 @@
},
"provisioningState":{
"description":"The provisioning state of the resource.",
"$ref":"#/definitions/ProvisioningState"
"$ref":"./network.json#/definitions/ProvisioningState"
}
},
"description":"Properties of the network rule collection."
Expand Down Expand Up @@ -739,21 +739,6 @@
"modelAsString":true
}
},
"ProvisioningState":{
anton-evseev marked this conversation as resolved.
Show resolved Hide resolved
"type":"string",
"readOnly":true,
"description": "The current provisioning state.",
"enum":[
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"x-ms-enum":{
"name":"ProvisioningState",
"modelAsString":true
}
},
"AzureFirewallNetworkRuleProtocol":{
"type":"string",
"description":"The protocol of a Network Rule resource",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1605,7 +1605,7 @@
],
"readOnly": true,
"x-ms-enum": {
"name": "circuitConnectionStatus",
"name": "CircuitConnectionStatus",
anton-evseev marked this conversation as resolved.
Show resolved Hide resolved
"modelAsString": true
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,21 @@
}
},
"description": "Identity for the resource."
},
"ProvisioningState":{
"type":"string",
"readOnly":true,
"description": "The current provisioning state.",
"enum":[
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"x-ms-enum":{
"name":"ProvisioningState",
"modelAsString":true
}
}
},
"parameters": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@
"ipTags": {
"type": "array",
"items": {
"$ref": "#/definitions/IpTag"
"$ref": "./publicIpAddress.json#/definitions/IpTag"
},
"description": "The list of tags associated with the public IP prefix."
},
Expand Down Expand Up @@ -415,19 +415,6 @@
},
"description": "Response for ListPublicIpPrefixes API service call."
},
"IpTag": {
anton-evseev marked this conversation as resolved.
Show resolved Hide resolved
"properties": {
"ipTagType": {
"type": "string",
"description": "Gets or sets the ipTag type: Example FirstPartyUsage."
},
"tag": {
"type": "string",
"description": "Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc"
}
},
"description": "Contains the IpTag associated with the object"
},
"ReferencedPublicIpAddress":{
"properties":{
"id":{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@
},
"service": {
"type": "string",
"description": "service endpoint name."
"description": "Service endpoint name."
},
"serviceResources": {
"type": "array",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2625,7 +2625,7 @@
},
"description": "Response for ListLocalNetworkGateways API service call."
},
"virtualNetworkConnectionGatewayReference": {
"VirtualNetworkConnectionGatewayReference": {
"properties": {
"id": {
"type": "string",
Expand All @@ -2644,15 +2644,15 @@
"description": "The authorizationKey."
},
"virtualNetworkGateway1": {
"$ref": "#/definitions/virtualNetworkConnectionGatewayReference",
"$ref": "#/definitions/VirtualNetworkConnectionGatewayReference",
"description": "The reference to virtual network gateway resource."
},
"virtualNetworkGateway2": {
"$ref": "#/definitions/virtualNetworkConnectionGatewayReference",
"$ref": "#/definitions/VirtualNetworkConnectionGatewayReference",
"description": "The reference to virtual network gateway resource."
},
"localNetworkGateway2": {
"$ref": "#/definitions/virtualNetworkConnectionGatewayReference",
"$ref": "#/definitions/VirtualNetworkConnectionGatewayReference",
"description": "The reference to local network gateway resource."
},
"connectionType": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2294,14 +2294,14 @@
},
"p2SVpnServerConfigurations": {
"type": "array",
"description": "list of all P2SVpnServerConfigurations associated with the virtual wan.",
"description": "List of all P2SVpnServerConfigurations associated with the virtual wan.",
"items": {
"$ref": "#/definitions/P2SVpnServerConfiguration"
}
},
"provisioningState": {
"description": "The provisioning state of the resource.",
"$ref": "#/definitions/ProvisioningState"
"$ref": "./network.json#/definitions/ProvisioningState"
}
},
"description": "Parameters for VirtualWAN"
Expand Down Expand Up @@ -2372,7 +2372,7 @@
},
"provisioningState": {
"description": "The provisioning state of the resource.",
"$ref": "#/definitions/ProvisioningState"
"$ref": "./network.json#/definitions/ProvisioningState"
},
"isSecuritySite": {
"type": "boolean",
Expand Down Expand Up @@ -2455,7 +2455,7 @@
},
"virtualNetworkConnections": {
"type": "array",
"description": "list of all vnet connections with this VirtualHub.",
"description": "List of all vnet connections with this VirtualHub.",
"items": {
"$ref": "#/definitions/HubVirtualNetworkConnection"
}
Expand All @@ -2470,7 +2470,7 @@
},
"provisioningState": {
"description": "The provisioning state of the resource.",
"$ref": "#/definitions/ProvisioningState"
"$ref": "./network.json#/definitions/ProvisioningState"
}
},
"description": "Parameters for VirtualHub"
Expand All @@ -2479,7 +2479,7 @@
"properties" : {
"routes": {
"type": "array",
"description": "list of all routes.",
"description": "List of all routes.",
"items": {
"$ref": "#/definitions/VirtualHubRoute"
}
Expand All @@ -2491,7 +2491,7 @@
"properties" : {
"addressPrefixes": {
"type": "array",
"description": "list of all addressPrefixes.",
"description": "List of all addressPrefixes.",
"items": {
"type": "string"
}
Expand Down Expand Up @@ -2549,7 +2549,7 @@
},
"connections": {
"type": "array",
"description": "list of all vpn connections to the gateway.",
"description": "List of all vpn connections to the gateway.",
"items": {
"$ref": "#/definitions/VpnConnection"
}
Expand All @@ -2560,7 +2560,7 @@
},
"provisioningState": {
"description": "The provisioning state of the resource.",
"$ref": "#/definitions/ProvisioningState"
"$ref": "./network.json#/definitions/ProvisioningState"
},
"vpnGatewayScaleUnit": {
"type": "integer",
Expand Down Expand Up @@ -2617,7 +2617,7 @@
"routingWeight": {
"type": "integer",
"format": "int32",
"description": "routing weight for vpn connection."
"description": "Routing weight for vpn connection."
},
"connectionStatus": {
"description": "The connection status.",
Expand Down Expand Up @@ -2669,7 +2669,7 @@
},
"provisioningState": {
"description": "The provisioning state of the resource.",
"$ref": "#/definitions/ProvisioningState"
"$ref": "./network.json#/definitions/ProvisioningState"
}
},
"description": "Parameters for VpnConnection"
Expand Down Expand Up @@ -2733,7 +2733,7 @@
},
"provisioningState": {
"description": "The provisioning state of the resource.",
"$ref": "#/definitions/ProvisioningState"
"$ref": "./network.json#/definitions/ProvisioningState"
}
},
"description": "Parameters for HubVirtualNetworkConnection"
Expand Down Expand Up @@ -2833,21 +2833,6 @@
},
"description": "Collection of SecurityProviders."
},
"ProvisioningState": {
"type": "string",
"readOnly": true,
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Updating",
"Deleting",
"Failed"
],
"x-ms-enum": {
"name": "ProvisioningState",
"modelAsString": true
}
},
"VpnConnectionStatus": {
"type": "string",
"description": "The current state of the vpn connection.",
Expand All @@ -2859,7 +2844,7 @@
"NotConnected"
],
"x-ms-enum": {
"name": "vpnConnectionStatus",
"name": "VpnConnectionStatus",
"modelAsString": true
}
},
Expand All @@ -2874,7 +2859,7 @@
"NotConnected"
],
"x-ms-enum": {
"name": "tunnelConnectionStatus",
"name": "TunnelConnectionStatus",
"modelAsString": true
}
},
Expand All @@ -2893,19 +2878,15 @@
"modelAsString": true
}
},
"disableVpnEncryption": {
"type": "boolean",
"description": "Vpn encryption to be disabled or not."
},
"access": {
"Access": {
"type": "string",
"description": "Access to be allowed or denied.",
"enum": [
"Allow",
"Deny"
],
"x-ms-enum": {
"name": "access",
"name": "Access",
"modelAsString": true
}
},
Expand All @@ -2920,7 +2901,7 @@
"None"
],
"x-ms-enum": {
"name": "officeTrafficCategory",
"name": "OfficeTrafficCategory",
"modelAsString": true
}
},
Expand All @@ -2933,7 +2914,7 @@
"Native"
],
"x-ms-enum": {
"name": "virtualWanSecurityProviderType",
"name": "VirtualWanSecurityProviderType",
"modelAsString": true
}
},
Expand Down Expand Up @@ -3117,7 +3098,7 @@
"modelAsString": true
}
},
"description": "vpnProtocols for the P2SVpnServerConfiguration."
"description": "VPN protocols for the P2SVpnServerConfiguration."
},
"p2SVpnServerConfigVpnClientRootCertificates": {
"type": "array",
Expand Down Expand Up @@ -3257,7 +3238,7 @@
},
"provisioningState": {
"description": "The provisioning state of the resource.",
"$ref": "#/definitions/ProvisioningState"
"$ref": "./network.json#/definitions/ProvisioningState"
},
"vpnGatewayScaleUnit": {
"type": "integer",
Expand Down