Skip to content

Network: Mark read-only properties as such #7488

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.

Sign up for GitHub

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

Merged
tjprescott merged 2 commits into from
Oct 16, 2019
Merged

Network: Mark read-only properties as such #7488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a44f306
Mark read-only properties as such
anton-evseev Oct 14, 2019
07bc838
Fix examples & add missing readOnly tag
anton-evseev Oct 14, 2019
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
49 changes: 48 additions & 1 deletion ...tion/network/resource-manager/Microsoft.Network/stable/2019-09-01/applicationGateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -989,6 +989,7 @@
"description": "Reference of the subnet resource. A subnet from where application gateway gets its private address."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the application gateway IP configuration resource."
}
Expand All @@ -1007,10 +1008,12 @@
"description": "Name of the IP configuration that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
Copy link
Member

@yungezz yungezz Oct 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just curious, type is readonly?

Copy link
Contributor Author

@anton-evseev anton-evseev Oct 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, they are set by the server (e.g. Microsoft.Network/applicationGateways)

"type": "string",
"description": "Type of the resource."
}
Expand All @@ -1029,6 +1032,7 @@
"description": "Certificate public data."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the authentication certificate resource."
}
Expand All @@ -1047,10 +1051,12 @@
"description": "Name of the authentication certificate that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand All @@ -1073,6 +1079,7 @@
"description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the trusted root certificate resource."
}
Expand All @@ -1091,10 +1098,12 @@
"description": "Name of the trusted root certificate that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand All @@ -1117,6 +1126,7 @@
"description": "Password for the pfx file specified in data. Only applicable in PUT request."
},
"publicCertData": {
"readOnly": true,
"type": "string",
"description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request."
},
Expand All @@ -1125,6 +1135,7 @@
"description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the SSL certificate resource."
}
Expand All @@ -1143,10 +1154,12 @@
"description": "Name of the SSL certificate that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand Down Expand Up @@ -1177,6 +1190,7 @@
"description": "Reference of the PublicIP resource."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the frontend IP configuration resource."
}
Expand All @@ -1195,10 +1209,12 @@
"description": "Name of the frontend IP configuration that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand All @@ -1218,6 +1234,7 @@
"description": "Frontend port."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the frontend port resource."
}
Expand All @@ -1236,10 +1253,12 @@
"description": "Name of the frontend port that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand Down Expand Up @@ -1267,6 +1286,7 @@
"ApplicationGatewayBackendAddressPoolPropertiesFormat": {
"properties": {
"backendIPConfigurations": {
"readOnly": true,
"type": "array",
"items": {
"$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration"
Expand All @@ -1281,6 +1301,7 @@
"description": "Backend addresses."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the backend address pool resource."
}
Expand All @@ -1299,10 +1320,12 @@
"description": "Name of the backend address pool that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand Down Expand Up @@ -1385,6 +1408,7 @@
"description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the backend HTTP settings resource."
}
Expand All @@ -1403,10 +1427,12 @@
"description": "Name of the backend http settings that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand Down Expand Up @@ -1445,6 +1471,7 @@
"description": "Applicable only if protocol is https. Enables SNI for multi-hosting."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the HTTP listener resource."
},
Expand Down Expand Up @@ -1474,10 +1501,12 @@
"description": "Name of the HTTP listener that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand Down Expand Up @@ -1515,10 +1544,11 @@
"description": "Rewrite rule set resource of URL path map path rule."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the path rule resource."
},
"firewallPolicy": {
"firewallPolicy": {
"$ref": "./network.json#/definitions/SubResource",
"description": "Reference to the FirewallPolicy resource."
}
Expand All @@ -1537,10 +1567,12 @@
"description": "Name of the path rule that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand Down Expand Up @@ -1595,6 +1627,7 @@
"description": "Criterion for classifying a healthy probe response."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the probe resource."
},
Expand Down Expand Up @@ -1636,10 +1669,12 @@
"description": "Name of the probe that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand Down Expand Up @@ -1699,6 +1734,7 @@
"description": "Redirect configuration resource of the application gateway."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the request routing rule resource."
}
Expand All @@ -1717,10 +1753,12 @@
"description": "Name of the request routing rule that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand Down Expand Up @@ -1910,10 +1948,12 @@
"description": "Name of the redirect configuration that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand Down Expand Up @@ -2069,10 +2109,12 @@
"description": "Autoscale Configuration."
},
"resourceGuid": {
"readOnly": true,
"type": "string",
"description": "The resource GUID property of the application gateway resource."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the application gateway resource."
},
Expand All @@ -2094,6 +2136,7 @@
"description": "Properties of the application gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
Expand Down Expand Up @@ -2158,6 +2201,7 @@
"description": "Path rule of URL path map resource."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the URL path map resource."
}
Expand All @@ -2176,10 +2220,12 @@
"description": "Name of the URL path map that is unique within an Application Gateway."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Type of the resource."
}
Expand Down Expand Up @@ -2407,6 +2453,7 @@
"ApplicationGatewayFirewallRuleSetPropertiesFormat": {
"properties": {
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the web application firewall rule set."
},
Expand Down
5 changes: 5 additions & 0 deletions ...ification/network/resource-manager/Microsoft.Network/stable/2019-09-01/azureFirewall.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,7 @@
"description": "Reference of the PublicIP resource. This field is a mandatory input if subnet is not null."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the Azure firewall IP configuration resource."
}
Expand Down Expand Up @@ -425,6 +426,7 @@
"description": "IP configuration of the Azure Firewall resource."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the Azure firewall resource."
},
Expand Down Expand Up @@ -531,6 +533,7 @@
"description": "Collection of rules used by a application rule collection."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the application rule collection resource."
}
Expand Down Expand Up @@ -643,6 +646,7 @@
"description": "Collection of rules used by a NAT rule collection."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the NAT rule collection resource."
}
Expand Down Expand Up @@ -770,6 +774,7 @@
"description": "Collection of rules used by a network rule collection."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the network rule collection resource."
}
Expand Down
2 changes: 2 additions & 0 deletions specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/bastionHost.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,7 @@
"description": "Reference of the PublicIP resource."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the bastion host IP configuration resource."
},
Expand Down Expand Up @@ -331,6 +332,7 @@
"description": "FQDN for the endpoint on which bastion host is accessible."
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"description": "The provisioning state of the bastion host resource."
}
Expand Down
Loading