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

Adding all ASI RP APIs #5173

Merged
merged 51 commits into from
Feb 13, 2019
Merged

Adding all ASI RP APIs #5173

merged 51 commits into from
Feb 13, 2019

Conversation

nirgfani
Copy link
Contributor

@nirgfani nirgfani commented Feb 7, 2019

Latest improvements:

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

Contribution checklist:

  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and have all been fixed in this PR.
  • The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
  • adding/removing APIs.
  • adding/removing properties.
  • adding/removing API-version.
  • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

nirgfani and others added 30 commits December 31, 2018 15:00
…sight).

This RP is an extension RP of "Microsoft.operationalinsights", and it is coupled to a Log analytics workspace.

This is a first iteration in order to create a simple RP with single endpoint, after it wil work the API will be changed with the actual and full endpoints based on the learnings from this POC.
…eter and reuse it in the PUT same as in the GET
Merging from Azure Repo
* Changing durations to fit standards
* Changing operators to fit other RPs
* Align naming to scheduledAlertRules
* Adding 200 response to DeleteScheduledAlertRule
alertTriggerOperator => triggerOperator
alertTriggerThreshold => triggerThreshold
@majastrz
Copy link
Member

                    "UebaSettings",

Please consider expanding the acronym on the enum value. UserAndEntityBehaviorAnalyticsSettings is probably too much, but BehaviorAnalyticsSettings would improve readability.


Refers to: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:2717 in 36b0f2d. [](commit_id = 36b0f2d, deletion_comment = False)

@majastrz
Copy link
Member

                "description": "Determines whether the tenant .",

Incomplete description


Refers to: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:2768 in 36b0f2d. [](commit_id = 36b0f2d, deletion_comment = False)

@majastrz
Copy link
Member

                "description": "Determines whether UEBA is enabled from MCAS.",

Please expand the acronym.


Refers to: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:2755 in 36b0f2d. [](commit_id = 36b0f2d, deletion_comment = False)

@majastrz
Copy link
Member

                "description": "Determines whether the tenant .",

Also please expand ATP in the description once you add it.


In reply to: 462482230 [](ancestors = 462482230)


Refers to: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:2768 in 36b0f2d. [](commit_id = 36b0f2d, deletion_comment = False)

Copy link
Member

@majastrz majastrz left a comment

Choose a reason for hiding this comment

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

🕐

@ravbhatnagar ravbhatnagar added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Feb 12, 2019
@nirgfani
Copy link
Contributor Author

nirgfani commented Feb 12, 2019

    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases": {

This applies to all the extension resource types: What error message will the user get if they attempt to create the extension resource type at a scope that you don't support (something that's not an LA workspace)?

Refers to: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:516 in 36b0f2d. [](commit_id = 36b0f2d, deletion_comment = False)

@majastrz Without LA workspace it won't exist, in our code we are listening only on request that are being made on Microsoft.OperationalInsights RP-/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalIinsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/cases

@nirgfani
Copy link
Contributor Author

@majastrz, @ravbhatnagar - I see that you both have questions regarding "actions", let's discuss it today on the meeting

@nirgfani
Copy link
Contributor Author

        "x-ms-discriminator-value": "Account",

Have you verified that the SDK generated by the Swagger is capable of deserializing Entities of all kinds?

Refers to: specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json:2446 in 36b0f2d. [](commit_id = 36b0f2d, deletion_comment = False)

What's the different between it and other cases? What's your concern?
How do I run it? I ran the AutoReset and it pass.

Actions will be only nested resource at the moment, so ruleId is not needed currently.
Patterns will be removed so Guid will not be mandatory as parameter.
ruleName will be cahanged to displayName in AlertRules
@ravbhatnagar
Copy link
Contributor

One design feedback needs to be revisited - currently, actions is a child type under alertRules. This means that to associate a webhook, or endpoint with multiple alertRules, multiple child resources of type actions must be created. This will result in management overhead for these resources. In future, service team will support actions under cases resource type as well. And the plan is to add this as a nested resource type under cases as well.
The recommendations were are follows -

  1. Model actions as a top level resource type. and then it could be re-used/associated with any number of alertRules or cases
  2. Model it as a property on the alertRules and cases. This may not be optimal when it needs to be an array and updating will not be straight forward.
    Service team will consider this feedback after the preview release. potentially get feedback from customers and understand more how they use these actions.
    SIgning off from ARM side with this note.

@ravbhatnagar ravbhatnagar 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 WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Feb 13, 2019
Copy link
Member

@jhendrixMSFT jhendrixMSFT left a comment

Choose a reason for hiding this comment

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

The JSON is malformed causing parsing failure, see the log.

package.json Outdated Show resolved Hide resolved
@jhendrixMSFT
Copy link
Member

@nirgfani also is the service deployed and live?

@jhendrixMSFT jhendrixMSFT merged commit 64f1e0e into Azure:master Feb 13, 2019
mccleanp pushed a commit that referenced this pull request Mar 23, 2022
* AvailabilitySet swagger changes and examples

* Using struct for avSet props.

* Updated availability set from array to object

* Changing object to array of objects for vm
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

6 participants