Skip to content
Merged
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/mongo-db/atlas/organization/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _mongo-db atlas organization create_

Create an Azure resource that provisions a corresponding MongoDB Atlas organization

## Versions

### [2024-11-18-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21vbmdvZGIuYXRsYXMvb3JnYW5pemF0aW9ucy97fQ==/2024-11-18-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/mongodb.atlas/organizations/{} 2024-11-18-preview -->

#### examples

- Organizations_CreateOrUpdate
```bash
mongo-db atlas organization create -name "MyOrganizationResourceName" --resource-group "MyResourceGroup" --location "eastus" --subscription "abcd1234-5678-90ab-cdef-12345678abcd"--user {"first-name":"John","last-name":"Doe","email-address":"test@email.com"}" --marketplace "{"subscription-id":"abcd1234-5678-90ab-cdef-12345678abcd","offer-details":{"publisher-id":"mongodb","offer-id":"mongodb_atlas_azure_native_prod","plan-id":"private_plan","plan-name":"Pay as You Go (Free) (Private)","term-unit":"P1M","term-id":"gmz7xq9ge3py"}}" --partner-properties "{"organization-name":"partner-org-name"}"
```
16 changes: 16 additions & 0 deletions Commands/mongo-db/atlas/organization/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _mongo-db atlas organization delete_

Delete the Azure resource linked to a MongoDB Atlas organization

## Versions

### [2024-11-18-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21vbmdvZGIuYXRsYXMvb3JnYW5pemF0aW9ucy97fQ==/2024-11-18-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/mongodb.atlas/organizations/{} 2024-11-18-preview -->

#### examples

- Organizations_Delete
```bash
mongo-db atlas organization delete --subscription "abcd1234-5678-90ab-cdef-12345678abcd" --resource-group "MyResourceGroup" -name "MyOrganizationResourceName"
```
17 changes: 17 additions & 0 deletions Commands/mongo-db/atlas/organization/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Command] _mongo-db atlas organization list_

List all Azure resources representing MongoDB Atlas organizations under the current subscription

## Versions

### [2024-11-18-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21vbmdvZGIuYXRsYXMvb3JnYW5pemF0aW9ucw==/2024-11-18-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/providers/mongodb.atlas/organizations 2024-11-18-preview -->
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/mongodb.atlas/organizations 2024-11-18-preview -->

#### examples

- Organizations_ListBySubscription
```bash
mongo-db atlas organization list --subscription "abcd1234-5678-90ab-cdef-12345678abcd" --resource-group "MyResourceGroup"
```
16 changes: 16 additions & 0 deletions Commands/mongo-db/atlas/organization/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _mongo-db atlas organization show_

Retrieve details of the Azure resource associated with a MongoDB Atlas organization

## Versions

### [2024-11-18-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21vbmdvZGIuYXRsYXMvb3JnYW5pemF0aW9ucy97fQ==/2024-11-18-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/mongodb.atlas/organizations/{} 2024-11-18-preview -->

#### examples

- Organizations_Get
```bash
mongo-db atlas organization show --subscription "abcd1234-5678-90ab-cdef-12345678abcd" --resource-group "MyResourceGroup" -name "MyOrganizationResourceName"
```
17 changes: 17 additions & 0 deletions Commands/mongo-db/atlas/organization/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Group] _mongo-db atlas organization_

Manage Azure resources that represent MongoDB Atlas organizations

## Commands

- [create](/Commands/mongo-db/atlas/organization/_create.md)
: Create an Azure resource that provisions a corresponding MongoDB Atlas organization

- [delete](/Commands/mongo-db/atlas/organization/_delete.md)
: Delete the Azure resource linked to a MongoDB Atlas organization

- [list](/Commands/mongo-db/atlas/organization/_list.md)
: List all Azure resources representing MongoDB Atlas organizations under the current subscription

- [show](/Commands/mongo-db/atlas/organization/_show.md)
: Retrieve details of the Azure resource associated with a MongoDB Atlas organization
8 changes: 8 additions & 0 deletions Commands/mongo-db/atlas/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _mongo-db atlas_

Manage MongoDB Atlas

## Subgroups

- [organization](/Commands/mongo-db/atlas/organization/readme.md)
: Manage Azure resources that represent MongoDB Atlas organizations
8 changes: 8 additions & 0 deletions Commands/mongo-db/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _mongo-db_

Manage MongoDB

## Subgroups

- [atlas](/Commands/mongo-db/atlas/readme.md)
: Manage MongoDB Atlas
3 changes: 3 additions & 0 deletions Commands/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,9 @@
- [mobile-network](/Commands/mobile-network/readme.md)
: Manage mobile network

- [mongo-db](/Commands/mongo-db/readme.md)
: Manage MongoDB

