Updating Functions ARM API specs by mathewc · Pull Request #7174 · Azure/azure-rest-api-specs

mathewc · 2019-09-10T21:26:26Z

Spec updates for recent Functions ARM API updates. The ARM APIs are live and being used now, and these updates match the current service behavior. This PR replaces a previous PR (#6472).

Notes on the changes:

fixed up some description string grammar
Added new Types: KeyInfo, HostKeys
Added the following properties to existing FunctionEnvelope type: test_data_href, invoke_url_template, language, isDisabled
Added the following new APIs:
- POST api/sites/{name}[/slots/{slot}]/functions/{functionName}/listkeys
- PUT api/sites/{name}[/slots/{slot}]/functions/{functionName}/keys/{keyName}
- DELETE api/sites/{name}[/slots/{slot}]/functions/{functionName}/keys/{keyName}
- POST api/sites/{name}[/slots/{slot}]/host/default/listkeys
- PUT api/sites/{name}[/slots/{slot}]/host/default/{functionkeys|systemkeys}/{keyName}
- DELETE api/sites/{name}[/slots/{slot}]/host/default/{functionkeys|systemkeys}/{keyName}
- POST api/sites/{name}[/slots/{slot}]/host/default/sync
- POST api/sites/{name}[/slots/{slot}]/host/default/listsyncstatus

openapi-sdkautomation · 2019-09-10T21:26:29Z

In Testing, Please Ignore

[Logs] (Generated from b1da089, Iteration 8)

.NET: test-repo-billy/azure-sdk-for-net [Logs] [Diff]

No packages generated.

Python: test-repo-billy/azure-sdk-for-python [Logs] [Diff]

azure-mgmt-web [Logs] [Instructions] [Generation PR]
- azure-mgmt-web-0.43.0.zip
- azure_mgmt_web-0.43.0-py2.py3-none-any.whl

Java: test-repo-billy/azure-sdk-for-java [Logs] [Diff]

appservice/resource-manager/v2016_03_01 [Logs]
appservice/resource-manager/v2016_08_01 [Logs]
appservice/resource-manager/v2016_09_01 [Logs]
appservice/resource-manager/v2018_02_01 [Logs]

Go: test-repo-billy/azure-sdk-for-go [Logs] [Diff]

preview/web/mgmt/2015-08-01-preview [Logs]
web/mgmt/2016-09-01 [Logs]
web/mgmt/2018-02-01 [Logs] [Instructions] [Generation PR] [Integration PR]
- web.mgmt.2018-02-01.zip

JavaScript: test-repo-billy/azure-sdk-for-js [Logs] [Diff]

@azure/arm-appservice [Logs] [Instructions]
- azure-arm-appservice-5.8.0.tgz

Ruby: test-repo-billy/azure-sdk-for-ruby [Logs] [Diff]

azure_sdk [Logs] [Instructions]
- azure_sdk-0.19.7.gem

AutorestCI · 2019-09-10T21:29:12Z

Automation for azure-sdk-for-python

A PR has been created for you based on this PR content.

Once this PR will be merged, content will be added to your service PR:
Azure/azure-sdk-for-python#8012

AutorestCI · 2019-09-10T21:44:12Z

Automation for azure-sdk-for-go

A PR has been created for you based on this PR content.

Once this PR will be merged, content will be added to your service PR:
Azure/azure-sdk-for-go#6079

azuresdkci · 2019-09-10T22:00:42Z

Can one of the admins verify this patch?

yungezz · 2019-09-16T02:37:11Z

Previous PR is under reviewing #6472. Hi @KrisBash could you pls continue reviewing at the new PR?

mathewc · 2019-09-16T16:54:01Z

Thanks guys. As you can see, this PR (and its previous incarnation) have been active for a very long time. If you need any details/clarification from me, I'm more than happy to meet with you guys to discuss. As noted above, this PR maps to the way the service currently behaves. Previous reviewers have pointed out some areas for improvement in response codes etc. but such changes would be breaking and will have to be made in future versions of the APIs.

specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json

lawrencegripper · 2019-09-17T08:54:52Z

Hi,

I've done a quick review as based on the emails with Matthew I was pointed to this change as he mentioned the endpoint I was using and fixing in #7143 is now obsolete. The context here is I'm attempting to add the ability to list functions keys into terraform which relies on the autorest generated SDK for Golang which is created from these specs. This is being done based on customer feedback in a compete scenario.

The issue of nested properties and ProxyOnlyResource appears as though it may affect a number of response types for the APIs in 2018-02-01 and 2018-11-01 but I haven't been able to test all of them. I know at the moment that it affects:

WebApps_ListFunctionSecrets
WebApps_ListHostKeys

I have a PR here addressing these issues for WebApps_ListFunctionSecrets in both 2018-02-01 and 2018-11-01 here: #7155

KrisBash

Please sync with arm api review to discuss.

specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json

yungezz · 2019-09-23T01:57:23Z

@mathewc could you pls update to address review comments?

mathewc · 2019-09-26T19:42:05Z

@KrisBash I addressed feedback and added explanations where needed, thanks.

mathewc · 2019-10-04T19:57:51Z

All contentious APIs removed from spec update. @KrisBash I think all issues are addressed now.

mathewc · 2019-10-08T17:38:18Z

@KrisBash Ping - we good on this now? Thanks :)

