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 ba6583bcc9f..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,9 @@ 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' """ _aaz_info = { 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 5d95d1df547..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 @@ -23,6 +23,9 @@ 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 az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false """ 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 d9f83bb4b45..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,9 @@ 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' """ _aaz_info = { diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_create.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_create.py index f7ec27b4b2c..df6f7d22687 100644 --- a/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_create.py +++ b/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_create.py @@ -22,6 +22,9 @@ class Create(AAZCommand): :example: Create metadata example 2 az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name testregion --schema '{\"type\":\"string\",\"title\":\"testregion\",\"oneOf\":[{\"const\":\"Region1\",\"description\":\"\"},{\"const\":\"Region2\",\"description\":\"\"},{\"const\":\"Region3\",\"description\":\"\"}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]' + + :example: Create metadata using json file schema and assignments example + az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test" --schema '@schema.json' --assignments '@assignments.json' """ _aaz_info = { 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 38974e1a22b..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,9 @@ 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' """ _aaz_info = {