Skip to content

refactor: add apic api update example #567

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

Closed
frankqianms wants to merge 1 commit into from
Closed

refactor: add apic api update example #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions Commands/apic/api/_update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ Update existing API.
apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{\"public-facing\":true}'
```

- Update single custom metadata
```bash
az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false
```

### [2024-03-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzL3t9/2024-03-15-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis/{} 2024-03-15-preview -->
Expand Down
30 changes: 18 additions & 12 deletions Commands/tree.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5776,41 +5776,41 @@
"examples": [
{
"commands": [
"apic api list -g contoso-resources -s contoso"
"apic api list -g contoso-resources -n contoso"
],
"name": "List APIs"
},
{
"commands": [
"apic api list -g contoso-resources -n contoso --filter \"kind eq 'rest'\""
],
"name": "List APIs with filter"
}
],
"name": "2024-03-15-preview",
"name": "2024-03-01",
"resources": [
{
"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis",
"plane": "mgmt-plane",
"version": "2024-03-15-preview"
"version": "2024-03-01"
}
]
},
{
"examples": [
{
"commands": [
"apic api list -g contoso-resources -n contoso"
"apic api list -g contoso-resources -s contoso"
],
"name": "List APIs"
},
{
"commands": [
"apic api list -g contoso-resources -n contoso --filter \"kind eq 'rest'\""
],
"name": "List APIs with filter"
}
],
"name": "2024-03-01",
"name": "2024-03-15-preview",
"resources": [
{
"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis",
"plane": "mgmt-plane",
"version": "2024-03-01"
"version": "2024-03-15-preview"
}
]
}
Expand Down Expand Up @@ -5905,6 +5905,12 @@
"apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{\\\"public-facing\\\":true}'"
],
"name": "Update custom properties"
},
{
"commands": [
"az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false"
],
"name": "Update single custom metadata"
}
],
"name": "2024-03-01",
Expand Down
2 changes: 1 addition & 1 deletion ...pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlz/2024-03-15-preview.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis", "version": "2024-03-15-preview", "swagger": "mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vYXBpcw==/V/MjAyNC0wMy0xNS1wcmV2aWV3"}], "commandGroups": [{"name": "apic api", "commands": [{"name": "list", "version": "2024-03-15-preview", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis", "version": "2024-03-15-preview", "swagger": "mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vYXBpcw==/V/MjAyNC0wMy0xNS1wcmV2aWV3"}], "argGroups": [{"name": "", "args": [{"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "string", "var": "$Path.serviceName", "options": ["s", "service", "service-name"], "required": true, "group": "", "idPart": "name", "help": {"short": "The name of the API Center service."}, "format": {"maxLength": 90, "minLength": 1}}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}, {"type": "string", "var": "$Path.workspaceName", "options": ["w", "workspace", "workspace-name"], "required": true, "group": "", "idPart": "child_name_1", "help": {"short": "The name of the workspace."}, "default": {"value": "default"}, "format": {"maxLength": 90, "minLength": 1}}, {"type": "string", "var": "$Query.filter", "options": ["filter"], "help": {"short": "OData filter parameter."}}]}], "operations": [{"operationId": "Apis_List", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"maxLength": 90, "minLength": 1}}, {"type": "string", "name": "serviceName", "arg": "$Path.serviceName", "required": true, "format": {"maxLength": 90, "minLength": 1}}, {"type": "uuid", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}, {"type": "string", "name": "workspaceName", "arg": "$Path.workspaceName", "required": true, "format": {"maxLength": 90, "minLength": 1}}]}, "query": {"params": [{"type": "string", "name": "$filter", "arg": "$Query.filter"}], "consts": [{"readOnly": true, "const": true, "default": {"value": "2024-03-15-preview"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"readOnly": true, "type": "string", "name": "nextLink"}, {"readOnly": true, "type": "array<object>", "name": "value", "item": {"type": "object", "props": [{"readOnly": true, "type": "ResourceId", "name": "id", "format": {"template": "/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiCenter/services/{}/workspaces/{}/apis/{}"}}, {"readOnly": true, "type": "string", "name": "name"}, {"type": "object", "name": "properties", "props": [{"type": "array<object>", "name": "contacts", "item": {"type": "object", "props": [{"type": "string", "name": "email", "format": {"maxLength": 100}}, {"type": "string", "name": "name", "format": {"maxLength": 100}}, {"type": "string", "name": "url", "format": {"maxLength": 200}}]}}, {"type": "object", "name": "customProperties"}, {"type": "string", "name": "description", "format": {"maxLength": 1000}}, {"type": "array<object>", "name": "externalDocumentation", "item": {"type": "object", "props": [{"type": "string", "name": "description", "format": {"maxLength": 500}}, {"type": "string", "name": "title", "format": {"maxLength": 50}}, {"type": "string", "name": "url", "required": true, "format": {"maxLength": 200}}]}}, {"type": "string", "name": "kind", "required": true, "enum": {"items": [{"value": "graphql"}, {"value": "grpc"}, {"value": "rest"}, {"value": "soap"}, {"value": "webhook"}, {"value": "websocket"}]}}, {"type": "object", "name": "license", "props": [{"type": "string", "name": "identifier", "format": {"maxLength": 50}}, {"type": "string", "name": "name", "format": {"maxLength": 100}}, {"type": "string", "name": "url", "format": {"maxLength": 200}}]}, {"type": "string", "name": "lifecycleStage", "enum": {"items": [{"value": "deprecated"}, {"value": "design"}, {"value": "development"}, {"value": "preview"}, {"value": "production"}, {"value": "retired"}, {"value": "testing"}]}}, {"type": "string", "name": "summary", "format": {"maxLength": 200}}, {"type": "object", "name": "termsOfService", "props": [{"type": "string", "name": "url", "required": true, "format": {"maxLength": 200}}]}, {"type": "string", "name": "title", "required": true, "format": {"maxLength": 50, "minLength": 1}}], "clientFlatten": true}, {"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"}]}}]}, {"readOnly": true, "type": "string", "name": "type"}]}}]}}}}, {"isError": true, "body": {"json": {"schema": {"type": "@MgmtErrorFormat"}}}}]}}], "outputs": [{"type": "array", "ref": "$Instance.value", "clientFlatten": true, "nextLink": "$Instance.nextLink"}]}]}]}
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis", "version": "2024-03-15-preview", "swagger": "mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vYXBpcw==/V/MjAyNC0wMy0xNS1wcmV2aWV3"}], "commandGroups": [{"name": "apic api", "commands": [{"name": "list", "version": "2024-03-15-preview", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apis", "version": "2024-03-15-preview", "swagger": "mgmt-plane/apicenter/ResourceProviders/Microsoft.ApiCenter/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQXBpQ2VudGVyL3NlcnZpY2VzL3tzZXJ2aWNlTmFtZX0vd29ya3NwYWNlcy97d29ya3NwYWNlTmFtZX0vYXBpcw==/V/MjAyNC0wMy0xNS1wcmV2aWV3"}], "argGroups": [{"name": "", "args": [{"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "string", "var": "$Path.serviceName", "options": ["s", "service", "service-name"], "required": true, "group": "", "idPart": "name", "help": {"short": "The name of the API Center service."}, "format": {"pattern": "^[a-zA-Z0-9-]{3,90}$", "maxLength": 90, "minLength": 1}}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}, {"type": "string", "var": "$Path.workspaceName", "options": ["w", "workspace", "workspace-name"], "required": true, "group": "", "idPart": "child_name_1", "help": {"short": "The name of the workspace."}, "default": {"value": "default"}, "format": {"pattern": "^[a-zA-Z0-9-]{3,90}$", "maxLength": 90, "minLength": 1}}, {"type": "string", "var": "$Query.filter", "options": ["filter"], "help": {"short": "OData filter parameter."}}]}], "operations": [{"operationId": "Apis_List", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"maxLength": 90, "minLength": 1}}, {"type": "string", "name": "serviceName", "arg": "$Path.serviceName", "required": true, "format": {"pattern": "^[a-zA-Z0-9-]{3,90}$", "maxLength": 90, "minLength": 1}}, {"type": "uuid", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}, {"type": "string", "name": "workspaceName", "arg": "$Path.workspaceName", "required": true, "format": {"pattern": "^[a-zA-Z0-9-]{3,90}$", "maxLength": 90, "minLength": 1}}]}, "query": {"params": [{"type": "string", "name": "$filter", "arg": "$Query.filter"}], "consts": [{"readOnly": true, "const": true, "default": {"value": "2024-03-15-preview"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"readOnly": true, "type": "string", "name": "nextLink"}, {"readOnly": true, "type": "array<object>", "name": "value", "item": {"type": "object", "props": [{"readOnly": true, "type": "ResourceId", "name": "id", "format": {"template": "/subscriptions/{}/resourceGroups/{}/providers/Microsoft.ApiCenter/services/{}/workspaces/{}/apis/{}"}}, {"readOnly": true, "type": "string", "name": "name"}, {"type": "object", "name": "properties", "props": [{"type": "array<object>", "name": "contacts", "item": {"type": "object", "props": [{"type": "string", "name": "email", "format": {"maxLength": 100}}, {"type": "string", "name": "name", "format": {"maxLength": 100}}, {"type": "string", "name": "url", "format": {"maxLength": 200}}]}}, {"type": "object", "name": "customProperties"}, {"type": "string", "name": "description", "format": {"maxLength": 1000}}, {"type": "array<object>", "name": "externalDocumentation", "item": {"type": "object", "props": [{"type": "string", "name": "description", "format": {"maxLength": 500}}, {"type": "string", "name": "title", "format": {"maxLength": 50}}, {"type": "string", "name": "url", "required": true, "format": {"maxLength": 200}}]}}, {"type": "string", "name": "kind", "required": true, "enum": {"items": [{"value": "graphql"}, {"value": "grpc"}, {"value": "rest"}, {"value": "soap"}, {"value": "webhook"}, {"value": "websocket"}]}}, {"type": "object", "name": "license", "props": [{"type": "string", "name": "identifier", "format": {"maxLength": 50}}, {"type": "string", "name": "name", "format": {"maxLength": 100}}, {"type": "string", "name": "url", "format": {"maxLength": 200}}]}, {"readOnly": true, "type": "string", "name": "lifecycleStage", "enum": {"items": [{"value": "deprecated"}, {"value": "design"}, {"value": "development"}, {"value": "preview"}, {"value": "production"}, {"value": "retired"}, {"value": "testing"}]}}, {"type": "string", "name": "summary", "format": {"maxLength": 200}}, {"type": "object", "name": "termsOfService", "props": [{"type": "string", "name": "url", "required": true, "format": {"maxLength": 200}}]}, {"type": "string", "name": "title", "required": true, "format": {"maxLength": 50, "minLength": 1}}], "clientFlatten": true}, {"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"}]}}]}, {"readOnly": true, "type": "string", "name": "type"}]}}]}}}}, {"isError": true, "body": {"json": {"schema": {"type": "@MgmtErrorFormat"}}}}]}}], "outputs": [{"type": "array", "ref": "$Instance.value", "clientFlatten": true, "nextLink": "$Instance.nextLink"}]}]}]}
10 changes: 5 additions & 5 deletions ...1pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlz/2024-03-15-preview.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
<arg type="string" var="$Path.serviceName" options="service-name service s" required="True" group="" idPart="name">
<help short="The name of the API Center service."/>
<format maxLength="90" minLength="1"/>
<format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/>
</arg>
<arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/>
<arg type="string" var="$Path.workspaceName" options="workspace-name workspace w" required="True" group="" idPart="child_name_1">
<help short="The name of the workspace."/>
<default value="&quot;default&quot;"/>
<format maxLength="90" minLength="1"/>
<format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/>
</arg>
<arg type="string" var="$Query.filter" options="filter">
<help short="OData filter parameter."/>
Expand All @@ -28,11 +28,11 @@
<format maxLength="90" minLength="1"/>
</param>
<param type="string" name="serviceName" arg="$Path.serviceName" required="True">
<format maxLength="90" minLength="1"/>
<format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/>
</param>
<param type="uuid" name="subscriptionId" arg="$Path.subscriptionId" required="True"/>
<param type="string" name="workspaceName" arg="$Path.workspaceName" required="True">
<format maxLength="90" minLength="1"/>
<format pattern="^[a-zA-Z0-9-]{3,90}$" maxLength="90" minLength="1"/>
</param>
</path>
<query>
Expand Down Expand Up @@ -106,7 +106,7 @@
<format maxLength="200"/>
</prop>
</prop>
<prop type="string" name="lifecycleStage">
<prop readOnly="True" type="string" name="lifecycleStage">
<enum>
<item value="&quot;deprecated&quot;"/>
<item value="&quot;design&quot;"/>
Expand Down
2 changes: 1 addition & 1 deletion ...zL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzL3t9/2024-03-01.json
View file
Open in desktop

Large diffs are not rendered by default.

Loading