Skip to content

ArizeAI CLI commands for Initial release #726

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/arize-ai/observability-eval/organization/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _arize-ai observability-eval organization create_

Create a OrganizationResource

## Versions

### [2024-10-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL2FyaXplYWkub2JzZXJ2YWJpbGl0eWV2YWwvb3JnYW5pemF0aW9ucy97fQ==/2024-10-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/arizeai.observabilityeval/organizations/{} 2024-10-01-preview -->

#### examples

- Organizations_CreateOrUpdate - generated by [MaximumSet] rule
```bash
arize-ai observability-eval organization create --resource-group QM_clitest_qumulo2_eastus --organizationname test-cli-instance-4 --marketplace "{subscription-id: fc35d936-3b89-41f8-8110-a24b56826c37,offer-details:{publisher-id:arizeai1657829589668,offer-id:arize-liftr-0,plan-id:liftr-test-0,plan-name:Liftr Test 0}}" --user "{first-name:"",last-name:"",email-address:[email protected],upn:[email protected]}" --partner-properties "{description:'Test Description'}" --location "East US"
```
16 changes: 16 additions & 0 deletions Commands/arize-ai/observability-eval/organization/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _arize-ai observability-eval organization delete_

Delete a OrganizationResource

## Versions

### [2024-10-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL2FyaXplYWkub2JzZXJ2YWJpbGl0eWV2YWwvb3JnYW5pemF0aW9ucy97fQ==/2024-10-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/arizeai.observabilityeval/organizations/{} 2024-10-01-preview -->

#### examples

- Organizations_Delete - generated by [MaximumSet] rule
```bash
arize-ai observability-eval organization delete --resource-group QM_clitest_qumulo2_eastus --organizationname test-cli-instance-5
```
17 changes: 17 additions & 0 deletions Commands/arize-ai/observability-eval/organization/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Command] _arize-ai observability-eval organization list_

List OrganizationResource resources by resource group

## Versions

### [2024-10-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL2FyaXplYWkub2JzZXJ2YWJpbGl0eWV2YWwvb3JnYW5pemF0aW9ucw==/2024-10-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/arizeai.observabilityeval/organizations 2024-10-01-preview -->
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/arizeai.observabilityeval/organizations 2024-10-01-preview -->

#### examples

- Organizations_ListBySubscription - generated by [MaximumSet] rule
```bash
arize-ai observability-eval organization list --resource-group QM_clitest_qumulo2_eastus
```
16 changes: 16 additions & 0 deletions Commands/arize-ai/observability-eval/organization/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _arize-ai observability-eval organization show_

Get a OrganizationResource

## Versions

### [2024-10-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL2FyaXplYWkub2JzZXJ2YWJpbGl0eWV2YWwvb3JnYW5pemF0aW9ucy97fQ==/2024-10-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/arizeai.observabilityeval/organizations/{} 2024-10-01-preview -->

#### examples

- Organizations_Get - generated by [MaximumSet] rule
```bash
arize-ai observability-eval organization show --resource-group QM_clitest_qumulo2_eastus --organizationname test-cli-instance-5
```
9 changes: 9 additions & 0 deletions Commands/arize-ai/observability-eval/organization/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _arize-ai observability-eval organization update_

Update a OrganizationResource

## Versions

### [2024-10-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL2FyaXplYWkub2JzZXJ2YWJpbGl0eWV2YWwvb3JnYW5pemF0aW9ucy97fQ==/2024-10-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/arizeai.observabilityeval/organizations/{} 2024-10-01-preview -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _arize-ai observability-eval organization identity assign_

Assign the user or system managed identities.

## Versions

### [2024-10-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL2FyaXplYWkub2JzZXJ2YWJpbGl0eWV2YWwvb3JnYW5pemF0aW9ucy97fQ==/2024-10-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/arizeai.observabilityeval/organizations/{} 2024-10-01-preview identity -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _arize-ai observability-eval organization identity remove_

Remove the user or system managed identities.

## Versions

### [2024-10-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL2FyaXplYWkub2JzZXJ2YWJpbGl0eWV2YWwvb3JnYW5pemF0aW9ucy97fQ==/2024-10-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/arizeai.observabilityeval/organizations/{} 2024-10-01-preview identity -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _arize-ai observability-eval organization identity show_

Show the details of managed identities.

## Versions

