FrontDoorTlsProtocolType missing after 2019-04-01

[timja]

Bug Report

• import path of package in question, e.g. .../services/frontdoor/mgmt/2019-11-01/frontdoor
• 38.1.0
• output of go version
  go version go1.13 darwin/amd64

Hi 👋

I'm trying to upgrade terraform to the newest version of the SDK, it seems that FrontDoorTlsProtocolType is missing after 2019-04-01.
But it still appears to be in the rest api spec?

Something wrong in the generation? https://github.com/Azure/azure-rest-api-specs/blob/master/specification/frontdoor/resource-manager/Microsoft.Network/stable/2019-05-01/frontdoor.json#L1395-L1405

(I can't see a frontdoor.json after 2019-05-01 so I assume that means the API spec hasn't changed since then, that's also the version that the constant disappeared in).

https://github.com/Azure/azure-sdk-for-go/blob/master/services/frontdoor/mgmt/2019-04-01/frontdoor/models.go#L775
https://github.com/Azure/azure-sdk-for-go/blob/master/services/frontdoor/mgmt/2019-11-01/frontdoor/models.go#L974

• What happened?
  Missing field FrontDoorTlsProtocolType

• What did you expect or want to happen?
  The field to be there

• How can we reproduce it?
  Look at above links

• Anything we should know about your environment.

hashicorp/terraform-provider-azurerm#5385

[ArcturusZhang]

Hi @timja thanks for the issue.
You are correct, the spec for frontdoor is the same as 2019-05-01, you can find the corresponding spec definition in the readme file
As for the FrontDoorTlsProtocolType type, as you see in the sdk repo, the model.go file has not been changed since v34.0.0. I will have some investigation on why that happens. In the mean time, that field is an enum, and it could only have one possible value: ServerNameIndication, you could just hard code that value as a workaround for now.

[ArcturusZhang]

Hi @jhendrixMSFT could you please have an explanation from the code gen side why it differs from 2019-04-01 and 2019-05-01 (and higher)?

[timja]

(As you can see in the linked terraform PR I’ve hard coded it with a link to this issue)

[jhendrixMSFT]

This enum has one value and is required. In this case the codegen is supposed to treat it as a constant, i.e. you shouldn't be able to even set the field, the value is sent without user intervention. This works for constant parameter values but is apparently broken for model properties. Will work on a fix.

[chamons]

I just tested latest autorest.go and this is what it generated:

// FrontDoorTLSProtocolType - Defines the TLS extension protocol that is used for secure delivery
type FrontDoorTLSProtocolType string

...
type CustomHTTPSConfiguration struct {
	// REQUIRED; Defines the source of the SSL certificate
	CertificateSource *FrontDoorCertificateSource `json:"certificateSource,omitempty"`

	// REQUIRED; The minimum TLS version required from the clients to establish an SSL handshake with Front Door.
	MinimumTLSVersion *MinimumTLSVersion `json:"minimumTlsVersion,omitempty"`

	// REQUIRED; Defines the TLS extension protocol that is used for secure delivery
	ProtocolType *FrontDoorTLSProtocolType `json:"protocolType,omitempty"`

	// Parameters required for enabling SSL with Front Door-managed certificates (if certificateSource=FrontDoor)
	FrontDoorCertificateSourceParameters *FrontDoorCertificateSourceParameters `json:"frontDoorCertificateSourceParameters,omitempty"`

	// KeyVault certificate source parameters (if certificateSource=AzureKeyVault)
	KeyVaultCertificateSourceParameters *KeyVaultCertificateSourceParameters `json:"keyVaultCertificateSourceParameters,omitempty"`
}

I am uncertain if that means this is fixed, or broken worse given your comment on constants @jhendrixMSFT

[lirenhe]

@timja, could you help to confirm whether this problem is fixed in the latest version of the SDK?
https://github.com/Azure/azure-sdk-for-go/tree/main/services/frontdoor/mgmt/2020-11-01/frontdoor

[timja]

From @chamons comment it's not fixed.

Nothing appears to have changed:

azure-sdk-for-go/services/frontdoor/mgmt/2020-11-01/frontdoor/models.go

Line 277 in da41676

ProtocolType *string `json:"protocolType,omitempty"`

According to @jhendrixMSFT this should just be a constant and not be settable.

(note I haven't tried to upgrade and I raised this nearly 2 years ago so just doing my best from checking the code)

[jhendrixMSFT]

Unfortunately, I misspoke earlier. When the enum is marked as modelAsString: true, it means that this enum should be treated as extensible, i.e. more values might be added in the future. In this case, it's not treated as a constant, so callers are expected to provide the value, even if there's only one to choose from.

[ghost]

Hi, we're sending this friendly reminder because we haven't heard back from you in a while. We need more information about this issue to help address it. Please be sure to give us your input within the next 7 days. If we don't hear back from you within 14 days of this comment the issue will be automatically closed. Thank you!