swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Endpoints API schemes: - https tags: - name: Endpoints paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints : get: tags: - Endpoints description: Get DigitalTwinsInstance Endpoints. operationId: microsoftAzureDigitaltwinsendpointList x-ms-examples: Get a DigitalTwinsInstance endpoints: $ref: ./examples/DigitalTwinsEndpointsGet_example.json x-ms-pageable: nextLinkName: nextLink parameters: - $ref: '#/parameters/api-version' - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/resourceName' responses: '200': description: The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null. schema: $ref: '#/definitions/DigitalTwinsEndpointResourceListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Digitaltwins Digitaltwinsinstances Resourcename Endpoints ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName} : get: tags: - Endpoints description: Get DigitalTwinsInstances Endpoint. operationId: microsoftAzureDigitaltwinsendpointGet x-ms-examples: Get a DigitalTwinsInstance endpoint: $ref: ./examples/DigitalTwinsEndpointGet_example.json parameters: - $ref: '#/parameters/api-version' - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/endpointName' responses: '200': description: The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null. schema: $ref: '#/definitions/DigitalTwinsEndpointResource' default: description: Default error response schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Digitaltwins Digitaltwinsinstances Resourcename Endpoints Endpointname put: tags: - Endpoints description: Create or update DigitalTwinsInstance endpoint. operationId: microsoftAzureDigitaltwinsendpointCreateorupdate x-ms-long-running-operation: true x-ms-examples: Put a DigitalTwinsInstance resource: $ref: ./examples/DigitalTwinsEndpointPut_example.json parameters: - $ref: '#/parameters/api-version' - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/endpointName' - name: endpointDescription in: body description: The DigitalTwinsInstance endpoint metadata and security metadata. required: true schema: $ref: '#/definitions/DigitalTwinsEndpointResource' responses: '200': description: This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state. schema: $ref: '#/definitions/DigitalTwinsEndpointResource' '201': description: Created - Put request accepted; the operation will complete asynchronously. schema: $ref: '#/definitions/DigitalTwinsEndpointResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Digitaltwins Digitaltwinsinstances Resourcename Endpoints Endpointname delete: tags: - Endpoints description: Delete a DigitalTwinsInstance endpoint. operationId: microsoftAzureDigitaltwinsendpointDelete x-ms-long-running-operation: true x-ms-examples: Delete a DigitalTwinsInstance endpoint: $ref: ./examples/DigitalTwinsEndpointDelete_example.json parameters: - $ref: '#/parameters/api-version' - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/resourceName' - $ref: '#/parameters/endpointName' responses: '200': description: This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state. '202': description: Accepted - Delete request accepted; the operation will complete asynchronously. schema: $ref: '#/definitions/DigitalTwinsEndpointResource' '204': description: Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the DigitalTwins service metadata in the service and the status of the delete operation is set to a completed state. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Digitaltwins Digitaltwinsinstances Resourcename Endpoints Endpointname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints : get: tags: - Endpoints description: Lists existing CDN endpoints. operationId: microsoftAzureEndpointsListbyprofile x-ms-examples: Endpoints_ListByProfile: $ref: ./examples/Endpoints_ListByProfile.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/EndpointListResult' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName} : get: tags: - Endpoints description: Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. operationId: microsoftAzureEndpointsGet x-ms-examples: Endpoints_Get: $ref: ./examples/Endpoints_Get.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - name: endpointName in: path description: Name of the endpoint under the profile which is unique globally. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Endpoint' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname put: tags: - Endpoints description: Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. operationId: microsoftAzureEndpointsCreate x-ms-examples: Endpoints_Create: $ref: ./examples/Endpoints_Create.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - name: endpointName in: path description: Name of the endpoint under the profile which is unique globally. required: true type: string - name: endpoint in: body description: Endpoint properties required: true schema: $ref: '#/definitions/Endpoint' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Endpoint' '201': description: Created. The request has been fulfilled and a new endpoint has been created. schema: $ref: '#/definitions/Endpoint' '202': description: Accepted and the operation will complete asynchronously. headers: location: type: string schema: $ref: '#/definitions/Endpoint' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname patch: tags: - Endpoints description: Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation. operationId: microsoftAzureEndpointsUpdate x-ms-examples: Endpoints_Update: $ref: ./examples/Endpoints_Update.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - name: endpointName in: path description: Name of the endpoint under the profile which is unique globally. required: true type: string - name: endpointUpdateProperties in: body description: Endpoint update properties required: true schema: $ref: '#/definitions/EndpointUpdateParameters' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Endpoint' '202': description: Accepted and the operation will complete asynchronously headers: location: type: string schema: $ref: '#/definitions/Endpoint' default: description: CDN error response describing why the operation failed schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname delete: tags: - Endpoints description: Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. operationId: microsoftAzureEndpointsDelete x-ms-examples: Endpoints_Delete: $ref: ./examples/Endpoints_Delete.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - name: endpointName in: path description: Name of the endpoint under the profile which is unique globally. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. '202': description: Accepted and the operation will complete asynchronously. headers: location: type: string '204': description: No Content. The request has been accepted but the endpoint was not found. default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start : post: tags: - Endpoints description: Starts an existing CDN endpoint that is on a stopped state. operationId: microsoftAzureEndpointsStart x-ms-examples: Endpoints_Start: $ref: ./examples/Endpoints_Start.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - name: endpointName in: path description: Name of the endpoint under the profile which is unique globally. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Endpoint' '202': description: Accepted and the operation will complete asynchronously. headers: location: type: string schema: $ref: '#/definitions/Endpoint' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Start ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop : post: tags: - Endpoints description: Stops an existing running CDN endpoint. operationId: microsoftAzureEndpointsStop x-ms-examples: Endpoints_Stop: $ref: ./examples/Endpoints_Stop.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - name: endpointName in: path description: Name of the endpoint under the profile which is unique globally. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Endpoint' '202': description: Accepted and the operation will complete asynchronously. headers: location: type: string schema: $ref: '#/definitions/Endpoint' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Stop ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge : post: tags: - Endpoints description: Removes a content from CDN. operationId: microsoftAzureEndpointsPurgecontent x-ms-examples: Endpoints_PurgeContent: $ref: ./examples/Endpoints_PurgeContent.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - name: endpointName in: path description: Name of the endpoint under the profile which is unique globally. required: true type: string - name: contentFilePaths in: body description: The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory. required: true schema: $ref: '#/definitions/PurgeParameters' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. '202': description: Accepted and the operation will complete asynchronously. headers: location: type: string default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Purge ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load : post: tags: - Endpoints description: Pre-loads a content to CDN. Available for Verizon Profiles. operationId: microsoftAzureEndpointsLoadcontent x-ms-examples: Endpoints_LoadContent: $ref: ./examples/Endpoints_LoadContent.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - name: endpointName in: path description: Name of the endpoint under the profile which is unique globally. required: true type: string - name: contentFilePaths in: body description: 'The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png'' which loads a single file ' required: true schema: $ref: '#/definitions/LoadParameters' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. '202': description: Accepted and the operation will complete asynchronously. headers: location: type: string default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Load ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain : post: tags: - Endpoints description: Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS. operationId: microsoftAzureEndpointsValidatecustomdomain x-ms-examples: Endpoints_ValidateCustomDomain: $ref: ./examples/Endpoints_ValidateCustomDomain.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - name: endpointName in: path description: Name of the endpoint under the profile which is unique globally. required: true type: string - name: customDomainProperties in: body description: Custom domain to be validated. required: true schema: $ref: '#/definitions/ValidateCustomDomainInput' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/ValidateCustomDomainOutput' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Validatecustomdomain ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage : post: tags: - Endpoints description: Checks the quota and usage of geo filters and custom domains under the given endpoint. operationId: microsoftAzureEndpointsListresourceusage x-ms-examples: Endpoints_ListResourceUsage: $ref: ./examples/Endpoints_ListResourceUsage.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the CDN profile which is unique within the resource group. required: true type: string - name: endpointName in: path description: Name of the endpoint under the profile which is unique globally. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/ResourceUsageListResult' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Checkresourceusage /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints: get: tags: - Endpoints description: List of endpoints to the target resource. operationId: microsoftAzureEndpointsList produces: - application/json x-ms-examples: HybridConnectivityEndpointsGet: $ref: ./examples/EndpointsList.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ResourceUriParameter' responses: '200': description: List of endpoints. schema: $ref: '#/definitions/EndpointsList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse deprecated: false x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Resourceuri Providers Microsoft Hybridconnectivity Endpoints /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}: get: tags: - Endpoints description: Gets the endpoint to the resource. operationId: microsoftAzureEndpointsGet produces: - application/json x-ms-examples: HybridConnectivityEndpointsGetDefault: $ref: ./examples/EndpointsGetDefault.json HybridConnectivityEndpointsGetCustom: $ref: ./examples/EndpointsGetCustom.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ResourceUriParameter' - $ref: '#/parameters/EndpointNameParameter' responses: '200': description: Endpoint details schema: $ref: '#/definitions/EndpointResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse deprecated: false summary: Microsoft Azure Get Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname put: tags: - Endpoints description: Create or update the endpoint to the target resource. operationId: microsoftAzureEndpointsCreateorupdate produces: - application/json x-ms-examples: HybridConnectivityEndpointsPutDefault: $ref: ./examples/EndpointsPutDefault.json HybridConnectivityEndpointsPutCustom: $ref: ./examples/EndpointsPutCustom.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ResourceUriParameter' - $ref: '#/parameters/EndpointNameParameter' - name: EndpointResource description: Endpoint details in: body required: true schema: $ref: '#/definitions/EndpointResource' responses: '200': description: Endpoint details. schema: $ref: '#/definitions/EndpointResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname patch: tags: - Endpoints description: Update the endpoint to the target resource. operationId: microsoftAzureEndpointsUpdate produces: - application/json x-ms-examples: HybridConnectivityEndpointsPatchDefault: $ref: ./examples/EndpointsPatchDefault.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ResourceUriParameter' - $ref: '#/parameters/EndpointNameParameter' - name: EndpointResource description: Endpoint details in: body required: true schema: $ref: '#/definitions/EndpointResource' responses: '200': description: Endpoint resource. schema: $ref: '#/definitions/EndpointResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Patch Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname delete: tags: - Endpoints description: Deletes the endpoint access to the target resource. operationId: microsoftAzureEndpointsDelete produces: - application/json x-ms-examples: HybridConnectivityEndpointsDeleteDefault: $ref: ./examples/EndpointsDeleteDefault.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ResourceUriParameter' - $ref: '#/parameters/EndpointNameParameter' responses: '200': description: The endpoint is deleted successfully. '204': description: The endpoint has been deleted already. default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listCredentials: post: tags: - Endpoints description: Gets the endpoint access credentials to the resource. operationId: microsoftAzureEndpointsListcredentials produces: - application/json x-ms-examples: HybridConnectivityEndpointsPostListCredentials: $ref: ./examples/EndpointsPostListCredentials.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ResourceUriParameter' - $ref: '#/parameters/EndpointNameParameter' - $ref: '#/parameters/AccessTokenExpirationParameter' responses: '200': description: Endpoint access credentials schema: $ref: '#/definitions/EndpointAccessResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse deprecated: false summary: Microsoft Azure Post Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname Listcredentials /{resourceUri}/providers/Microsoft.HybridConnectivity/endpoints/{endpointName}/listManagedProxyDetails: post: tags: - Endpoints description: 'Fetches the managed proxy details ' operationId: microsoftAzureEndpointsListmanagedproxydetails produces: - application/json x-ms-examples: HybridConnectivityEndpointsPostListManagedProxyDetails: $ref: ./examples/EndpointsPostListManagedProxyDetails.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/ResourceUriParameter' - $ref: '#/parameters/EndpointNameParameter' - name: ManagedProxyRequest in: body required: true schema: $ref: '#/definitions/ManagedProxyRequest' description: Object of type ManagedProxyRequest responses: '200': description: Managed Proxy schema: $ref: '#/definitions/ManagedProxyResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse deprecated: false summary: Microsoft Azure Post Resourceuri Providers Microsoft Hybridconnectivity Endpoints Endpointname Listmanagedproxydetails ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints : get: tags: - Endpoints operationId: microsoftAzureEndpointsList description: Lists all Endpoints in a Storage Mover. x-ms-examples: Endpoints_List: $ref: ./examples/Endpoints_List.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageMoverNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The list of Endpoints. schema: $ref: '#/definitions/EndpointList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Endpoints ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/endpoints/{endpointName} : get: tags: - Endpoints operationId: microsoftAzureEndpointsGet description: Gets an Endpoint resource. x-ms-examples: Endpoints_Get: $ref: ./examples/Endpoints_Get.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageMoverNameParameter' - $ref: '#/parameters/EndpointNameParameter_2' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The Endpoint resource. schema: $ref: '#/definitions/Endpoint_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Endpoints Endpointname put: tags: - Endpoints operationId: microsoftAzureEndpointsCreateorupdate description: Creates or updates an Endpoint resource, which represents a data transfer source or destination. x-ms-examples: Endpoints_CreateOrUpdate: $ref: ./examples/Endpoints_CreateOrUpdate.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageMoverNameParameter' - $ref: '#/parameters/EndpointNameParameter_2' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: endpoint in: body required: true schema: $ref: '#/definitions/Endpoint_2' responses: '200': description: Successfully PUT Endpoint resource. schema: $ref: '#/definitions/Endpoint_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Endpoints Endpointname patch: tags: - Endpoints operationId: microsoftAzureEndpointsUpdate description: Updates properties for an Endpoint resource. Properties not specified in the request body will be unchanged. x-ms-examples: Endpoints_Update: $ref: ./examples/Endpoints_Update.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageMoverNameParameter' - $ref: '#/parameters/EndpointNameParameter_2' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: endpoint in: body required: true schema: $ref: '#/definitions/EndpointBaseUpdateParameters' responses: '200': description: The Endpoint resource. schema: $ref: '#/definitions/Endpoint_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Endpoints Endpointname delete: tags: - Endpoints operationId: microsoftAzureEndpointsDelete description: Deletes an Endpoint resource. x-ms-examples: Endpoints_Delete: $ref: ./examples/Endpoints_Delete.json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/StorageMoverNameParameter' - $ref: '#/parameters/EndpointNameParameter_2' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: Successfully deleted Endpoint. '202': description: Accepted. Endpoint delete operation is ongoing. '204': description: NoContent -- Endpoint does not exist for this Storage Mover. default: description: Error response describing why delete operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagemover Storagemovers Storagemovername Endpoints Endpointname definitions: DeepCreatedCustomDomain: description: Custom domains created on the CDN endpoint. type: object required: - name properties: name: description: Custom domain name. type: string properties: x-ms-client-flatten: true $ref: '#/definitions/DeepCreatedCustomDomainProperties' ValidateCustomDomainInput: description: Input of the custom domain to be validated for DNS mapping. type: object required: - hostName properties: hostName: description: The host name of the custom domain. Must be a domain name. type: string EndpointsList: description: The list of endpoints. type: object properties: nextLink: description: The link used to get the next page of endpoints list. type: string value: description: The list of endpoint. type: array items: $ref: '#/definitions/EndpointResource' ExternalResource: description: Definition of a Resource. type: object properties: id: readOnly: true type: string description: The resource identifier. name: readOnly: true type: string description: Extension resource name. pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$ type: readOnly: true type: string description: The resource type. EndpointResource: description: The endpoint for the target resource. type: object allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource properties: systemData: description: System data of endpoint resource $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData x-ms-client-flatten: true properties: description: The endpoint properties. $ref: '#/definitions/EndpointProperties_2' x-ms-client-flatten: true EndpointBaseUpdateParameters: description: The Endpoint resource. type: object properties: properties: $ref: '#/definitions/EndpointBaseUpdateProperties' EndpointAccessResource: description: The endpoint access for the target resource. type: object properties: relay: $ref: '#/definitions/RelayNamespaceAccessProperties' x-ms-client-flatten: true DeliveryRuleCondition: description: A condition for the delivery rule. discriminator: name required: - name properties: name: description: The name of the condition for the delivery rule. type: string enum: - RemoteAddress - RequestMethod - QueryString - PostArgs - RequestUri - RequestHeader - RequestBody - RequestScheme - UrlPath - UrlFileExtension - UrlFileName - HttpVersion - Cookies - IsDevice - SocketAddr - ClientPort - ServerPort - HostName - SslProtocol x-ms-enum: name: MatchVariable modelAsString: true DeepCreatedOriginGroupProperties: description: Properties of the origin group created on the CDN endpoint. type: object required: - origins properties: healthProbeSettings: description: Health probe settings to the origin that is used to determine the health of the origin. type: object $ref: '#/definitions/HealthProbeParameters' origins: description: The source of the content being delivered via CDN within given origin group. type: array items: description: A reference to a origin. $ref: '#/definitions/ResourceReference' trafficRestorationTimeToHealedOrNewEndpointsInMinutes: description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. type: integer format: int32 maximum: 50 minimum: 0 responseBasedOriginErrorDetectionSettings: description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. type: object $ref: '#/definitions/ResponseBasedOriginErrorDetectionParameters' x-ms-azure-resource: false Resource: description: The core properties of ARM resources properties: id: description: Resource ID. readOnly: true type: string name: description: Resource name. readOnly: true type: string type: description: Resource type. readOnly: true type: string systemData: $ref: '#/definitions/SystemData' readOnly: true x-ms-azure-resource: true ErrorResponse_2: title: Error response description: Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message. type: object properties: error: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail EndpointPropertiesUpdateParameters: description: The JSON object containing endpoint update parameters. properties: originPath: description: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. type: string contentTypesToCompress: description: List of content types on which compression applies. The value should be a valid MIME type. type: array items: type: string originHostHeader: description: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. type: string isCompressionEnabled: description: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. type: boolean isHttpAllowed: description: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. type: boolean default: true isHttpsAllowed: description: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. type: boolean default: true queryStringCachingBehavior: description: Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. $ref: '#/definitions/QueryStringCachingBehavior' default: NotSet optimizationType: description: Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. $ref: '#/definitions/OptimizationType' probePath: description: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. type: string geoFilters: description: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ type: array items: $ref: '#/definitions/GeoFilter' x-ms-identifiers: [] defaultOriginGroup: description: A reference to the origin group. type: object $ref: '#/definitions/ResourceReference' urlSigningKeys: description: List of keys used to validate the signed URL hashes. type: array items: $ref: '#/definitions/UrlSigningKey' x-ms-identifiers: - keyId deliveryPolicy: description: A policy that specifies the delivery rules to be used for an endpoint. type: object required: - rules properties: description: description: User-friendly description of the policy. type: string rules: description: A list of the delivery rules. type: array items: $ref: '#/definitions/DeliveryRule' x-ms-identifiers: - name webApplicationFirewallPolicyLink: description: Defines the Web Application Firewall policy for the endpoint (if applicable) type: object properties: id: type: string description: Resource ID. TrackedResource: description: The resource model definition for a ARM tracked top level resource. allOf: - $ref: '#/definitions/Resource' properties: location: type: string description: Resource location. tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags. required: - location DeepCreatedOrigin: description: The main origin of CDN content which is added when creating a CDN endpoint. type: object required: - name properties: name: description: 'Origin name which must be unique within the endpoint. ' type: string properties: x-ms-client-flatten: true $ref: '#/definitions/DeepCreatedOriginProperties' x-ms-azure-resource: false PrivateEndpointStatus: description: The approval status for the connection to the Private Link type: string enum: - Pending - Approved - Rejected - Disconnected - Timeout x-ms-enum: name: PrivateEndpointStatus modelAsString: true DeepCreatedCustomDomainProperties: description: Properties of the custom domain created on the CDN endpoint. type: object required: - hostName properties: hostName: description: The host name of the custom domain. Must be a domain name. type: string validationData: description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. type: string DigitalTwinsEndpointResourceListResult: description: A list of DigitalTwinsInstance Endpoints with a next link. type: object properties: nextLink: description: The link used to get the next page of DigitalTwinsInstance Endpoints. type: string value: description: A list of DigitalTwinsInstance Endpoints. type: array items: $ref: '#/definitions/DigitalTwinsEndpointResource' EndpointList: description: List of Endpoints. type: object properties: value: type: array items: $ref: '#/definitions/Endpoint_2' readOnly: true nextLink: type: string description: Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size. readOnly: true LoadParameters: type: object description: Parameters required for content load. required: - contentPaths properties: contentPaths: description: The path to the content to be loaded. Path should be a relative file URL of the origin. type: array items: type: string DigitalTwinsEndpointResource: description: DigitalTwinsInstance endpoint resource. x-ms-azure-resource: true allOf: - $ref: '#/definitions/ExternalResource' properties: properties: description: DigitalTwinsInstance endpoint resource properties. $ref: '#/definitions/DigitalTwinsEndpointResourceProperties' EndpointProperties: description: The JSON object that contains the properties required to create an endpoint. required: - origins allOf: - $ref: '#/definitions/EndpointPropertiesUpdateParameters' properties: hostName: description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net type: string readOnly: true origins: description: The source of the content being delivered via CDN. type: array items: $ref: '#/definitions/DeepCreatedOrigin' x-ms-identifiers: - name originGroups: description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. type: array items: $ref: '#/definitions/DeepCreatedOriginGroup' x-ms-identifiers: - name customDomains: description: The custom domains under the endpoint. type: array readOnly: true items: $ref: '#/definitions/DeepCreatedCustomDomain' x-ms-identifiers: - name resourceState: description: Resource status of the endpoint. readOnly: true enum: - Creating - Deleting - Running - Starting - Stopped - Stopping type: string x-ms-enum: name: EndpointResourceState modelAsString: true provisioningState: readOnly: true description: Provisioning status of the endpoint. type: string enum: - Succeeded - Failed - Updating - Deleting - Creating x-ms-enum: name: EndpointProvisioningState modelAsString: true ErrorDefinition: description: Error definition. properties: code: description: Service specific error code which serves as the substatus for the HTTP error code. type: string readOnly: true message: description: Description of the error. type: string readOnly: true details: description: Internal error details. type: array items: $ref: '#/definitions/ErrorDefinition' readOnly: true KeyVaultSigningKeyParameters: description: Describes the parameters for using a user's KeyVault for URL Signing Key. required: - typeName - subscriptionId - resourceGroupName - vaultName - secretName - secretVersion properties: typeName: type: string enum: - KeyVaultSigningKeyParameters subscriptionId: description: Subscription Id of the user's Key Vault containing the secret type: string resourceGroupName: description: Resource group of the user's Key Vault containing the secret type: string vaultName: description: The name of the user's Key Vault containing the secret type: string secretName: description: The name of secret in Key Vault. type: string secretVersion: description: The version(GUID) of secret in Key Vault. type: string QueryStringCachingBehavior: description: Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. enum: - IgnoreQueryString - BypassCaching - UseQueryString - NotSet type: string x-ms-enum: name: QueryStringCachingBehavior modelAsString: false UrlSigningKey: description: Url signing key required: - keyId - keySourceParameters properties: keyId: description: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. type: string keySourceParameters: description: Defines the parameters for using customer key vault for Url Signing Key. $ref: '#/definitions/KeyVaultSigningKeyParameters' EndpointUpdateParameters: type: object description: Properties required to create or update an endpoint. properties: tags: description: Endpoint tags. type: object additionalProperties: type: string properties: x-ms-client-flatten: true $ref: '#/definitions/EndpointPropertiesUpdateParameters' x-ms-azure-resource: true IdentityType: description: The type of identity that creates/modifies resources type: string enum: - user - application - managedIdentity - key x-ms-enum: name: IdentityType modelAsString: true DeepCreatedOriginGroup: description: The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health. type: object required: - name properties: name: description: Origin group name which must be unique within the endpoint. type: string properties: x-ms-client-flatten: true $ref: '#/definitions/DeepCreatedOriginGroupProperties' x-ms-azure-resource: false ResponseBasedOriginErrorDetectionParameters: description: The JSON object that contains the properties to determine origin health using real requests/responses. properties: responseBasedDetectedErrorTypes: description: Type of response errors for real user requests for which origin will be deemed unhealthy type: string enum: - None - TcpErrorsOnly - TcpAndHttpErrors x-ms-enum: name: ResponseBasedDetectedErrorTypes modelAsString: false responseBasedFailoverThresholdPercentage: description: The percentage of failed requests in the sample where failover should trigger. type: integer format: int32 maximum: 100 minimum: 0 httpErrorRanges: description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. type: array items: $ref: '#/definitions/HttpErrorRangeParameters' x-ms-identifiers: [] ResourceReference: properties: id: type: string description: Resource ID. description: Reference to another resource. x-ms-azure-resource: true OptimizationType: description: Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. enum: - GeneralWebDelivery - GeneralMediaStreaming - VideoOnDemandMediaStreaming - LargeFileDownload - DynamicSiteAcceleration type: string x-ms-enum: name: OptimizationType modelAsString: true HealthProbeParameters: description: The JSON object that contains the properties to send health probes to origin. properties: probePath: description: The path relative to the origin that is used to determine the health of the origin. type: string probeRequestType: description: The type of health probe request that is made. enum: - NotSet - GET - HEAD type: string x-ms-enum: name: HealthProbeRequestType modelAsString: false probeProtocol: description: Protocol to use for health probe. type: string enum: - NotSet - Http - Https x-ms-enum: name: ProbeProtocol modelAsString: false probeIntervalInSeconds: description: The number of seconds between health probes.Default is 240sec. type: integer format: int32 maximum: 255 minimum: 1 EndpointBaseProperties: description: The resource specific properties for the Storage Mover resource. type: object discriminator: endpointType properties: endpointType: description: The Endpoint resource type. enum: - AzureStorageBlobContainer - NfsMount type: string x-ms-enum: name: EndpointType modelAsString: true x-ms-mutability: - read - create description: type: string description: A description for the Endpoint. provisioningState: description: The provisioning state of this resource. enum: - Succeeded type: string x-ms-enum: name: ProvisioningState modelAsString: true readOnly: true required: - endpointType ErrorResponse: description: Error response. properties: error: description: Error description $ref: '#/definitions/ErrorDefinition' ResourceUsageListResult: description: Output of check resource usage API. properties: value: type: array readOnly: true items: $ref: '#/definitions/ResourceUsage' x-ms-identifiers: - resourceType description: List of resource usages. nextLink: type: string description: URL to get the next set of custom domain objects if there are any. ResourceUsage: description: Output of check resource usage API. type: object properties: resourceType: type: string readOnly: true description: Resource type for which the usage is provided. unit: type: string readOnly: true description: Unit of the usage. e.g. count. enum: - count x-ms-enum: name: ResourceUsageUnit modelAsString: true currentValue: type: integer format: int32 readOnly: true description: Actual value of usage on the specified resource type. limit: type: integer format: int32 readOnly: true description: Quota of the specified resource type. DigitalTwinsEndpointResourceProperties: description: Properties related to Digital Twins Endpoint discriminator: endpointType required: - endpointType properties: endpointType: description: The type of Digital Twins endpoint enum: - EventHub - EventGrid - ServiceBus x-ms-enum: name: endpointType modelAsString: true type: string provisioningState: description: The provisioning state. enum: - Provisioning - Deleting - Succeeded - Failed - Canceled type: string readOnly: true x-ms-enum: name: EndpointProvisioningState modelAsString: true createdTime: description: Time when the Endpoint was added to DigitalTwinsInstance. type: string format: date-time readOnly: true tags: type: object additionalProperties: type: string description: The resource tags. RelayNamespaceAccessProperties: type: object description: Azure relay hybrid connection access properties required: - namespaceName - namespaceNameSuffix - hybridConnectionName properties: namespaceName: type: string description: The namespace name. minLength: 1 maxLength: 200 namespaceNameSuffix: type: string description: The suffix domain name of relay namespace. minLength: 1 maxLength: 100 hybridConnectionName: type: string description: Azure Relay hybrid connection name for the resource. accessKey: type: string description: Access key for hybrid connection. readOnly: true expiresOn: type: integer format: int64 description: The expiration of access key in unix time. EndpointProperties_2: type: object description: Endpoint details required: - type properties: type: type: string description: The type of endpoint. enum: - default - custom x-ms-enum: name: type modelAsString: true resourceId: type: string description: The resource Id of the connectivity endpoint (optional). provisioningState: type: string readOnly: true description: The resource provisioning state. GeoFilter: description: Rules defining user's geo access within a CDN endpoint. type: object required: - relativePath - action - countryCodes properties: relativePath: description: Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) type: string action: description: Action of the geo filter, i.e. allow or block access. enum: - Block - Allow type: string x-ms-enum: name: GeoFilterActions modelAsString: false countryCodes: description: Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. type: array items: type: string ManagedProxyResource: type: object description: Managed Proxy required: - proxy - expiresOn properties: proxy: type: string description: The short lived proxy name. expiresOn: type: integer format: int64 description: The expiration time of short lived proxy name in unix epoch. ManagedProxyRequest: type: object description: Represent ManageProxy Request object. required: - service properties: service: type: string description: The name of the service. hostname: type: string description: The target host name. DeliveryRule: description: A rule that specifies a set of actions and conditions type: object required: - order - actions properties: name: description: Name of the rule type: string order: description: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. type: integer format: int32 conditions: description: A list of conditions that must be matched for the actions to be executed type: array items: $ref: '#/definitions/DeliveryRuleCondition' x-ms-identifiers: - name actions: description: A list of actions that are executed when all the conditions of a rule are satisfied. type: array items: $ref: '#/definitions/DeliveryRuleAction' x-ms-identifiers: - name HttpErrorRangeParameters: description: The JSON object that represents the range for http status codes properties: begin: description: The inclusive start of the http status code range. type: integer format: int32 maximum: 999 minimum: 100 end: description: The inclusive end of the http status code range. type: integer format: int32 maximum: 999 minimum: 100 DeepCreatedOriginProperties: description: Properties of the origin created on the CDN endpoint. type: object required: - hostName properties: hostName: description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. type: string httpPort: description: The value of the HTTP port. Must be between 1 and 65535. type: integer format: int32 maximum: 65535 exclusiveMaximum: false minimum: 1 exclusiveMinimum: false httpsPort: description: The value of the HTTPS port. Must be between 1 and 65535. type: integer format: int32 maximum: 65535 exclusiveMaximum: false minimum: 1 exclusiveMinimum: false originHostHeader: description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. type: string priority: description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. type: integer format: int32 maximum: 5 minimum: 1 weight: description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 type: integer format: int32 maximum: 1000 minimum: 1 enabled: description: Origin is enabled for load balancing or not. By default, origin is always enabled. type: boolean privateLinkAlias: description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' type: string privateLinkResourceId: description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' type: string privateLinkLocation: description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated type: string privateLinkApprovalMessage: description: A custom message to be included in the approval request to connect to the Private Link. type: string privateEndpointStatus: description: The approval status for the connection to the Private Link $ref: '#/definitions/PrivateEndpointStatus' type: string readOnly: true x-ms-azure-resource: false Endpoint_2: description: The Endpoint resource, which contains information about file sources and targets. type: object properties: properties: $ref: '#/definitions/EndpointBaseProperties' systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: Resource system metadata. required: - properties allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource ValidateCustomDomainOutput: description: Output of custom domain validation. type: object properties: customDomainValidated: description: Indicates whether the custom domain is valid or not. readOnly: true type: boolean reason: description: The reason why the custom domain is not valid. readOnly: true type: string message: description: Error message describing why the custom domain is not valid. readOnly: true type: string DeliveryRuleAction: description: An action for the delivery rule. discriminator: name required: - name properties: name: description: The name of the action for the delivery rule. type: string enum: - CacheExpiration - CacheKeyQueryString - ModifyRequestHeader - ModifyResponseHeader - UrlRedirect - UrlRewrite - UrlSigning - OriginGroupOverride - RouteConfigurationOverride - AfdUrlSigning x-ms-enum: name: DeliveryRuleAction modelAsString: true Endpoint: description: CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net. type: object allOf: - $ref: '#/definitions/TrackedResource' properties: properties: x-ms-client-flatten: true $ref: '#/definitions/EndpointProperties' EndpointBaseUpdateProperties: description: The Endpoint resource, which contains information about file sources and targets. type: object properties: description: type: string description: A description for the Endpoint. SystemData: description: Read only system data readOnly: true type: object properties: createdBy: type: string description: An identifier for the identity that created the resource createdByType: $ref: '#/definitions/IdentityType' description: The type of identity that created the resource createdAt: type: string format: date-time description: The timestamp of resource creation (UTC) lastModifiedBy: type: string description: An identifier for the identity that last modified the resource lastModifiedByType: $ref: '#/definitions/IdentityType' description: The type of identity that last modified the resource lastModifiedAt: type: string format: date-time description: The timestamp of resource last modification (UTC) PurgeParameters: type: object description: Parameters required for content purge. required: - contentPaths properties: contentPaths: description: The path to the content to be purged. Can describe a file path or a wild card directory. type: array items: type: string EndpointListResult: description: Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results. properties: value: type: array readOnly: true items: $ref: '#/definitions/Endpoint' description: List of CDN endpoints within a profile nextLink: type: string description: URL to get the next set of endpoint objects if there is any. parameters: resourceName: name: resourceName in: path description: The name of the DigitalTwinsInstance. required: true type: string x-ms-parameter-location: method minLength: 1 maxLength: 64 resourceGroupNameParameter: name: resourceGroupName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 x-ms-parameter-location: method description: Name of the Resource group within the Azure subscription. resourceGroupName: name: resourceGroupName in: path description: The name of the resource group that contains the DigitalTwinsInstance. required: true type: string x-ms-parameter-location: method minLength: 1 maxLength: 64 StorageMoverNameParameter: name: storageMoverName in: path required: true type: string description: The name of the Storage Mover resource. x-ms-parameter-location: method AccessTokenExpirationParameter: name: expiresin in: query required: false type: integer format: int64 default: 10800 minimum: 600 maximum: 10800 description: The is how long the endpoint access token is valid (in seconds). x-ms-parameter-location: method endpointName: name: endpointName in: path description: Name of Endpoint Resource. required: true type: string x-ms-parameter-location: method pattern: ^[A-Za-z0-9-._]{1,64}$ minLength: 1 maxLength: 64 api-version: name: api-version enum: - 2020-03-01-preview in: query description: Version of the DigitalTwinsInstance Management API. required: true type: string minLength: 10 EndpointNameParameter_2: name: endpointName in: path required: true type: string description: The name of the Endpoint resource. x-ms-parameter-location: method EndpointNameParameter: name: endpointName in: path required: true type: string description: The endpoint name. x-ms-skip-url-encoding: true x-ms-parameter-location: method ResourceUriParameter: name: resourceUri in: path required: true type: string description: The fully qualified Azure Resource manager identifier of the resource to be connected. x-ms-skip-url-encoding: true x-ms-parameter-location: method subscriptionId: name: subscriptionId in: path description: The subscription identifier. required: true type: string apiVersionParameter: name: api-version in: query required: true type: string description: Version of the API to be used with the client request. Current version is 2023-05-01. subscriptionIdParameter: name: subscriptionId in: path description: Azure Subscription ID. required: true type: string x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'