### [2024-10-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL2FyaXplYWkub2JzZXJ2YWJpbGl0eWV2YWwvb3JnYW5pemF0aW9ucy97fQ==/2024-10-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/arizeai.observabilityeval/organizations/{} 2024-10-01-preview identity -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# [Group] _arize-ai observability-eval organization identity_

Manage Identity

## Commands

- [assign](/Commands/arize-ai/observability-eval/organization/identity/_assign.md)
: Assign the user or system managed identities.

- [remove](/Commands/arize-ai/observability-eval/organization/identity/_remove.md)
: Remove the user or system managed identities.

- [show](/Commands/arize-ai/observability-eval/organization/identity/_show.md)
: Show the details of managed identities.
25 changes: 25 additions & 0 deletions Commands/arize-ai/observability-eval/organization/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# [Group] _arize-ai observability-eval organization_

Manage Organization

## Subgroups

- [identity](/Commands/arize-ai/observability-eval/organization/identity/readme.md)
: Manage Identity

## Commands

- [create](/Commands/arize-ai/observability-eval/organization/_create.md)
: Create a OrganizationResource

- [delete](/Commands/arize-ai/observability-eval/organization/_delete.md)
: Delete a OrganizationResource

- [list](/Commands/arize-ai/observability-eval/organization/_list.md)
: List OrganizationResource resources by resource group

- [show](/Commands/arize-ai/observability-eval/organization/_show.md)
: Get a OrganizationResource

- [update](/Commands/arize-ai/observability-eval/organization/_update.md)
: Update a OrganizationResource
8 changes: 8 additions & 0 deletions Commands/arize-ai/observability-eval/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _arize-ai observability-eval_

Manage Observability Eval

## Subgroups

- [organization](/Commands/arize-ai/observability-eval/organization/readme.md)
: Manage Organization
8 changes: 8 additions & 0 deletions Commands/arize-ai/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _arize-ai_

Manage Arize Ai

## Subgroups

- [observability-eval](/Commands/arize-ai/observability-eval/readme.md)
: Manage Observability Eval
3 changes: 3 additions & 0 deletions Commands/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
- [arcgateway](/Commands/arcgateway/readme.md)
: Manage gateway connection on Arc machine

- [arize-ai](/Commands/arize-ai/readme.md)
: Manage Arize Ai

