swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector ProductApiLink API schemes: - https tags: - name: ProductApiLink paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/apiLinks : get: tags: - ProductApiLink operationId: microsoftAzureWorkspaceproductapilinkListbyproduct description: Lists a collection of the API links associated with a product. x-ms-examples: ApiManagementListWorkspaceProductApiLinks: $ref: ./examples/ApiManagementListWorkspaceProductApiLinks.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/ProductIdParameter - name: $filter in: query required: false type: string description: '| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
' - $ref: ./apimanagement.json#/parameters/TopQueryParameter - $ref: ./apimanagement.json#/parameters/SkipQueryParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: The response body contains a collection of API link entities in the product. schema: $ref: ./definitions.json#/definitions/ProductApiLinkCollection default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-odata: ./definitions.json#/definitions/ProductApiLinkContract summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Products Productid Apilinks ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/products/{productId}/apiLinks/{apiLinkId} : get: tags: - ProductApiLink operationId: microsoftAzureWorkspaceproductapilinkGet description: Gets the API link for the product. x-ms-examples: ApiManagementGetWorkspaceProductApiLink: $ref: ./examples/ApiManagementGetWorkspaceProductApiLink.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/ProductIdParameter - $ref: ./apimanagement.json#/parameters/ProductApiLinkIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: The response body contains the specified API link entity. schema: $ref: ./definitions.json#/definitions/ProductApiLinkContract headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Products Productid Apilinks Apilinkid put: tags: - ProductApiLink operationId: microsoftAzureWorkspaceproductapilinkCreateorupdate description: Adds an API to the specified product via link. x-ms-examples: ApiManagementCreateWorkspaceProductApiLink: $ref: ./examples/ApiManagementCreateWorkspaceProductApiLink.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/ProductIdParameter - $ref: ./apimanagement.json#/parameters/ProductApiLinkIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - name: parameters in: body required: true schema: $ref: ./definitions.json#/definitions/ProductApiLinkContract description: Create or update parameters. responses: '200': description: The specified API is already added to the product. schema: $ref: ./definitions.json#/definitions/ProductApiLinkContract '201': description: The API was successfully added to the product. schema: $ref: ./definitions.json#/definitions/ProductApiLinkContract default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Products Productid Apilinks Apilinkid delete: tags: - ProductApiLink operationId: microsoftAzureWorkspaceproductapilinkDelete description: Deletes the specified API from the specified product. x-ms-examples: ApiManagementDeleteWorkspaceProductApiLink: $ref: ./examples/ApiManagementDeleteWorkspaceProductApiLink.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: ./apimanagement.json#/parameters/ServiceNameParameter - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter - $ref: ./apimanagement.json#/parameters/ProductIdParameter - $ref: ./apimanagement.json#/parameters/ProductApiLinkIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: API was successfully removed from product '204': description: API successfully removed by previous request or does not exist in product default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Products Productid Apilinks Apilinkid x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'