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

[Device Update for IoT Hub] Added Private Endpoint Connection API and model definitions #16085

Merged
merged 8 commits into from
Sep 22, 2021
Merged

Conversation

darkoa-msft
Copy link
Member

@darkoa-msft darkoa-msft commented Sep 18, 2021

…nor errors

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

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. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • 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.
  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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

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

@openapi-workflow-bot
Copy link

Hi, @darkoa-msft 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. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 18, 2021

    Swagger Validation Report

    ️❌BreakingChange: 5 Errors, 5 Warnings failed [Detail]
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L653:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L698:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L849:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L894:5
    1041 - AddedPropertyInResponse The new version has a new property 'publicNetworkAccess' in response that was not found in the old version.
    New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L983:11
    Old: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L701:11
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L1021:9
    Old: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L726:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L347:13
    Old: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L347:13
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L1172:9
    Old: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L879:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L1115:5
    Old: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L824:5
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L1168:5
    Old: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L876:5
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction
    Location: common-types/resource-management/v3/types.json#L365
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable
    Location: common-types/resource-management/v3/types.json#L623
    ⚠️ R4024 - PreviewVersionOverOneYear The API version:2020-03-01-preview having been in a preview state over one year , please move it to GA or retire.
    Location: Microsoft.DeviceUpdate/preview/2020-03-01-preview/deviceupdate.json#L6
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 18, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-python-track2 - track2_azure-mgmt-deviceupdate - 1.0.0b2
    -	Model ErrorResponse has a new signature
    +	Model ErrorResponse no longer has parameter additional_info
    +	Model ErrorResponse no longer has parameter code
    +	Model ErrorResponse no longer has parameter details
    +	Model ErrorResponse no longer has parameter message
    +	Model ErrorResponse no longer has parameter target
    azure-sdk-for-go - preview/deviceupdate/mgmt/2020-03-01-preview/deviceupdate - v57.3.0
    +	Const `Accepted` has been removed
    +	Const `Canceled` type has been changed from `ProvisioningState` to `GroupIDProvisioningState`
    +	Const `Creating` has been removed
    +	Const `Deleted` has been removed
    +	Const `Failed` type has been changed from `ProvisioningState` to `GroupIDProvisioningState`
    +	Const `Succeeded` type has been changed from `ProvisioningState` to `GroupIDProvisioningState`
    +	Const `System` has been removed
    +	Const `User` type has been changed from `Origin` to `CreatedByType`
    +	Const `Usersystem` has been removed
    +	Field `AdditionalInfo` of struct `ErrorResponse` has been removed
    +	Field `Code` of struct `ErrorResponse` has been removed
    +	Field `Details` of struct `ErrorResponse` has been removed
    +	Field `Message` of struct `ErrorResponse` has been removed
    +	Field `Target` of struct `ErrorResponse` has been removed
    +	Function `ErrorDefinition.MarshalJSON` has been removed
    +	Function `ErrorResponse.MarshalJSON` has been removed
    +	Struct `ErrorDefinition` has been removed
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fc98aa6. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/deviceupdate/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmdout	[Autorest] WARNING: HEAD 'Head' method missing 404 status code section -- this might be unintentional.
      cmdout	[Autorest] WARNING: HEAD 'Head' method missing 404 status code section -- this might be unintentional.
    • ️✔️Microsoft.Azure.Management.DeviceUpdate [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from fc98aa6. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-deviceupdate [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model TrackedResource has a new parameter system_data
      info	[Changelog]   - Model ErrorResponse has a new parameter error
      info	[Changelog]   - Model Account has a new parameter system_data
      info	[Changelog]   - Model Account has a new parameter identity
      info	[Changelog]   - Model Account has a new parameter public_network_access
      info	[Changelog]   - Model AccountUpdate has a new parameter identity
      info	[Changelog]   - Model Instance has a new parameter enable_diagnostics
      info	[Changelog]   - Model Instance has a new parameter system_data
      info	[Changelog]   - Model Resource has a new parameter system_data
      info	[Changelog]   - Added operation AccountsOperations.head
      info	[Changelog]   - Added operation InstancesOperations.head
      info	[Changelog]   - Added operation group PrivateEndpointConnectionsOperations
      info	[Changelog]   - Added operation group PrivateLinkResourcesOperations
      info	[Changelog]   - Added operation group DeviceUpdateOperationsMixin
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model ErrorResponse no longer has parameter additional_info
      info	[Changelog]   - Model ErrorResponse no longer has parameter target
      info	[Changelog]   - Model ErrorResponse no longer has parameter code
      info	[Changelog]   - Model ErrorResponse no longer has parameter details
      info	[Changelog]   - Model ErrorResponse no longer has parameter message
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from fc98aa6. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️preview/deviceupdate/mgmt/2020-03-01-preview/deviceupdate [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 120 items here, please refer to log for details.
      info	[Changelog] - Field `Details` of struct `ErrorResponse` has been removed
      info	[Changelog] - Field `AdditionalInfo` of struct `ErrorResponse` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `AlreadyExists`
      info	[Changelog] - New const `ProvisioningStateAccepted`
      info	[Changelog] - New const `ProvisioningStateFailed`
      info	[Changelog] - New const `SystemAssigned`
      info	[Changelog] - New const `PrivateEndpointConnectionProvisioningStateSucceeded`
      info	[Changelog] - New const `PrivateEndpointConnectionProvisioningStateFailed`
      info	[Changelog] - New const `PrivateEndpointConnectionProvisioningStateDeleting`
      info	[Changelog] - New const `Disabled`
      info	[Changelog] - New const `Invalid`
      info	[Changelog] - New const `ProvisioningStateCanceled`
      info	[Changelog] - New const `OriginUsersystem`
      info	[Changelog] - New const `ProvisioningStateSucceeded`
      info	[Changelog] - New const `Key`
      info	[Changelog] - New const `PrivateEndpointConnectionProvisioningStateCreating`
      info	[Changelog] - New const `None`
      info	[Changelog] - New const `Application`
      info	[Changelog] - New const `OriginSystem`
      info	[Changelog] - New const `ManagedIdentity`
      info	[Changelog] - New const `Pending`
      info	[Changelog] - New const `Rejected`
      info	[Changelog] - New const `Approved`
      info	[Changelog] - New const `ProvisioningStateCreating`
      info	[Changelog] - New const `Enabled`
      info	[Changelog] - New const `ProvisioningStateDeleted`
      info	[Changelog] - New const `OriginUser`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.Delete(context.Context, string, string, string) (PrivateEndpointConnectionsDeleteFuture, error)`
      info	[Changelog] - New function `AccountsClient.HeadSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.ListByAccountPreparer(context.Context, string, string) (*http.Request, error)`
      info	[Changelog] - New function `PrivateLinkResourcesClient.GetSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.ListByAccountResponder(*http.Response) (PrivateEndpointConnectionListResult, error)`
      info	[Changelog] - New function `InstancesClient.Head(context.Context, string, string, string) (autorest.Response, error)`
      info	[Changelog] - New function `InstancesClient.HeadResponder(*http.Response) (autorest.Response, error)`
      info	[Changelog] - New function `BaseClient.CheckNameAvailabilityResponder(*http.Response) (CheckNameAvailabilityResponse, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.GetSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `PrivateLinkResourcesClient.ListByAccountSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `InstancesClient.HeadSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.DeleteSender(*http.Request) (PrivateEndpointConnectionsDeleteFuture, error)`
      info	[Changelog] - New function `PrivateEndpointConnection.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PrivateLinkResourcesClient.Get(context.Context, string, string, string) (GroupInformation, error)`
      info	[Changelog] - New function `PrivateLinkResourcesClient.ListByAccountResponder(*http.Response) (PrivateLinkResourceListResult, error)`
      info	[Changelog] - New function `NewPrivateEndpointConnectionsClient(string) PrivateEndpointConnectionsClient`
      info	[Changelog] - New function `PrivateLinkResourcesClient.ListByAccountPreparer(context.Context, string, string) (*http.Request, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.CreateOrUpdateResponder(*http.Response) (PrivateEndpointConnection, error)`
      info	[Changelog] - New function `PossiblePublicNetworkAccessValues() []PublicNetworkAccess`
      info	[Changelog] - New function `PrivateEndpoint.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PrivateLinkResourcesClient.GetResponder(*http.Response) (GroupInformation, error)`
      info	[Changelog] - New function `PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState`
      info	[Changelog] - New function `PossibleCreatedByTypeValues() []CreatedByType`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.GetPreparer(context.Context, string, string, string) (*http.Request, error)`
      info	[Changelog] - New function `InstancesClient.HeadPreparer(context.Context, string, string, string) (*http.Request, error)`
      info	[Changelog] - New function `*PrivateEndpointConnectionsDeleteFuture.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `AccountsClient.Head(context.Context, string, string) (autorest.Response, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.GetResponder(*http.Response) (PrivateEndpointConnection, error)`
      info	[Changelog] - New function `NewPrivateEndpointConnectionsClientWithBaseURI(string, string) PrivateEndpointConnectionsClient`
      info	[Changelog] - New function `GroupInformationProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.DeletePreparer(context.Context, string, string, string) (*http.Request, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.CreateOrUpdate(context.Context, string, string, string, PrivateEndpointConnection) (PrivateEndpointConnectionsCreateOrUpdateFuture, error)`
      info	[Changelog] - New function `PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus`
      info	[Changelog] - New function `PossibleGroupIDProvisioningStateValues() []GroupIDProvisioningState`
      info	[Changelog] - New function `AccountsClient.HeadPreparer(context.Context, string, string) (*http.Request, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.CreateOrUpdatePreparer(context.Context, string, string, string, PrivateEndpointConnection) (*http.Request, error)`
      info	[Changelog] - New function `BaseClient.CheckNameAvailability(context.Context, CheckNameAvailabilityRequest) (CheckNameAvailabilityResponse, error)`
      info	[Changelog] - New function `ErrorDetail.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PossibleResourceIdentityTypeValues() []ResourceIdentityType`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.DeleteResponder(*http.Response) (autorest.Response, error)`
      info	[Changelog] - New function `NewPrivateLinkResourcesClient(string) PrivateLinkResourcesClient`
      info	[Changelog] - New function `*PrivateEndpointConnection.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `PrivateLinkResourcesClient.GetPreparer(context.Context, string, string, string) (*http.Request, error)`
      info	[Changelog] - New function `NewPrivateLinkResourcesClientWithBaseURI(string, string) PrivateLinkResourcesClient`
      info	[Changelog] - New function `*GroupInformation.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `PossibleCheckNameAvailabilityReasonValues() []CheckNameAvailabilityReason`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.ListByAccountSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `BaseClient.CheckNameAvailabilitySender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `BaseClient.CheckNameAvailabilityPreparer(context.Context, CheckNameAvailabilityRequest) (*http.Request, error)`
      info	[Changelog] - New function `GroupInformation.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `*PrivateEndpointConnectionsCreateOrUpdateFuture.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `PrivateLinkResourceProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.CreateOrUpdateSender(*http.Request) (PrivateEndpointConnectionsCreateOrUpdateFuture, error)`
      info	[Changelog] - New function `Identity.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PrivateLinkResourcesClient.ListByAccount(context.Context, string, string) (PrivateLinkResourceListResult, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.Get(context.Context, string, string, string) (PrivateEndpointConnection, error)`
      info	[Changelog] - New function `AccountsClient.HeadResponder(*http.Response) (autorest.Response, error)`
      info	[Changelog] - New function `PrivateEndpointConnectionsClient.ListByAccount(context.Context, string, string) (PrivateEndpointConnectionListResult, error)`
      info	[Changelog] - New struct `CheckNameAvailabilityRequest`
      info	[Changelog] - New struct `CheckNameAvailabilityResponse`
      info	[Changelog] - New struct `ErrorDetail`
      info	[Changelog] - New struct `GroupInformation`
      info	[Changelog] - New struct `GroupInformationProperties`
      info	[Changelog] - New struct `Identity`
      info	[Changelog] - New struct `PrivateEndpoint`
      info	[Changelog] - New struct `PrivateEndpointConnection`
      info	[Changelog] - New struct `PrivateEndpointConnectionListResult`
      info	[Changelog] - New struct `PrivateEndpointConnectionProperties`
      info	[Changelog] - New struct `PrivateEndpointConnectionsClient`
      info	[Changelog] - New struct `PrivateEndpointConnectionsCreateOrUpdateFuture`
      info	[Changelog] - New struct `PrivateEndpointConnectionsDeleteFuture`
      info	[Changelog] - New struct `PrivateLinkResourceListResult`
      info	[Changelog] - New struct `PrivateLinkResourceProperties`
      info	[Changelog] - New struct `PrivateLinkResourcesClient`
      info	[Changelog] - New struct `PrivateLinkServiceConnectionState`
      info	[Changelog] - New struct `SystemData`
      info	[Changelog] - New field `Identity` in struct `AccountUpdate`
      info	[Changelog] - New field `PublicNetworkAccess` in struct `AccountProperties`
      info	[Changelog] - New field `SystemData` in struct `TrackedResource`
      info	[Changelog] - New field `SystemData` in struct `Account`
      info	[Changelog] - New field `Identity` in struct `Account`
      info	[Changelog] - New field `EnableDiagnostics` in struct `InstanceProperties`
      info	[Changelog] - New field `Error` in struct `ErrorResponse`
      info	[Changelog] - New field `SystemData` in struct `AzureEntityResource`
      info	[Changelog] - New field `SystemData` in struct `ProxyResource`
      info	[Changelog] - New field `SystemData` in struct `Resource`
      info	[Changelog] - New field `SystemData` in struct `Instance`
      info	[Changelog]
      info	[Changelog] Total 14 breaking change(s), 129 additive change(s).
      info	[Changelog]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi, @darkoa-msft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 18, 2021
    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @darkoa-msft
    Copy link
    Member Author

    We are in public preview for less than 6 months with single API version and limited number of customers. We seek an exception.

    @openapi-workflow-bot
    Copy link

    Hi @darkoa-msft, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @abatishchev
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 20, 2021
    @chiragg4u
    Copy link
    Contributor

    Changes looks fine from ARM perspective. Please resolve other warnings/errors to continue.
    Also use common types instead of defining PrivateLinks.

    @chiragg4u chiragg4u added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 20, 2021
    @openapi-workflow-bot
    Copy link

    Hi @darkoa-msft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @darkoa-msft
    Copy link
    Member Author

    /azp run

    @azure-pipelines
    Copy link

    Commenter does not have sufficient privileges for PR 16085 in repo Azure/azure-rest-api-specs

    @abatishchev
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @chiragg4u chiragg4u added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Sep 21, 2021
    @ruowan ruowan merged commit fc98aa6 into Azure:main Sep 22, 2021
    Hardell pushed a commit to Hardell/azure-rest-api-specs that referenced this pull request Sep 27, 2021
    … model definitions (Azure#16085)
    
    * Added Private Endpoint Connection API and model definitions, fixed minor errors
    
    * Referenced common private link types
    
    * Reference list types do not have nextLink property
    
    * Fixed copy&paste description error
    
    * Trying to suppress an error
    
    * Change common types version to v3
    
    * Suppression not working
    
    * Extended common type in order to add a required property
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    … model definitions (Azure#16085)
    
    * Added Private Endpoint Connection API and model definitions, fixed minor errors
    
    * Referenced common private link types
    
    * Reference list types do not have nextLink property
    
    * Fixed copy&paste description error
    
    * Trying to suppress an error
    
    * Change common types version to v3
    
    * Suppression not working
    
    * Extended common type in order to add a required property
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants