Skip to content

Add command models for Change Analysis CLI #1

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.

Sign up for GitHub

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

Merged
kairu-ms merged 1 commit into from
Jun 10, 2022
Merged

Add command models for Change Analysis CLI #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Commands/change-analysis/_list-by-resource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _change-analysis list-by-resource_

List the changes of a resource within the specified time range. Customer data will be masked if the user doesn't have access.

## Versions

### [2021-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZWlkfS9wcm92aWRlcnMvbWljcm9zb2Z0LmNoYW5nZWFuYWx5c2lzL3Jlc291cmNlY2hhbmdlcw==/2021-04-01.xml) **Preview**

<!-- mgmt-plane /{resourceid}/providers/microsoft.changeanalysis/resourcechanges 2021-04-01 -->

#### examples

- List the changes of a resource within the specified time range
```bash
change-analysis list-by-resource -r [ResourceId] --start-time '05/24/2022 8:43:36' --end-time '05/25/2022 9:46:36'
```
22 changes: 22 additions & 0 deletions Commands/change-analysis/_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# [Command] _change-analysis list_

List the changes of resources in the subscription within the specified time range. Customer data will always be masked.

## Versions

### [2021-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFuZ2VhbmFseXNpcy9jaGFuZ2Vz/2021-04-01.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.changeanalysis/changes 2021-04-01 -->
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.changeanalysis/changes 2021-04-01 -->

#### examples

- List the changes of a subscription within the specific time range
```bash
change-analysis list --start-time '05/24/2022 8:43:36' --end-time '05/25/2022 9:46:36'
```

- List the changes of a resource group within the specific time range
```bash
change-analysis list -g [ResourceGroup] --start-time '05/24/2022 8:43:36' --end-time '05/25/2022 9:46:36'
```
11 changes: 11 additions & 0 deletions Commands/change-analysis/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# [Group] _change-analysis_

List changes for resources

## Commands

- [list](/Commands/change-analysis/_list.md)
: List the changes of resources in the subscription within the specified time range. Customer data will always be masked.

- [list-by-resource](/Commands/change-analysis/_list-by-resource.md)
: List the changes of a resource within the specified time range. Customer data will be masked if the user doesn't have access.
6 changes: 6 additions & 0 deletions Commands/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Atomic Azure CLI Commands

## Groups