- [astronomer](/Commands/astronomer/readme.md)
: Manage Azure Astronomer resources.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/providers/arizeai.observabilityeval/organizations", "version": "2024-10-01-preview", "swagger": "mgmt-plane/liftrarize/ResourceProviders/ArizeAi.ObservabilityEval/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9wcm92aWRlcnMvQXJpemVBaS5PYnNlcnZhYmlsaXR5RXZhbC9vcmdhbml6YXRpb25z/V/MjAyNC0xMC0wMS1wcmV2aWV3"}, {"id": "/subscriptions/{}/resourcegroups/{}/providers/arizeai.observabilityeval/organizations", "version": "2024-10-01-preview", "swagger": "mgmt-plane/liftrarize/ResourceProviders/ArizeAi.ObservabilityEval/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9Bcml6ZUFpLk9ic2VydmFiaWxpdHlFdmFsL29yZ2FuaXphdGlvbnM=/V/MjAyNC0xMC0wMS1wcmV2aWV3"}], "commandGroups": [{"name": "arize-ai observability-eval organization", "commands": [{"name": "list", "version": "2024-10-01-preview", "resources": [{"id": "/subscriptions/{}/providers/arizeai.observabilityeval/organizations", "version": "2024-10-01-preview", "swagger": "mgmt-plane/liftrarize/ResourceProviders/ArizeAi.ObservabilityEval/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9wcm92aWRlcnMvQXJpemVBaS5PYnNlcnZhYmlsaXR5RXZhbC9vcmdhbml6YXRpb25z/V/MjAyNC0xMC0wMS1wcmV2aWV3"}, {"id": "/subscriptions/{}/resourcegroups/{}/providers/arizeai.observabilityeval/organizations", "version": "2024-10-01-preview", "swagger": "mgmt-plane/liftrarize/ResourceProviders/ArizeAi.ObservabilityEval/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9Bcml6ZUFpLk9ic2VydmFiaWxpdHlFdmFsL29yZ2FuaXphdGlvbnM=/V/MjAyNC0xMC0wMS1wcmV2aWV3"}], "argGroups": [{"name": "", "args": [{"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "idPart": "resource_group"}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}]}], "conditions": [{"var": "$Condition_Organizations_ListByResourceGroup", "operator": {"type": "and", "operators": [{"type": "hasValue", "arg": "$Path.resourceGroupName"}, {"type": "hasValue", "arg": "$Path.subscriptionId"}]}}, {"var": "$Condition_Organizations_ListBySubscription", "operator": {"type": "and", "operators": [{"type": "hasValue", "arg": "$Path.subscriptionId"}, {"type": "not", "operator": {"type": "hasValue", "arg": "$Path.resourceGroupName"}}]}}], "operations": [{"when": ["$Condition_Organizations_ListByResourceGroup"], "operationId": "Organizations_ListByResourceGroup", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/ArizeAi.ObservabilityEval/organizations", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"maxLength": 90, "minLength": 1}}, {"type": "uuid", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2024-10-01-preview"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"type": "string", "name": "nextLink"}, {"type": "array<object>", "name": "value", "required": true, "item": {"type": "object", "props": [{"readOnly": true, "type": "ResourceId", "name": "id", "format": {"template": "/subscriptions/{}/resourceGroups/{}/providers/ArizeAi.ObservabilityEval/organizations/{}"}}, {"type": "IdentityObject", "name": "identity", "props": [{"readOnly": true, "type": "uuid", "name": "principalId"}, {"readOnly": true, "type": "uuid", "name": "tenantId"}, {"type": "string", "name": "type", "required": true, "enum": {"items": [{"value": "None"}, {"value": "SystemAssigned"}, {"value": "SystemAssigned,UserAssigned"}, {"value": "UserAssigned"}]}}, {"type": "object", "name": "userAssignedIdentities", "additionalProps": {"item": {"nullable": true, "type": "object", "props": [{"readOnly": true, "type": "uuid", "name": "clientId"}, {"readOnly": true, "type": "uuid", "name": "principalId"}]}}}]}, {"type": "ResourceLocation", "name": "location", "required": true}, {"readOnly": true, "type": "string", "name": "name"}, {"type": "object", "name": "properties", "props": [{"type": "object", "name": "marketplace", "required": true, "props": [{"type": "object", "name": "offerDetails", "required": true, "props": [{"type": "string", "name": "offerId", "required": true}, {"type": "string", "name": "planId", "required": true}, {"type": "string", "name": "planName"}, {"type": "string", "name": "publisherId", "required": true}, {"type": "string", "name": "termId"}, {"type": "string", "name": "termUnit"}]}, {"type": "string", "name": "subscriptionId"}, {"readOnly": true, "type": "string", "name": "subscriptionStatus", "enum": {"items": [{"value": "PendingFulfillmentStart"}, {"value": "Subscribed"}, {"value": "Suspended"}, {"value": "Unsubscribed"}]}}]}, {"type": "object", "name": "partnerProperties", "props": [{"type": "string", "name": "description", "required": true, "format": {"pattern": "^[a-zA-Z0-9_\\-.:\\/ ]*$", "maxLength": 200}}]}, {"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Canceled"}, {"value": "Failed"}, {"value": "Succeeded"}]}}, {"type": "object", "name": "singleSignOnProperties", "props": [{"type": "array<string>", "name": "aadDomains", "item": {"type": "string"}}, {"type": "string", "name": "enterpriseAppId"}, {"type": "string", "name": "state", "enum": {"items": [{"value": "Disable"}, {"value": "Enable"}, {"value": "Initial"}]}}, {"type": "string", "name": "type", "required": true, "enum": {"items": [{"value": "OpenId"}, {"value": "Saml"}]}}, {"type": "string", "name": "url"}]}, {"type": "object", "name": "user", "required": true, "props": [{"type": "string", "name": "emailAddress", "format": {"pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$"}}, {"type": "string", "name": "firstName"}, {"type": "string", "name": "lastName"}, {"type": "string", "name": "phoneNumber"}, {"type": "string", "name": "upn"}]}]}, {"readOnly": true, "type": "object", "name": "systemData", "props": [{"type": "dateTime", "name": "createdAt"}, {"type": "string", "name": "createdBy"}, {"type": "string", "name": "createdByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}, {"type": "dateTime", "name": "lastModifiedAt"}, {"type": "string", "name": "lastModifiedBy"}, {"type": "string", "name": "lastModifiedByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}]}, {"type": "object", "name": "tags", "additionalProps": {"item": {"type": "string"}}}, {"readOnly": true, "type": "string", "name": "type"}]}}]}}}}, {"isError": true, "body": {"json": {"schema": {"type": "@MgmtErrorFormat"}}}}]}}, {"when": ["$Condition_Organizations_ListBySubscription"], "operationId": "Organizations_ListBySubscription", "http": {"path": "/subscriptions/{subscriptionId}/providers/ArizeAi.ObservabilityEval/organizations", "request": {"method": "get", "path": {"params": [{"type": "uuid", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2024-10-01-preview"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"type": "string", "name": "nextLink"}, {"type": "array<object>", "name": "value", "required": true, "item": {"type": "object", "props": [{"readOnly": true, "type": "ResourceId", "name": "id", "format": {"template": "/subscriptions/{}/resourceGroups/{}/providers/ArizeAi.ObservabilityEval/organizations/{}"}}, {"type": "IdentityObject", "name": "identity", "props": [{"readOnly": true, "type": "uuid", "name": "principalId"}, {"readOnly": true, "type": "uuid", "name": "tenantId"}, {"type": "string", "name": "type", "required": true, "enum": {"items": [{"value": "None"}, {"value": "SystemAssigned"}, {"value": "SystemAssigned,UserAssigned"}, {"value": "UserAssigned"}]}}, {"type": "object", "name": "userAssignedIdentities", "additionalProps": {"item": {"nullable": true, "type": "object", "props": [{"readOnly": true, "type": "uuid", "name": "clientId"}, {"readOnly": true, "type": "uuid", "name": "principalId"}]}}}]}, {"type": "ResourceLocation", "name": "location", "required": true}, {"readOnly": true, "type": "string", "name": "name"}, {"type": "object", "name": "properties", "props": [{"type": "object", "name": "marketplace", "required": true, "props": [{"type": "object", "name": "offerDetails", "required": true, "props": [{"type": "string", "name": "offerId", "required": true}, {"type": "string", "name": "planId", "required": true}, {"type": "string", "name": "planName"}, {"type": "string", "name": "publisherId", "required": true}, {"type": "string", "name": "termId"}, {"type": "string", "name": "termUnit"}]}, {"type": "string", "name": "subscriptionId"}, {"readOnly": true, "type": "string", "name": "subscriptionStatus", "enum": {"items": [{"value": "PendingFulfillmentStart"}, {"value": "Subscribed"}, {"value": "Suspended"}, {"value": "Unsubscribed"}]}}]}, {"type": "object", "name": "partnerProperties", "props": [{"type": "string", "name": "description", "required": true, "format": {"pattern": "^[a-zA-Z0-9_\\-.:\\/ ]*$", "maxLength": 200}}]}, {"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Canceled"}, {"value": "Failed"}, {"value": "Succeeded"}]}}, {"type": "object", "name": "singleSignOnProperties", "props": [{"type": "array<string>", "name": "aadDomains", "item": {"type": "string"}}, {"type": "string", "name": "enterpriseAppId"}, {"type": "string", "name": "state", "enum": {"items": [{"value": "Disable"}, {"value": "Enable"}, {"value": "Initial"}]}}, {"type": "string", "name": "type", "required": true, "enum": {"items": [{"value": "OpenId"}, {"value": "Saml"}]}}, {"type": "string", "name": "url"}]}, {"type": "object", "name": "user", "required": true, "props": [{"type": "string", "name": "emailAddress", "format": {"pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$"}}, {"type": "string", "name": "firstName"}, {"type": "string", "name": "lastName"}, {"type": "string", "name": "phoneNumber"}, {"type": "string", "name": "upn"}]}]}, {"readOnly": true, "type": "object", "name": "systemData", "props": [{"type": "dateTime", "name": "createdAt"}, {"type": "string", "name": "createdBy"}, {"type": "string", "name": "createdByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}, {"type": "dateTime", "name": "lastModifiedAt"}, {"type": "string", "name": "lastModifiedBy"}, {"type": "string", "name": "lastModifiedByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}]}, {"type": "object", "name": "tags", "additionalProps": {"item": {"type": "string"}}}, {"readOnly": true, "type": "string", "name": "type"}]}}]}}}}, {"isError": true, "body": {"json": {"schema": {"type": "@MgmtErrorFormat"}}}}]}}], "outputs": [{"type": "array", "ref": "$Instance.value", "clientFlatten": true, "nextLink": "$Instance.nextLink"}]}]}]}
Loading