Skip to content
Draft
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/applink/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _applink create_

Create a new AppLink resource

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtzL3t9/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks/{} 2025-08-01-preview -->

#### examples

- Create an AppLink resource
```bash
applink create --resource-group test_rg --app-link-name applink-test-01
```
16 changes: 16 additions & 0 deletions Commands/applink/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _applink delete_

Delete an AppLink

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtzL3t9/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks/{} 2025-08-01-preview -->

#### examples

- Delete an AppLink resource
```bash
applink delete --resource-group test_rg --app-link-name applink-test-01
```
21 changes: 21 additions & 0 deletions Commands/applink/_list-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _applink list-versions_

List available AppLink versions by location

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2xvY2F0aW9ucy97fS9hdmFpbGFibGV2ZXJzaW9ucw==/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.applink/locations/{}/availableversions 2025-08-01-preview -->

#### examples

- List AppLink versions in westus2
```bash
applink list-versions --location westus2
```

- List compatible AppLink versions with K8S 1.28 on westus2
```bash
applink list-versions --location westus2 --kubernetes-version 1.28
```
27 changes: 27 additions & 0 deletions Commands/applink/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# [Command] _applink list_

List AppLink resources

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtz/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.applink/applinks 2025-08-01-preview -->
<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks 2025-08-01-preview -->

#### examples

- List AppLinks in the default subscription
```bash
applink list
```

- List AppLinks in an specific subscription
```bash
applink list --subscription 00000
```

- List AppLinks in a resource group
```bash
applink list --resource-group test_rg
```
16 changes: 16 additions & 0 deletions Commands/applink/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _applink show_

Get an AppLink

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtzL3t9/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks/{} 2025-08-01-preview -->

#### examples

- Get an AppLink resource
```bash
applink show --resource-group test_rg --app-link-name applink-test-01
```
16 changes: 16 additions & 0 deletions Commands/applink/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _applink update_

Update an AppLink resource

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtzL3t9/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks/{} 2025-08-01-preview -->

#### examples

- Update tags of an AppLink resource
```bash
applink update --resource-group test_rg --applink-name applink-test-01 --tags "{key2913:test_tag}"
```
21 changes: 21 additions & 0 deletions Commands/applink/member/_join.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# [Command] _applink member join_

Join a kubernetes cluster to an AppLink

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtzL3t9L2FwcGxpbmttZW1iZXJzL3t9/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks/{}/applinkmembers/{} 2025-08-01-preview -->

#### examples

- Add an AKS cluster to an AppLink on FullyManaged mode
```bash
applink member join --resource-group test_rg --applink-name applink-test-01 --member-name member-01 --cluster-type AKS --member-resource-id /subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/applink-rg/providers/Microsoft.ContainerService/managedClusters/applink-member1 --upgrade-mode FullyManaged --release-channel Stable --member-location westus2
```

- Add an AKS cluster to an AppLink on FullyManaged mode
```bash
applink member join --resource-group test_rg --applink-name applink-test-01 --member-name member-01 --cluster-type AKS --member-resource-id /subscriptions/bc7e0da9-5e4c-4a91-9252-9658837006cf/resourcegroups/applink-rg/providers/Microsoft.ContainerService/managedClusters/applink-member1 --upgrade-mode SelfManaged --version 1.27 --member-location westus2
```
16 changes: 16 additions & 0 deletions Commands/applink/member/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _applink member list_

List members of an AppLink resource

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtzL3t9L2FwcGxpbmttZW1iZXJz/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks/{}/applinkmembers 2025-08-01-preview -->

#### examples

- List members of an AppLink resource
```bash
applink member list --resource-group test_rg --applink-name applink-test-01
```
16 changes: 16 additions & 0 deletions Commands/applink/member/_remove.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _applink member remove_

Removes a member from an AppLink

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtzL3t9L2FwcGxpbmttZW1iZXJzL3t9/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks/{}/applinkmembers/{} 2025-08-01-preview -->

#### examples

- Delete an AppLink member
```bash
applink member remove --resource-group test_rg --applink-name applink-test-01 --member-name member-01
```
16 changes: 16 additions & 0 deletions Commands/applink/member/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _applink member show_

Get a member of an AppLink resource

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtzL3t9L2FwcGxpbmttZW1iZXJzL3t9/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks/{}/applinkmembers/{} 2025-08-01-preview -->

#### examples

- Get an AppLink member
```bash
applink member show --resource-group test_rg --applink-name applink-test-01 --member-name member-01
```
16 changes: 16 additions & 0 deletions Commands/applink/member/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _applink member update_

Update an AppLink member resource

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtzL3t9L2FwcGxpbmttZW1iZXJzL3t9/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks/{}/applinkmembers/{} 2025-08-01-preview -->

#### examples

- Update the release channel of an applink member
```bash
applink member update --resource-group test_rg --applink-name applink-test-01 --member-name member-01 --release-channel Stable
```
25 changes: 25 additions & 0 deletions Commands/applink/member/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# [Group] _applink member_

Manage App Link Member

## Subgroups

- [upgrade-history](/Commands/applink/member/upgrade-history/readme.md)
: Get all version changes of an applink member

## Commands

- [join](/Commands/applink/member/_join.md)
: Join a kubernetes cluster to an AppLink

- [list](/Commands/applink/member/_list.md)
: List members of an AppLink resource

- [remove](/Commands/applink/member/_remove.md)
: Removes a member from an AppLink

- [show](/Commands/applink/member/_show.md)
: Get a member of an AppLink resource