yungezz · 2019-10-10T01:33:02Z

Hi @KrisBash , could you pls review this PR again after updating?

mathewc · 2019-10-11T20:36:28Z

@yungezz @KrisBash Anything remaining here or can we merge this?

mathewc · 2019-10-16T18:15:24Z

@yungezz @KrisBash Ping

KrisBash

thanks!

yungezz · 2019-10-18T03:30:20Z

@mathewc is ok to merge now?

mathewc · 2019-10-18T03:56:36Z

Yes, please, thanks :)

lawrencegripper · 2019-11-27T08:58:38Z

@mathewc and @KrisBash the change has been merged into Terraform and I can confirm that the issues around ListFunctionKeys and ListFunctionSecrets persist.

When using the golang SDK generated from this PR the response object returns nil for all properties. This is a variant of the bug I original reported in the PR.

This is because the Spec is incorrect. The response type of stringdictionary doesn't match the rest request.

Spec

// StringDictionary string dictionary resource.
type StringDictionary struct {
	autorest.Response `json:"-"`
	// Properties - Settings.
	Properties map[string]*string `json:"properties"`
	// ID - READ-ONLY; Resource Id.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource Name.
	Name *string `json:"name,omitempty"`
	// Kind - Kind of resource.
	Kind *string `json:"kind,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
}

Actual response

2019/11/27 08:48:10 [DEBUG] AzureRM Response for https://management.azure.com/subscriptions/SOMESUBHERE/resourceGroups/acctestRG-191127084620878438/providers/Microsoft.Web/sites/acctest-SOMEWEBAPP-func/functions/testfunc/listkeys?api-version=2018-02-01: 
HTTP/2.0 200 OK
Cache-Control: no-cache
Content-Type: application/json
Date: Wed, 27 Nov 2019 08:48:09 GMT
Expires: -1
Pragma: no-cache
Server: Microsoft-IIS/10.0
Strict-Transport-Security: max-age=31536000; includeSubDomains
Vary: Accept-Encoding
X-Aspnet-Version: 4.0.30319
X-Content-Type-Options: nosniff
X-Ms-Correlation-Request-Id: 2b01576e-2f24-8b9e-5afc-513858370e02
X-Ms-Ratelimit-Remaining-Subscription-Writes: 1197
X-Ms-Request-Id: 82554e83-d412-4c44-ad33-4322d35aa92e
X-Ms-Routing-Request-Id: UKSOUTH2:20191127T084810Z:d25852f2-eb99-42e6-9b9a-6d252858c434
X-Powered-By: ASP.NET

{"default":"icCCQ97/zFdZ6mXYSOMEKEYHEREpcaBi0X7yI4psRqkI6Ff6e8bA=="}

Updating Functions ARM API specs

3da06e8

mathewc requested a review from naveedaz as a code owner September 10, 2019 21:26

azuresdkci assigned amarzavery Sep 10, 2019

azuresdkci requested a review from amarzavery September 10, 2019 21:27

mathewc mentioned this pull request Sep 10, 2019

Updating Functions ARM API specs for ANT 82 updates #6472

Closed

AutorestCI mentioned this pull request Sep 10, 2019

[AutoPR web/resource-manager] Updating Functions ARM API specs Azure/azure-sdk-for-go#5734

Closed

yungezz assigned yungezz and unassigned amarzavery Sep 11, 2019

yungezz added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 16, 2019

lawrencegripper reviewed Sep 17, 2019

View reviewed changes

specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json Outdated Show resolved Hide resolved

specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json Outdated Show resolved Hide resolved

KrisBash added the ARMReviewInProgress label Sep 18, 2019

KrisBash suggested changes Sep 18, 2019

View reviewed changes

KrisBash added ARMChangesRequested and removed ARMReviewInProgress labels Sep 18, 2019

Addressing feedback

8a63900

Addressing feedback

953c4ed

mathewc force-pushed the functions-spec-updates branch from 4a0fa66 to 953c4ed Compare September 26, 2019 21:20

Removing contentions APIs from spec

b1da089

AutorestCI mentioned this pull request Oct 4, 2019

[AutoPR web/resource-manager] Updating Functions ARM API specs Azure/azure-sdk-for-go#5955

Closed

mathewc requested a review from KrisBash October 16, 2019 18:16

KrisBash approved these changes Oct 18, 2019

View reviewed changes

KrisBash added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 18, 2019

yungezz merged commit 3fcde8b into Azure:master Oct 18, 2019

This was referenced Oct 18, 2019

[AutoPR web/resource-manager] Updating Functions ARM API specs Azure/azure-sdk-for-python#8011

Merged

[AutoPR web/resource-manager] Updating Functions ARM API specs Azure/azure-sdk-for-go#6078

Merged

mathewc mentioned this pull request Dec 10, 2019

Updating Functions ARM APIs #7939

Merged

5 tasks

HarveyLink mentioned this pull request Feb 4, 2024

Keys mangement endpoints are not documented or exposed via Azure SDK for .NET consistently Azure/azure-sdk-for-net#37862

Closed

Conversation

mathewc commented Sep 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openapi-sdkautomation bot commented Sep 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

In Testing, Please Ignore

[Logs] (Generated from b1da089, Iteration 8)

Uh oh!

AutorestCI commented Sep 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

AutorestCI commented Sep 10, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

azuresdkci commented Sep 10, 2019

Uh oh!

yungezz commented Sep 16, 2019

Uh oh!

mathewc commented Sep 16, 2019

Uh oh!

Uh oh!

Uh oh!

lawrencegripper commented Sep 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

KrisBash left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yungezz commented Sep 23, 2019

Uh oh!

mathewc commented Sep 26, 2019

Uh oh!

mathewc commented Oct 4, 2019

Uh oh!

mathewc commented Oct 8, 2019

Uh oh!

yungezz commented Oct 10, 2019

Uh oh!

mathewc commented Oct 11, 2019

Uh oh!

mathewc commented Oct 16, 2019

Uh oh!

KrisBash left a comment

Choose a reason for hiding this comment

Uh oh!

yungezz commented Oct 18, 2019

Uh oh!

mathewc commented Oct 18, 2019

Uh oh!

lawrencegripper commented Nov 27, 2019

Spec

Actual response

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

mathewc commented Sep 10, 2019 •

edited

Loading

openapi-sdkautomation bot commented Sep 10, 2019 •

edited

Loading

AutorestCI commented Sep 10, 2019 •

edited

Loading

AutorestCI commented Sep 10, 2019 •

edited

Loading

lawrencegripper commented Sep 17, 2019 •

edited

Loading