- [monitor](/Commands/monitor/readme.md)
: Manage the Azure Monitor Service.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/providers/mongodb.atlas/organizations", "version": "2024-11-18-preview", "swagger": "mgmt-plane/liftrmongodb/ResourceProviders/MongoDB.Atlas/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9wcm92aWRlcnMvTW9uZ29EQi5BdGxhcy9vcmdhbml6YXRpb25z/V/MjAyNC0xMS0xOC1wcmV2aWV3"}, {"id": "/subscriptions/{}/resourcegroups/{}/providers/mongodb.atlas/organizations", "version": "2024-11-18-preview", "swagger": "mgmt-plane/liftrmongodb/ResourceProviders/MongoDB.Atlas/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9Nb25nb0RCLkF0bGFzL29yZ2FuaXphdGlvbnM=/V/MjAyNC0xMS0xOC1wcmV2aWV3"}], "commandGroups": [{"name": "mongo-db atlas organization", "commands": [{"name": "list", "version": "2024-11-18-preview", "resources": [{"id": "/subscriptions/{}/providers/mongodb.atlas/organizations", "version": "2024-11-18-preview", "swagger": "mgmt-plane/liftrmongodb/ResourceProviders/MongoDB.Atlas/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9wcm92aWRlcnMvTW9uZ29EQi5BdGxhcy9vcmdhbml6YXRpb25z/V/MjAyNC0xMS0xOC1wcmV2aWV3"}, {"id": "/subscriptions/{}/resourcegroups/{}/providers/mongodb.atlas/organizations", "version": "2024-11-18-preview", "swagger": "mgmt-plane/liftrmongodb/ResourceProviders/MongoDB.Atlas/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9Nb25nb0RCLkF0bGFzL29yZ2FuaXphdGlvbnM=/V/MjAyNC0xMS0xOC1wcmV2aWV3"}], "argGroups": [{"name": "", "args": [{"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "group": "", "idPart": "resource_group", "help": {"short": "Name of the Azure resource group in which MongoDB Atlas resource is created"}}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "group": "", "idPart": "subscription", "help": {"short": "Azure subscription id"}}]}], "conditions": [{"var": "$Condition_Organizations_ListBySubscription", "operator": {"type": "and", "operators": [{"type": "hasValue", "arg": "$Path.subscriptionId"}, {"type": "not", "operator": {"type": "hasValue", "arg": "$Path.resourceGroupName"}}]}}, {"var": "$Condition_Organizations_ListByResourceGroup", "operator": {"type": "and", "operators": [{"type": "hasValue", "arg": "$Path.resourceGroupName"}, {"type": "hasValue", "arg": "$Path.subscriptionId"}]}}], "operations": [{"when": ["$Condition_Organizations_ListBySubscription"], "operationId": "Organizations_ListBySubscription", "http": {"path": "/subscriptions/{subscriptionId}/providers/MongoDB.Atlas/organizations", "request": {"method": "get", "path": {"params": [{"type": "uuid", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2024-11-18-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/MongoDB.Atlas/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", "required": true}, {"readOnly": true, "type": "string", "name": "subscriptionStatus", "enum": {"items": [{"value": "PendingFulfillmentStart"}, {"value": "Subscribed"}, {"value": "Suspended"}, {"value": "Unsubscribed"}]}}]}, {"type": "object", "name": "partnerProperties", "props": [{"type": "string", "name": "organizationId"}, {"type": "string", "name": "organizationName", "required": true, "format": {"pattern": "^[a-zA-Z0-9 _\\-().,:@+&',]{1,64}$", "maxLength": 64, "minLength": 1}}, {"type": "string", "name": "redirectUrl"}]}, {"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Canceled"}, {"value": "Failed"}, {"value": "Succeeded"}]}}, {"type": "object", "name": "user", "required": true, "props": [{"type": "string", "name": "companyName"}, {"type": "string", "name": "emailAddress", "required": true, "format": {"pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$"}}, {"type": "string", "name": "firstName", "required": true}, {"type": "string", "name": "lastName", "required": true}, {"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_ListByResourceGroup"], "operationId": "Organizations_ListByResourceGroup", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/MongoDB.Atlas/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-11-18-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/MongoDB.Atlas/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", "required": true}, {"readOnly": true, "type": "string", "name": "subscriptionStatus", "enum": {"items": [{"value": "PendingFulfillmentStart"}, {"value": "Subscribed"}, {"value": "Suspended"}, {"value": "Unsubscribed"}]}}]}, {"type": "object", "name": "partnerProperties", "props": [{"type": "string", "name": "organizationId"}, {"type": "string", "name": "organizationName", "required": true, "format": {"pattern": "^[a-zA-Z0-9 _\\-().,:@+&',]{1,64}$", "maxLength": 64, "minLength": 1}}, {"type": "string", "name": "redirectUrl"}]}, {"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Canceled"}, {"value": "Failed"}, {"value": "Succeeded"}]}}, {"type": "object", "name": "user", "required": true, "props": [{"type": "string", "name": "companyName"}, {"type": "string", "name": "emailAddress", "required": true, "format": {"pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$"}}, {"type": "string", "name": "firstName", "required": true}, {"type": "string", "name": "lastName", "required": true}, {"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"}], "confirmation": ""}]}]}
Loading