- [change-analysis](/Commands/change-analysis/readme.md)
: List changes for resources
90 changes: 90 additions & 0 deletions Commands/tree.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
{
"root": {
"commandGroups": {
"change-analysis": {
"commands": {
"list": {
"help": {
"short": "List the changes of resources in the subscription within the specified time range. Customer data will always be masked."
},
"names": [
"change-analysis",
"list"
],
"versions": [
{
"examples": [
{
"commands": [
"change-analysis list --start-time '05/24/2022 8:43:36' --end-time '05/25/2022 9:46:36'"
],
"name": "List the changes of a subscription within the specific time range"
},
{
"commands": [
"change-analysis list -g [ResourceGroup] --start-time '05/24/2022 8:43:36' --end-time '05/25/2022 9:46:36'"
],
"name": "List the changes of a resource group within the specific time range"
}
],
"name": "2021-04-01",
"resources": [
{
"id": "/subscriptions/{}/providers/microsoft.changeanalysis/changes",
"plane": "mgmt-plane",
"version": "2021-04-01"
},
{
"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.changeanalysis/changes",
"plane": "mgmt-plane",
"version": "2021-04-01"
}
],
"stage": "Preview"
}
]
},
"list-by-resource": {
"help": {
"short": "List the changes of a resource within the specified time range. Customer data will be masked if the user doesn't have access."
},
"names": [
"change-analysis",
"list-by-resource"
],
"versions": [
{
"examples": [
{
"commands": [
"change-analysis list-by-resource -r [ResourceId] --start-time '05/24/2022 8:43:36' --end-time '05/25/2022 9:46:36'"
],
"name": "List the changes of a resource within the specified time range"
}
],
"name": "2021-04-01",
"resources": [
{
"id": "/{resourceid}/providers/microsoft.changeanalysis/resourcechanges",
"plane": "mgmt-plane",
"version": "2021-04-01"
}
],
"stage": "Preview"
}
]
}
},
"help": {
"short": "List changes for resources"
},
"names": [
"change-analysis"
]
}
},
"names": [
"aaz"
]
}
}
220 changes: 220 additions & 0 deletions ...NjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFuZ2VhbmFseXNpcy9jaGFuZ2Vz/2021-04-01.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
<?xml version='1.0' encoding='utf-8'?>
<CodeGen plane="mgmt-plane">
<resource id="/subscriptions/{}/providers/microsoft.changeanalysis/changes" version="2021-04-01" swagger="mgmt-plane/changeanalysis/ResourceProviders/Microsoft.ChangeAnalysis/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9wcm92aWRlcnMvTWljcm9zb2Z0LkNoYW5nZUFuYWx5c2lzL2NoYW5nZXM=/V/MjAyMS0wNC0wMQ=="/>
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.changeanalysis/changes" version="2021-04-01" swagger="mgmt-plane/changeanalysis/ResourceProviders/Microsoft.ChangeAnalysis/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ2hhbmdlQW5hbHlzaXMvY2hhbmdlcw==/V/MjAyMS0wNC0wMQ=="/>
<commandGroup name="change-analysis">
<command name="list" version="2021-04-01">
<resource id="/subscriptions/{}/providers/microsoft.changeanalysis/changes" version="2021-04-01" swagger="mgmt-plane/changeanalysis/ResourceProviders/Microsoft.ChangeAnalysis/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9wcm92aWRlcnMvTWljcm9zb2Z0LkNoYW5nZUFuYWx5c2lzL2NoYW5nZXM=/V/MjAyMS0wNC0wMQ=="/>
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.changeanalysis/changes" version="2021-04-01" swagger="mgmt-plane/changeanalysis/ResourceProviders/Microsoft.ChangeAnalysis/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ2hhbmdlQW5hbHlzaXMvY2hhbmdlcw==/V/MjAyMS0wNC0wMQ=="/>
<argGroup name="">
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g"/>
<arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True"/>
<arg type="dateTime" var="$Query.endTime" options="end-time" required="True">
<help short="Specifies the end time of the changes request."/>
</arg>
<arg type="string" var="$Query.skipToken" options="skip-token">
<help short="A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls."/>
</arg>
<arg type="dateTime" var="$Query.startTime" options="start-time" required="True">
<help short="Specifies the start time of the changes request."/>
</arg>
</argGroup>
<condition var="$Condition_Changes_ListChangesByResourceGroup">
<operator type="and">
<operator type="hasValue" arg="$Path.resourceGroupName"/>
<operator type="hasValue" arg="$Path.subscriptionId"/>
<operator type="hasValue" arg="$Query.endTime"/>
<operator type="hasValue" arg="$Query.startTime"/>
</operator>
</condition>
<condition var="$Condition_Changes_ListChangesBySubscription">
<operator type="and">
<operator type="hasValue" arg="$Path.subscriptionId"/>
<operator type="hasValue" arg="$Query.endTime"/>
<operator type="hasValue" arg="$Query.startTime"/>
<operator type="not">
<operator type="hasValue" arg="$Path.resourceGroupName"/>
</operator>
</operator>
</condition>
<operation when="$Condition_Changes_ListChangesByResourceGroup" operationId="Changes_ListChangesByResourceGroup">
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ChangeAnalysis/changes">
<request method="get">
<path>
<param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True">
<format maxLength="90" minLength="1"/>
</param>
<param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True">
<format minLength="1"/>
</param>
</path>
<query>
<param type="dateTime" name="$endTime" arg="$Query.endTime" required="True"/>
<param type="string" name="$skipToken" arg="$Query.skipToken"/>
<param type="dateTime" name="$startTime" arg="$Query.startTime" required="True"/>
<const readOnly="True" const="True" type="string" name="api-version" required="True">
<default value="2021-04-01"/>
<format minLength="1"/>
</const>
</query>
</request>
<response statusCode="200">
<body>
<json var="$Instance">
<schema type="object">
<prop type="string" name="nextLink"/>
<prop type="array<object>" name="value">
<item type="object">
<prop readOnly="True" type="string" name="id"/>
<prop readOnly="True" type="string" name="name"/>
<prop type="object" name="properties">
<prop type="string" name="changeType">
<enum>
<item value="Add"/>
<item value="Remove"/>
<item value="Update"/>
</enum>
</prop>
<prop type="array<string>" name="initiatedByList">
<item type="string"/>
</prop>
<prop type="array<object>" name="propertyChanges">
<item type="object">
<prop type="string" name="changeCategory">
<enum>
<item value="System"/>
<item value="User"/>
</enum>
</prop>
<prop type="string" name="changeType">
<enum>
<item value="Add"/>
<item value="Remove"/>
<item value="Update"/>
</enum>
</prop>
<prop type="string" name="description"/>
<prop type="string" name="displayName"/>
<prop type="boolean" name="isDataMasked"/>
<prop type="string" name="jsonPath"/>
<prop type="string" name="level">
<enum>
<item value="Important"/>
<item value="Noisy"/>
<item value="Normal"/>
</enum>
</prop>
<prop type="string" name="newValue"/>
<prop type="string" name="oldValue"/>
</item>
</prop>
<prop type="string" name="resourceId"/>
<prop type="dateTime" name="timeStamp"/>
</prop>
<prop readOnly="True" type="string" name="type"/>
</item>
</prop>
</schema>
</json>
</body>
</response>
<response isError="True">
<body>
<json>
<schema type="@MgmtErrorFormat"/>
</json>
</body>
</response>
</http>
</operation>
<operation when="$Condition_Changes_ListChangesBySubscription" operationId="Changes_ListChangesBySubscription">
<http path="/subscriptions/{subscriptionId}/providers/Microsoft.ChangeAnalysis/changes">
<request method="get">
<path>
<param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True">
<format minLength="1"/>
</param>
</path>
<query>
<param type="dateTime" name="$endTime" arg="$Query.endTime" required="True"/>
<param type="string" name="$skipToken" arg="$Query.skipToken"/>
<param type="dateTime" name="$startTime" arg="$Query.startTime" required="True"/>
<const readOnly="True" const="True" type="string" name="api-version" required="True">
<default value="2021-04-01"/>
<format minLength="1"/>
</const>
</query>
</request>
<response statusCode="200">
<body>
<json var="$Instance">
<schema type="object">
<prop type="string" name="nextLink"/>
<prop type="array<object>" name="value">
<item type="object">
<prop readOnly="True" type="string" name="id"/>
<prop readOnly="True" type="string" name="name"/>
<prop type="object" name="properties">
<prop type="string" name="changeType">
<enum>
<item value="Add"/>
<item value="Remove"/>
<item value="Update"/>
</enum>
</prop>
<prop type="array<string>" name="initiatedByList">
<item type="string"/>
</prop>
<prop type="array<object>" name="propertyChanges">
<item type="object">
<prop type="string" name="changeCategory">
<enum>
<item value="System"/>
<item value="User"/>
</enum>
</prop>
<prop type="string" name="changeType">
<enum>
<item value="Add"/>
<item value="Remove"/>
<item value="Update"/>
</enum>
</prop>
<prop type="string" name="description"/>
<prop type="string" name="displayName"/>
<prop type="boolean" name="isDataMasked"/>
<prop type="string" name="jsonPath"/>
<prop type="string" name="level">
<enum>
<item value="Important"/>
<item value="Noisy"/>
<item value="Normal"/>
</enum>
</prop>
<prop type="string" name="newValue"/>
<prop type="string" name="oldValue"/>
</item>
</prop>
<prop type="string" name="resourceId"/>
<prop type="dateTime" name="timeStamp"/>
</prop>
<prop readOnly="True" type="string" name="type"/>
</item>
</prop>
</schema>
</json>
</body>
</response>
<response isError="True">
<body>
<json>
<schema type="@MgmtErrorFormat"/>
</json>
</body>
</response>
</http>
</operation>
<output type="array" ref="$Instance.value" clientFlatten="True" nextLink="$Instance.nextLink"/>
</command>
</commandGroup>
</CodeGen>
1 change: 1 addition & 0 deletions ...1cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFuZ2VhbmFseXNpcy9jaGFuZ2Vz/2021-04-01.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reference [/subscriptions/{}/providers/microsoft.changeanalysis/changes 2021-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jaGFuZ2VhbmFseXNpcy9jaGFuZ2Vz/2021-04-01.xml)
Loading