Skip to content

Commit

Permalink
Merge pull request #559 from Ptnan7/cdn-doc-update
Browse files Browse the repository at this point in the history
document update for `az afd origin create`,`az afd endpoint purge`
  • Loading branch information
necusjz authored Sep 9, 2024
2 parents d84079d + c87a4a4 commit f474615
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/afdendpoints/{}/purge", "version": "2024-02-01", "swagger": "mgmt-plane/cdn/ResourceProviders/Microsoft.Cdn/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ2RuL3Byb2ZpbGVzL3twcm9maWxlTmFtZX0vYWZkRW5kcG9pbnRzL3tlbmRwb2ludE5hbWV9L3B1cmdl/V/MjAyNC0wMi0wMQ=="}], "commandGroups": [{"name": "afd endpoint", "commands": [{"name": "purge", "version": "2024-02-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/afdendpoints/{}/purge", "version": "2024-02-01", "swagger": "mgmt-plane/cdn/ResourceProviders/Microsoft.Cdn/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ2RuL3Byb2ZpbGVzL3twcm9maWxlTmFtZX0vYWZkRW5kcG9pbnRzL3tlbmRwb2ludE5hbWV9L3B1cmdl/V/MjAyNC0wMi0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "string", "var": "$Path.endpointName", "options": ["endpoint-name"], "required": true, "idPart": "child_name_1", "help": {"short": "Name of the endpoint under the profile which is unique globally."}}, {"type": "string", "var": "$Path.profileName", "options": ["profile-name"], "required": true, "idPart": "name", "help": {"short": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."}}, {"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}]}, {"name": "Contents", "args": [{"type": "array<string>", "var": "$contents.contentPaths", "options": ["content-paths"], "required": true, "group": "Contents", "help": {"short": "The path to the content to be purged. Can describe a file path or a wild card directory."}, "item": {"type": "string"}}, {"type": "array<string>", "var": "$contents.domains", "options": ["domains"], "group": "Contents", "help": {"short": "List of domains."}, "item": {"type": "string"}}]}], "operations": [{"longRunning": {"finalStateVia": "azure-async-operation"}, "operationId": "AFDEndpoints_PurgeContent", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/purge", "request": {"method": "post", "path": {"params": [{"type": "string", "name": "endpointName", "arg": "$Path.endpointName", "required": true}, {"type": "string", "name": "profileName", "arg": "$Path.profileName", "required": true}, {"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"pattern": "^[-\\w\\._\\(\\)]+$", "maxLength": 90, "minLength": 1}}, {"type": "string", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2024-02-01"}, "type": "string", "name": "api-version", "required": true}]}, "body": {"json": {"schema": {"type": "object", "name": "contents", "required": true, "props": [{"type": "array<string>", "name": "contentPaths", "arg": "$contents.contentPaths", "required": true, "item": {"type": "string"}}, {"type": "array<string>", "name": "domains", "arg": "$contents.domains", "item": {"type": "string"}}], "clientFlatten": true}}}}, "responses": [{"statusCode": [200]}, {"statusCode": [202], "header": {"items": [{"name": "location"}]}}, {"isError": true, "body": {"json": {"schema": {"type": "@MgmtErrorFormat"}}}}]}}], "confirmation": ""}]}]}
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/afdendpoints/{}/purge", "version": "2024-02-01", "swagger": "mgmt-plane/cdn/ResourceProviders/Microsoft.Cdn/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ2RuL3Byb2ZpbGVzL3twcm9maWxlTmFtZX0vYWZkRW5kcG9pbnRzL3tlbmRwb2ludE5hbWV9L3B1cmdl/V/MjAyNC0wMi0wMQ=="}], "commandGroups": [{"name": "afd endpoint", "commands": [{"name": "purge", "version": "2024-02-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/afdendpoints/{}/purge", "version": "2024-02-01", "swagger": "mgmt-plane/cdn/ResourceProviders/Microsoft.Cdn/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ2RuL3Byb2ZpbGVzL3twcm9maWxlTmFtZX0vYWZkRW5kcG9pbnRzL3tlbmRwb2ludE5hbWV9L3B1cmdl/V/MjAyNC0wMi0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "string", "var": "$Path.endpointName", "options": ["endpoint-name"], "required": true, "idPart": "child_name_1", "help": {"short": "Name of the endpoint under the profile which is unique globally."}}, {"type": "string", "var": "$Path.profileName", "options": ["profile-name"], "required": true, "idPart": "name", "help": {"short": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."}}, {"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}]}, {"name": "Contents", "args": [{"type": "array<string>", "var": "$contents.contentPaths", "options": ["content-paths"], "required": true, "group": "Contents", "help": {"short": "The path to the content to be purged. Can describe a file path or a wild card directory."}, "item": {"type": "string"}}, {"type": "array<string>", "var": "$contents.domains", "options": ["domains"], "group": "Contents", "help": {"short": "List of domains. Example: \"www.contoso.com, www.contoso1.com\""}, "item": {"type": "string"}}]}], "operations": [{"longRunning": {"finalStateVia": "azure-async-operation"}, "operationId": "AFDEndpoints_PurgeContent", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/purge", "request": {"method": "post", "path": {"params": [{"type": "string", "name": "endpointName", "arg": "$Path.endpointName", "required": true}, {"type": "string", "name": "profileName", "arg": "$Path.profileName", "required": true}, {"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"pattern": "^[-\\w\\._\\(\\)]+$", "maxLength": 90, "minLength": 1}}, {"type": "string", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2024-02-01"}, "type": "string", "name": "api-version", "required": true}]}, "body": {"json": {"schema": {"type": "object", "name": "contents", "required": true, "props": [{"type": "array<string>", "name": "contentPaths", "arg": "$contents.contentPaths", "required": true, "item": {"type": "string"}}, {"type": "array<string>", "name": "domains", "arg": "$contents.domains", "item": {"type": "string"}}], "clientFlatten": true}}}}, "responses": [{"statusCode": [200]}, {"statusCode": [202], "header": {"items": [{"name": "location"}]}}, {"isError": true, "body": {"json": {"schema": {"type": "@MgmtErrorFormat"}}}}]}}], "confirmation": ""}]}]}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<item type="string"/>
</arg>
<arg type="array<string>" var="$contents.domains" options="domains" group="Contents">
<help short="List of domains."/>
<help short="List of domains. Example: &quot;www.contoso.com, www.contoso1.com&quot;"/>
<item type="string"/>
</arg>
</argGroup>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/endpoints/{}/origins", "version": "2024-02-01", "swagger": "mgmt-plane/cdn/ResourceProviders/Microsoft.Cdn/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ2RuL3Byb2ZpbGVzL3twcm9maWxlTmFtZX0vZW5kcG9pbnRzL3tlbmRwb2ludE5hbWV9L29yaWdpbnM=/V/MjAyNC0wMi0wMQ=="}], "commandGroups": [{"name": "cdn origin", "commands": [{"name": "list", "version": "2024-02-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/endpoints/{}/origins", "version": "2024-02-01", "swagger": "mgmt-plane/cdn/ResourceProviders/Microsoft.Cdn/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ2RuL3Byb2ZpbGVzL3twcm9maWxlTmFtZX0vZW5kcG9pbnRzL3tlbmRwb2ludE5hbWV9L29yaWdpbnM=/V/MjAyNC0wMi0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "string", "var": "$Path.endpointName", "options": ["endpoint-name"], "required": true, "idPart": "child_name_1", "help": {"short": "Name of the endpoint under the profile which is unique globally."}}, {"type": "string", "var": "$Path.profileName", "options": ["profile-name"], "required": true, "idPart": "name", "help": {"short": "Name of the CDN profile which is unique within the resource group."}}, {"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}]}], "operations": [{"operationId": "Origins_ListByEndpoint", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "endpointName", "arg": "$Path.endpointName", "required": true}, {"type": "string", "name": "profileName", "arg": "$Path.profileName", "required": true}, {"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"pattern": "^[-\\w\\._\\(\\)]+$", "maxLength": 90, "minLength": 1}}, {"type": "string", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2024-02-01"}, "type": "string", "name": "api-version", "required": true}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"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.Cdn/profiles/{}/endpoints/{}/origins/{}"}}, {"readOnly": true, "type": "string", "name": "name"}, {"type": "object", "name": "properties", "props": [{"type": "boolean", "name": "enabled"}, {"type": "string", "name": "hostName", "required": true}, {"type": "integer32", "name": "httpPort", "format": {"maximum": 65535, "minimum": 1}}, {"type": "integer32", "name": "httpsPort", "format": {"maximum": 65535, "minimum": 1}}, {"type": "string", "name": "originHostHeader"}, {"type": "integer32", "name": "priority", "format": {"maximum": 5, "minimum": 1}}, {"type": "string", "name": "privateEndpointStatus", "enum": {"items": [{"value": "Approved"}, {"value": "Disconnected"}, {"value": "Pending"}, {"value": "Rejected"}, {"value": "Timeout"}]}}, {"type": "string", "name": "privateLinkAlias"}, {"type": "string", "name": "privateLinkApprovalMessage"}, {"type": "string", "name": "privateLinkLocation"}, {"type": "string", "name": "privateLinkResourceId"}, {"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Creating"}, {"value": "Deleting"}, {"value": "Failed"}, {"value": "Succeeded"}, {"value": "Updating"}]}}, {"readOnly": true, "type": "string", "name": "resourceState", "enum": {"items": [{"value": "Active"}, {"value": "Creating"}, {"value": "Deleting"}]}}, {"type": "integer32", "name": "weight", "format": {"maximum": 1000, "minimum": 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.cdn/profiles/{}/endpoints/{}/origins", "version": "2024-02-01", "swagger": "mgmt-plane/cdn/ResourceProviders/Microsoft.Cdn/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ2RuL3Byb2ZpbGVzL3twcm9maWxlTmFtZX0vZW5kcG9pbnRzL3tlbmRwb2ludE5hbWV9L29yaWdpbnM=/V/MjAyNC0wMi0wMQ=="}], "commandGroups": [{"name": "cdn origin", "commands": [{"name": "list", "version": "2024-02-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.cdn/profiles/{}/endpoints/{}/origins", "version": "2024-02-01", "swagger": "mgmt-plane/cdn/ResourceProviders/Microsoft.Cdn/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ2RuL3Byb2ZpbGVzL3twcm9maWxlTmFtZX0vZW5kcG9pbnRzL3tlbmRwb2ludE5hbWV9L29yaWdpbnM=/V/MjAyNC0wMi0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "string", "var": "$Path.endpointName", "options": ["endpoint-name"], "required": true, "idPart": "child_name_1", "help": {"short": "Name of the endpoint under the profile which is unique globally."}}, {"type": "string", "var": "$Path.profileName", "options": ["profile-name"], "required": true, "idPart": "name", "help": {"short": "Name of the CDN profile which is unique within the resource group."}}, {"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}]}], "operations": [{"operationId": "Origins_ListByEndpoint", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "endpointName", "arg": "$Path.endpointName", "required": true}, {"type": "string", "name": "profileName", "arg": "$Path.profileName", "required": true}, {"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"pattern": "^[-\\w\\._\\(\\)]+$", "maxLength": 90, "minLength": 1}}, {"type": "string", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2024-02-01"}, "type": "string", "name": "api-version", "required": true}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"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.Cdn/profiles/{}/endpoints/{}/origins/{}"}}, {"readOnly": true, "type": "string", "name": "name"}, {"type": "object", "name": "properties", "props": [{"type": "boolean", "name": "enabled"}, {"type": "string", "name": "hostName", "required": true}, {"type": "integer32", "name": "httpPort", "format": {"maximum": 65535, "minimum": 1}}, {"type": "integer32", "name": "httpsPort", "format": {"maximum": 65535, "minimum": 1}}, {"type": "string", "name": "originHostHeader"}, {"type": "integer32", "name": "priority", "format": {"maximum": 5, "minimum": 1}}, {"readOnly": true, "type": "string", "name": "privateEndpointStatus", "enum": {"items": [{"value": "Approved"}, {"value": "Disconnected"}, {"value": "Pending"}, {"value": "Rejected"}, {"value": "Timeout"}]}}, {"type": "string", "name": "privateLinkAlias"}, {"type": "string", "name": "privateLinkApprovalMessage"}, {"type": "string", "name": "privateLinkLocation"}, {"type": "string", "name": "privateLinkResourceId"}, {"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Creating"}, {"value": "Deleting"}, {"value": "Failed"}, {"value": "Succeeded"}, {"value": "Updating"}]}}, {"readOnly": true, "type": "string", "name": "resourceState", "enum": {"items": [{"value": "Active"}, {"value": "Creating"}, {"value": "Deleting"}]}}, {"type": "integer32", "name": "weight", "format": {"maximum": 1000, "minimum": 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"}]}]}]}
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
<prop type="integer32" name="priority">
<format maximum="5" minimum="1"/>
</prop>
<prop type="string" name="privateEndpointStatus">
<prop readOnly="True" type="string" name="privateEndpointStatus">
<enum>
<item value="&quot;Approved&quot;"/>
<item value="&quot;Disconnected&quot;"/>
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
<prop type="integer32" name="priority">
<format maximum="5" minimum="1"/>
</prop>
<prop type="string" name="privateEndpointStatus">
<prop readOnly="True" type="string" name="privateEndpointStatus">
<enum>
<item value="&quot;Approved&quot;"/>
<item value="&quot;Disconnected&quot;"/>
Expand Down Expand Up @@ -299,7 +299,7 @@
<prop type="integer32" name="priority">
<format maximum="5" minimum="1"/>
</prop>
<prop type="string" name="privateEndpointStatus">
<prop readOnly="True" type="string" name="privateEndpointStatus">
<enum>
<item value="&quot;Approved&quot;"/>
<item value="&quot;Disconnected&quot;"/>
Expand Down Expand Up @@ -473,7 +473,7 @@
<prop type="integer32" name="priority">
<format maximum="5" minimum="1"/>
</prop>
<prop type="string" name="privateEndpointStatus">
<prop readOnly="True" type="string" name="privateEndpointStatus">
<enum>
<item value="&quot;Approved&quot;"/>
<item value="&quot;Disconnected&quot;"/>
Expand Down
Loading

0 comments on commit f474615

Please sign in to comment.