swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector ApiPolicy API schemes: - https tags: - name: ApiPolicy paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies : get: tags: - ApiPolicy operationId: microsoftAzureWorkspaceapipolicyListbyapi description: Get the policy configuration at the API level. x-ms-examples: ApiManagementListWorkspaceApiPolicies: $ref: ./examples/ApiManagementListWorkspaceApiPolicies.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/ApiIdRevParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Apis Policy Collection. schema: $ref: ./definitions.json#/definitions/PolicyCollection default: description: Error response describing why the operation failed. schema: $ref: ./apimanagement.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid Policies ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}/policies/{policyId} : head: tags: - ApiPolicy operationId: microsoftAzureWorkspaceapipolicyGetentitytag description: Gets the entity state (Etag) version of the API policy specified by its identifier. x-ms-examples: ApiManagementHeadWorkspaceApiPolicy: $ref: ./examples/ApiManagementHeadWorkspaceApiPolicy.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/ApiIdRevParameter - $ref: ./apimanagement.json#/parameters/PolicyIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Specified API Policy entity exists and current entity state version is present in the ETag header. 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 Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid Policies Policyid get: tags: - ApiPolicy operationId: microsoftAzureWorkspaceapipolicyGet description: Get the policy configuration at the API level. x-ms-examples: ApiManagementGetWorkspaceApiPolicy: $ref: ./examples/ApiManagementGetWorkspaceApiPolicy.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/ApiIdRevParameter - $ref: ./apimanagement.json#/parameters/PolicyIdParameter - $ref: ./apimanagement.json#/parameters/PolicyExportFormat - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Api Policy information. schema: $ref: ./definitions.json#/definitions/PolicyContract 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 Apis Apiid Policies Policyid put: tags: - ApiPolicy operationId: microsoftAzureWorkspaceapipolicyCreateorupdate description: Creates or updates policy configuration for the API. x-ms-examples: ApiManagementCreateWorkspaceApiPolicy: $ref: ./examples/ApiManagementCreateWorkspaceApiPolicy.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/ApiIdRevParameter - $ref: ./apimanagement.json#/parameters/PolicyIdParameter - name: parameters in: body required: true schema: $ref: ./definitions.json#/definitions/PolicyContract description: The policy contents to apply. - $ref: ./apimanagement.json#/parameters/IfMatchOptionalParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Api policy configuration of the tenant was successfully updated. schema: $ref: ./definitions.json#/definitions/PolicyContract headers: ETag: description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. type: string '201': description: Api policy configuration was successfully created. schema: $ref: ./definitions.json#/definitions/PolicyContract 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 Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Apis Apiid Policies Policyid delete: tags: - ApiPolicy operationId: microsoftAzureWorkspaceapipolicyDelete description: Deletes the policy configuration at the Api. x-ms-examples: ApiManagementDeleteWorkspaceApiPolicy: $ref: ./examples/ApiManagementDeleteWorkspaceApiPolicy.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/ApiIdRevParameter - $ref: ./apimanagement.json#/parameters/PolicyIdParameter - $ref: ./apimanagement.json#/parameters/IfMatchRequiredParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Successfully deleted the policy configuration at the API level. '204': description: Successfully deleted the policy configuration at the API level. 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 Apis Apiid Policies Policyid x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'