workspace_api_export
Creates, updates, deletes, gets or lists a workspace_api_export resource.
Overview
| Name | workspace_api_export |
| Type | Resource |
| Id | azure.api_management.workspace_api_export |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
id | string | ResourceId of the API which was exported. |
format | string | Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes. Known values are: "swagger-link-json", "wadl-link-json", "wsdl-link+xml", and "openapi-link". (swagger-link-json, wadl-link-json, wsdl-link+xml, openapi-link) |
value | object | The object defining the schema of the exported API Detail. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | resource_group_name, service_name, workspace_id, api_id, subscription_id, format, export | Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_id | string | API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. Required. |
export | string | Query parameter required to export the API details. "true" Required. |
format | string | Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes. Known values are: "swagger-link", "wsdl-link", "wadl-link", "openapi-link", and "openapi+json-link". Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
service_name | string | The name of the API Management service. Required. |
subscription_id | string | |
workspace_id | string | Workspace identifier. Must be unique in the current API Management service instance. Required. |
SELECT examples
- get
Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.
SELECT
id,
format,
value
FROM azure.api_management.workspace_api_export
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND workspace_id = '{{ workspace_id }}' -- required
AND api_id = '{{ api_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND format = '{{ format }}' -- required
AND export = '{{ export }}' -- required
;