feat(apim): Provide capability to use custom hostname for Configuration API v2

[tomkerkhove]

Provide capability to use custom hostname for Configuration API v2.

Port of #22526 to 2023-03-01-preview.

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

1. What's the purpose of the update?
   • new service onboarding
   • new API version
   • update existing version for new feature
   • update existing version to fix swagger quality issue in s360
   • Other, please clarify
2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

• I commit to follow the Breaking Change Policy of "no breaking changes"
• I have reviewed the documentation for the workflow.
• Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

• Change to data plane APIs
• Adding new properties
• All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

• Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

  • Adding a new service
  • Adding new API(s)
  • Adding a new API version
    -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.

• Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

• If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

[openapi-workflow-bot]

Hi, @tomkerkhove Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

[openapi-pipeline-app]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 1 Warnings warning [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
apimdeployment.json	2023-03-01-preview(fd3622d)	2022-08-01(main)
apimdeployment.json	2023-03-01-preview(fd3622d)	2022-09-01-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
⚠️ 1014 - RemovingHeader	The new version removs a required header 'Location'. Old: Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json#L236:15

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-preview-2023-03	package-preview-2023-03(fd3622d)	package-preview-2023-03(release-Microsoft.ApiManagement-2023-03-01-preview)

The following errors/warnings exist before current PR submission:

Rule	Message
❌ OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.ApiManagement/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L57
❌ UnSupportedPatchProperties	The patch operation body parameter schema should not contains property name. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L362
❌ UnSupportedPatchProperties	The patch operation body parameter schema should not contains property type. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L362
❌ GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1927
❌ GuidUsage	Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1933
⚠️ XmsLongRunningOperationOptions	The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L255
⚠️ XmsLongRunningOperationOptions	The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L338
⚠️ XmsLongRunningOperationOptions	The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L449
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1067
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1072
⚠️ LocationMustHaveXmsMutability	Property location must have 'x-ms-mutability':['read', 'create'] extension defined. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1139
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1214
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1498
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1534
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1571
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1860
⚠️ LocationMustHaveXmsMutability	Property location must have 'x-ms-mutability':['read', 'create'] extension defined. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1900
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1949
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ApiManagement/preview/2023-03-01-preview/apimdeployment.json#L1972

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️⚠️SDK Breaking Change Tracking warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-net-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-python-track2 warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-resource-manager-schemas warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-powershell failed [Detail]

Only 0 items are rendered, please refer to log for more details.

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.ApiManagement	https://apiview.dev/Assemblies/Review/4a36811e310447f9b8c4f62ea72db742
Go	sdk/resourcemanager/apimanagement/armapimanagement	https://apiview.dev/Assemblies/Review/ad51ff9b9f844383a5fa8f42fe2514eb
JavaScript	@azure/arm-apimanagement	https://apiview.dev/Assemblies/Review/1d62b0da81964939a3647456ea4c5ba0