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

Added listServicePrincipalId #17068

Merged
merged 23 commits into from
Feb 10, 2022
Merged

Added listServicePrincipalId #17068

merged 23 commits into from
Feb 10, 2022

Conversation

ikanni
Copy link
Contributor

@ikanni ikanni commented Dec 14, 2021

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
      -[X] 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, @ikanni 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 Dec 14, 2021

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1287:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1332:5
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    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: authorizationSet
    Location: Microsoft.Automanage/preview/2021-04-30-preview/automanage.json#L1746
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️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.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️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 Dec 14, 2021

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - preview/automanage/mgmt/2020-06-30-preview/automanage - v61.4.0
    azure-sdk-for-python-track2 - track2_azure-mgmt-automanage - 1.0.0b2
    +	Model ConfigurationProfileAssignmentProperties no longer has parameter account_id
    +	Model ConfigurationProfileAssignmentProperties no longer has parameter compliance
    +	Model ConfigurationProfileAssignmentProperties no longer has parameter configuration_profile_preference_id
    +	Model Operation no longer has parameter status_code
    +	Removed operation ConfigurationProfileAssignmentsOperations.begin_create_or_update
    +	Removed operation group AccountsOperations
    +	Removed operation group ConfigurationProfilePreferencesOperations
    ️✔️azure-sdk-for-go - preview/automanage/mgmt/2021-04-30-preview/automanage - v61.4.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 644beb7. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.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/automanage/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
      cmderr	[Autorest] ERROR: Schema violation: Additional properties not allowed: x-ms-identifiers
      cmderr	[Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/common-types/resource-management/v2/types.json:427:8 ($.definitions.OperationListResult.properties.value)
      cmderr	[Autorest] ERROR: Schema violation: Additional properties not allowed: x-ms-identifiers
      cmderr	[Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/common-types/resource-management/v2/types.json:316:8 ($.definitions.ErrorDetail.properties.additionalInfo)
      cmderr	[Autorest] ERROR: Schema violation: Additional properties not allowed: x-ms-identifiers
      cmderr	[Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/common-types/resource-management/v2/types.json:304:8 ($.definitions.ErrorDetail.properties.details)
      cmderr	[Autorest] FATAL: swagger-document/individual/schema-validator - FAILED
      cmderr	[Autorest] FATAL: Error: [OperationAbortedException] Error occurred. Exiting.
      cmderr	[Autorest] Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 644beb7. 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
      cmderr	[automation_generate.sh] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.1.2 -> 8.4.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.4.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.4.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-automanage [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation ConfigurationProfileAssignmentsOperations.create_or_update
      info	[Changelog]   - Added operation group BestPracticesOperations
      info	[Changelog]   - Added operation group BestPracticesVersionsOperations
      info	[Changelog]   - Added operation group ConfigurationProfilesOperations
      info	[Changelog]   - Added operation group ConfigurationProfilesVersionsOperations
      info	[Changelog]   - Added operation group ReportsOperations
      info	[Changelog]   - Added operation group ServicePrincipalsOperations
      info	[Changelog]   - Model ConfigurationProfileAssignment has a new parameter system_data
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties has a new parameter profile_overrides
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties has a new parameter status
      info	[Changelog]   - Model Operation has a new parameter action_type
      info	[Changelog]   - Model Operation has a new parameter origin
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties no longer has parameter account_id
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties no longer has parameter compliance
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties no longer has parameter configuration_profile_preference_id
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties no longer has parameter provisioning_status
      info	[Changelog]   - Model Operation no longer has parameter status_code
      info	[Changelog]   - Removed operation ConfigurationProfileAssignmentsOperations.begin_create_or_update
      info	[Changelog]   - Removed operation group AccountsOperations
      info	[Changelog]   - Removed operation group ConfigurationProfilePreferencesOperations
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 644beb7. SDK Automation 14.0.0
      command	sh ./eng/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/automanage/mgmt/2021-04-30-preview/automanage [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `ServicePrincipalsClient.ListBySubscriptionResponder(*http.Response) (ServicePrincipalListResult, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.GetPreparer(context.Context) (*http.Request, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.ListBySubscriptionPreparer(context.Context) (*http.Request, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.ListBySubscription(context.Context) (ServicePrincipalListResult, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.ListBySubscriptionSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `ServicePrincipal.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.GetResponder(*http.Response) (ServicePrincipal, error)`
      info	[Changelog] - New function `*ServicePrincipal.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `ServicePrincipalProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `NewServicePrincipalsClient(string) ServicePrincipalsClient`
      info	[Changelog] - New function `NewServicePrincipalsClientWithBaseURI(string, string) ServicePrincipalsClient`
      info	[Changelog] - New function `ServicePrincipalsClient.GetSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.Get(context.Context) (ServicePrincipal, error)`
      info	[Changelog] - New struct `ServicePrincipal`
      info	[Changelog] - New struct `ServicePrincipalListResult`
      info	[Changelog] - New struct `ServicePrincipalProperties`
      info	[Changelog] - New struct `ServicePrincipalsClient`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 21 additive change(s).
    • ️✔️preview/automanage/mgmt/2020-06-30-preview/automanage [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 644beb7. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      cmderr	[automation_init.sh] deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh]  created a lockfile as package-lock.json. You should commit this file.
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️track2_@azure/arm-automanage [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    Posted by Swagger Pipeline | How to fix these errors?

    @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 Dec 14, 2021
    @openapi-workflow-bot
    Copy link

    Hi, @ikanni 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
    Copy link

    Hi @ikanni, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @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.

    @openapi-workflow-bot
    Copy link

    Hi @ikanni, 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.

    @mentat9
    Copy link
    Member

    mentat9 commented Dec 14, 2021

    @ikanni, ARM review is waiting until the NewApiVersionRequired label has been addressed. If you want to add a new API to an existing API version, you will need to get breaking change approval. I've added the breaking change label which gives the instructions for requesting breaking change approval. Otherwise, please put the new API into a new API version.

    "x-ms-client-flatten": true,
    "$ref": "#/definitions/ServicePrincipalProperties",
    "description": "The Service Principal properties for the subscription"
    }
    Copy link

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    This needs to be a proxy resource

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Yes it is a Proxy resource. We have updated in Manifest

    Copy link

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    No like reference a ProxyResource object. For example you can see how other swaggers reference : https://github.com/Azure/azure-rest-api-specs-pr/blob/main/specification/common-types/resource-management/v3/types.json#L91

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Thank you got it! I will fix it now

    Copy link
    Contributor Author

    @ikanni ikanni Feb 5, 2022

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @raosuhas When I reference ProxyResource, I got the below error for RequiredReadOnlySystemData
    Since we are doing get only, Can we return systemData.createdBy as SYSTEM and systemData.createdAt as "0001-01-01T00:00:00.00Z" ?

    image

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @raosuhas Above comment is fixed and I will resolve once you answer for the above question.

    @raosuhas raosuhas added WaitForARMRevisit and removed ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Feb 4, 2022
    @pilor pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMRevisit labels Feb 7, 2022
    @ikanni
    Copy link
    Contributor Author

    ikanni commented Feb 9, 2022

    @ruowan Could you please help in merging this PR?

    Let me know If I need to get any approvals before merging.

    @ruowan ruowan merged commit 644beb7 into Azure:main Feb 10, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request Mar 7, 2022
    * Added listServicePrincipalId
    
    * Fixed few errors
    
    * Fixed spelling
    
    * Fixed few errors
    
    * Fixed few errors
    
    * Added listServicePrincipalId
    
    * Fixed one error
    
    * Fixed few errors
    
    * Fixed error
    
    * Fixed error
    
    * Updated tag to trigger a build
    
    * Fixed spelling
    
    * Fixed comment
    
    * Changed from Post to get to work in ARM template
    
    * fixed failure
    
    * fixed failure
    
    * fixed warning
    
    * Refferred ProxyResource
    
    * Fixed ProxyResource and another comment
    
    * Added systemData for ServicePrincipal
    
    * Added Collection GET for Singleton
    
    * Fixed error and warnings
    
    * Fixed PrettierCheck error
    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
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants