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.

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

Add doc for data-plane dynamic endpoint config #315

Merged
merged 2 commits into from
Nov 30, 2023
+6 −3
Merged

Add doc for data-plane dynamic endpoint config #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aeed4de
Add doc for data-plane dynamic
kairu-ms Nov 30, 2023
59d15b2
Update version in doc
kairu-ms Nov 30, 2023
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
2 changes: 1 addition & 1 deletion docs/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ github:
pypi: https://pypi.org/project/aaz-dev/

# TODO: get version number from github
version: v2.3.0
version: v2.4.0

# Build settings
theme: minima
Expand Down
Binary file added ...assets/recordings/workspace_editor/dataplane_dynamic_endpoint_client_config.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions docs/pages/usage/workspace_editor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,17 @@ In the client configuration, the client `endpoint` and `authorization` mechanism

In workspace you can set two kinds of `endpoint`:

- Template endpoint: The endpoint follows a special template. The template supports using placeholder which is wrapped by `{}`. For example: `https://{keyVaultName}.vault.azure.net`. Those placeholders will generate arguments, which arg group name is 'Client Args', in all commands.
- Dynamic endpoint (Coming soon): The endpoint should be retrieved from a property value in a control plane api response.
- Template endpoint: The endpoint follows a special template. The template supports using placeholder which is wrapped by `{}`. For example: `https://{keyVaultName}.vault.azure.net`. Those placeholders will generate arguments, which arg group name is 'Client Args', in all commands. We support to define endpoint templates of four clouds that is `AzureCloud`, `AzureChinaCloud`, `AzureUSGovernment` and `AzureGermanCloud`. For air-gapped clouds, you should provide the property index in [ARM Cloud Metadata API](https://management.azure.com/metadata/endpoints?api-version=2019-05-01) response.
- Dynamic endpoint: The endpoint is retrieved from a property value in a control plane instance. And the generated client will fetch the property from control plane api as the endpoint for data plane commands. For example, the endpoint of data-plane `Microsoft.Attestation` is retrieved from the `properties.attestUri` property in `Microsoft.Attestation/attestationProvider` instance. So the resource api and the property index should be provided in the client configuration.

For tha `authorization` mechanism, we supports `AAD` auth.

When you try to create command for a new resource-provider of data-plane, the workspace will require you set the client configuration at first.
![new_client_config](../../assets/recordings/workspace_editor/dataplane_new_client_config.gif)

Here's an example of `Microsoft.Attestation` data-plane client configuration using dynamic endpoint.
![dynamic_endpoint_client_config](../../assets/recordings/workspace_editor/dataplane_dynamic_endpoint_client_config.gif)

If you want do some modification in existing client configuration, you can click the `Edit Client Config` button. The change will apply to all the data-plane commands of that resource-provider when you export models from the workspace to aaz.
![edit_client_config](../../assets/recordings/workspace_editor/dataplane_edit_client_config.gif)

Expand Down