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

Private Endpoint Example Needs an Update #1856

Closed
tksrc opened this issue Jul 28, 2021 · 4 comments
Closed

Private Endpoint Example Needs an Update #1856

tksrc opened this issue Jul 28, 2021 · 4 comments
Assignees
Labels
kind/bug Some behavior is incorrect or out of spec language/python resolution/fixed This issue was fixed

Comments

@tksrc
Copy link

tksrc commented Jul 28, 2021

File: themes/default/content/docs/reference/pkg/azure-native/network/privateendpoint/_index.md

The python example on this page (copied below) is missing a name attribute for PrivateLinkServiceConnectionArgs. I have been getting error: Code="InvalidRequestFormat" Message="Cannot parse the request." Details=[] errors until I have populated the name attribute.

Before

private_endpoint = azure_native.network.PrivateEndpoint("privateEndpoint",
    #....
    private_link_service_connections=[azure_native.network.PrivateLinkServiceConnectionArgs(
        group_ids=["groupIdFromResource"],
        # ...
    )],
    #...

After

private_endpoint = azure_native.network.PrivateEndpoint("privateEndpoint",
    #....
    private_link_service_connections=[azure_native.network.PrivateLinkServiceConnectionArgs(
        name="xxxxx", # <-------
        group_ids=["groupIdFromResource"],
        # ...
    )],
    #...
@mikhailshilkov
Copy link
Member

We automatically generate this example from an example published in https://github.com/Azure/azure-rest-api-specs/blob/master/specification/network/resource-manager/Microsoft.Network/stable/2020-11-01/examples/PrivateEndpointCreate.json

It doesn't have the name either. If/when a name is added there, we'll get it in our docs automatically.

@tksrc
Copy link
Author

tksrc commented Jul 29, 2021

Hm. Does the example on the Pulumi page work for you though? I think the end goal is to have functional examples regardless how they are generated :)

@mikhailshilkov
Copy link
Member

I opened Azure/azure-rest-api-specs#15450 upstream, let's see if it's accepted

@susanev susanev transferred this issue from pulumi/pulumi-hugo Jul 26, 2022
@susanev susanev added the awaiting-upstream The issue cannot be resolved without action in another repository (may be owned by Pulumi). label Jul 26, 2022
@mikhailshilkov mikhailshilkov removed their assignment Jul 27, 2022
@mnlumi mnlumi self-assigned this Jul 28, 2023
@mnlumi mnlumi added kind/bug Some behavior is incorrect or out of spec resolution/fixed This issue was fixed and removed awaiting-upstream The issue cannot be resolved without action in another repository (may be owned by Pulumi). labels Jul 28, 2023
@mnlumi
Copy link

mnlumi commented Jul 28, 2023

The upstream issue was merged and the example reflects the change to properly include the name attribute.

@mnlumi mnlumi closed this as completed Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Some behavior is incorrect or out of spec language/python resolution/fixed This issue was fixed
Projects
None yet
Development

No branches or pull requests

4 participants