- [update](/Commands/applink/member/_update.md)
: Update an AppLink member resource
16 changes: 16 additions & 0 deletions Commands/applink/member/upgrade-history/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _applink member upgrade-history list_

List the upgrade history of an AppLink member

## Versions

### [2025-08-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcHBsaW5rL2FwcGxpbmtzL3t9L2FwcGxpbmttZW1iZXJzL3t9L3VwZ3JhZGVoaXN0b3JpZXM=/2025-08-01-preview.xml) **Experimental**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks/{}/applinkmembers/{}/upgradehistories 2025-08-01-preview -->

#### examples

- List upgrade history of an AppLink member
```bash
applink member upgrade-history list --resource-group test_rg --applink-name applink-test-01 --member-name member-01
```
8 changes: 8 additions & 0 deletions Commands/applink/member/upgrade-history/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _applink member upgrade-history_

Get all version changes of an applink member

## Commands

- [list](/Commands/applink/member/upgrade-history/_list.md)
: List the upgrade history of an AppLink member
28 changes: 28 additions & 0 deletions Commands/applink/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# [Group] _applink_

Manage App Link

## Subgroups

- [member](/Commands/applink/member/readme.md)
: Manage App Link Member

## Commands

- [create](/Commands/applink/_create.md)
: Create a new AppLink resource

- [delete](/Commands/applink/_delete.md)
: Delete an AppLink

- [list](/Commands/applink/_list.md)
: List AppLink resources

- [list-versions](/Commands/applink/_list-versions.md)
: List available AppLink versions by location

- [show](/Commands/applink/_show.md)
: Get an AppLink

- [update](/Commands/applink/_update.md)
: Update an AppLink resource
3 changes: 3 additions & 0 deletions Commands/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
- [apic](/Commands/apic/readme.md)
: Manage Azure API Center services

- [applink](/Commands/applink/readme.md)
: Manage App Link

- [arc](/Commands/arc/readme.md)
: Manage Azure Arc Machines.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/providers/microsoft.applink/applinks", "version": "2025-08-01-preview", "swagger": "mgmt-plane/applink/ResourceProviders/Microsoft.AppLink/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9wcm92aWRlcnMvTWljcm9zb2Z0LkFwcExpbmsvYXBwTGlua3M=/V/MjAyNS0wOC0wMS1wcmV2aWV3"}, {"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks", "version": "2025-08-01-preview", "swagger": "mgmt-plane/applink/ResourceProviders/Microsoft.AppLink/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBwTGluay9hcHBMaW5rcw==/V/MjAyNS0wOC0wMS1wcmV2aWV3"}], "commandGroups": [{"name": "applink", "commands": [{"name": "list", "version": "2025-08-01-preview", "resources": [{"id": "/subscriptions/{}/providers/microsoft.applink/applinks", "version": "2025-08-01-preview", "swagger": "mgmt-plane/applink/ResourceProviders/Microsoft.AppLink/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9wcm92aWRlcnMvTWljcm9zb2Z0LkFwcExpbmsvYXBwTGlua3M=/V/MjAyNS0wOC0wMS1wcmV2aWV3"}, {"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.applink/applinks", "version": "2025-08-01-preview", "swagger": "mgmt-plane/applink/ResourceProviders/Microsoft.AppLink/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBwTGluay9hcHBMaW5rcw==/V/MjAyNS0wOC0wMS1wcmV2aWV3"}], "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_AppLinks_ListBySubscription", "operator": {"type": "and", "operators": [{"type": "hasValue", "arg": "$Path.subscriptionId"}, {"type": "not", "operator": {"type": "hasValue", "arg": "$Path.resourceGroupName"}}]}}, {"var": "$Condition_AppLinks_ListByResourceGroup", "operator": {"type": "and", "operators": [{"type": "hasValue", "arg": "$Path.resourceGroupName"}, {"type": "hasValue", "arg": "$Path.subscriptionId"}]}}], "operations": [{"when": ["$Condition_AppLinks_ListBySubscription"], "operationId": "AppLinks_ListBySubscription", "http": {"path": "/subscriptions/{subscriptionId}/providers/Microsoft.AppLink/appLinks", "request": {"method": "get", "path": {"params": [{"type": "uuid", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2025-08-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/Microsoft.AppLink/appLinks/{}"}}, {"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": [{"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Accepted"}, {"value": "Canceled"}, {"value": "Deleting"}, {"value": "Failed"}, {"value": "Provisioning"}, {"value": "Succeeded"}, {"value": "Updating"}]}}]}, {"readOnly": true, "type": "object", "name": "systemData", "props": [{"type": "dateTime", "name": "createdAt", "format": {"protocol": "iso"}}, {"type": "string", "name": "createdBy"}, {"type": "string", "name": "createdByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}, {"type": "dateTime", "name": "lastModifiedAt", "format": {"protocol": "iso"}}, {"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_AppLinks_ListByResourceGroup"], "operationId": "AppLinks_ListByResourceGroup", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/appLinks", "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": "2025-08-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/Microsoft.AppLink/appLinks/{}"}}, {"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": [{"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Accepted"}, {"value": "Canceled"}, {"value": "Deleting"}, {"value": "Failed"}, {"value": "Provisioning"}, {"value": "Succeeded"}, {"value": "Updating"}]}}]}, {"readOnly": true, "type": "object", "name": "systemData", "props": [{"type": "dateTime", "name": "createdAt", "format": {"protocol": "iso"}}, {"type": "string", "name": "createdBy"}, {"type": "string", "name": "createdByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}, {"type": "dateTime", "name": "lastModifiedAt", "format": {"protocol": "iso"}}, {"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