From 89eb790f63071fa0595a6f364fa710955f96e99d Mon Sep 17 00:00:00 2001 From: frankqianms Date: Tue, 12 Nov 2024 13:24:59 +0800 Subject: [PATCH] refactor: update --- .../azext_apic_extension/aaz/latest/apic/api/_create.py | 2 ++ .../azext_apic_extension/aaz/latest/apic/api/_update.py | 2 ++ .../aaz/latest/apic/api/deployment/_create.py | 2 ++ .../azext_apic_extension/aaz/latest/apic/metadata/_update.py | 2 ++ 4 files changed, 8 insertions(+) diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_create.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_create.py index 75d776d4a5e..59e5f180b92 100644 --- a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_create.py +++ b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_create.py @@ -22,6 +22,8 @@ class Create(AAZCommand): :example: Create API with custom properties az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{\"public-facing\":true}' + + :example: Create API with custom properties using json file az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json' """ diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_update.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_update.py index 6c9e0cca4bb..16b56d1e986 100644 --- a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_update.py +++ b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_update.py @@ -22,6 +22,8 @@ class Update(AAZCommand): :example: Update custom properties az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{\"public-facing\":true}' + + :example: Update custom properties using json file az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json' :example: Update single custom metadata diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/deployment/_create.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/deployment/_create.py index 215c734e899..2d0b0a5c72b 100644 --- a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/deployment/_create.py +++ b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/deployment/_create.py @@ -19,6 +19,8 @@ class Create(AAZCommand): :example: Create deployment az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{\"runtimeUri\":[\"https://example.com\"]}' + + :example: Create deployment using server json file az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json' """ diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_update.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_update.py index 7e76789e235..5ae23be61eb 100644 --- a/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_update.py +++ b/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_update.py @@ -19,6 +19,8 @@ class Update(AAZCommand): :example: Update schema az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{\"type\":\"string\", \"title\":\"Last name\", \"pattern\": \"^[a-zA-Z0-9]+$\"}' + + :example: Update schema using schema json file az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json' """