swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Profiles API schemes: - https tags: - name: Profiles paths: /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles: get: tags: - Profiles description: Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription. operationId: microsoftAzureProfilesList x-ms-examples: Profiles_List: $ref: ./examples/Profiles_List.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/ProfileListResult' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Cdn Profiles /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles: get: tags: - Profiles description: Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group. operationId: microsoftAzureProfilesListbyresourcegroup x-ms-examples: Profiles_ListByResourceGroup: $ref: ./examples/Profiles_ListByResourceGroup.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/ProfileListResult' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}: get: tags: - Profiles description: Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group. operationId: microsoftAzureProfilesGet x-ms-examples: Profiles_Get: $ref: ./examples/Profiles_Get.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the Azure Front Door Standard or Azure Front Door Premium or 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/Profile' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename put: tags: - Profiles description: Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group. operationId: microsoftAzureProfilesCreate x-ms-examples: Profiles_Create: $ref: ./examples/Profiles_Create.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. required: true type: string - description: Profile properties needed to create a new profile. in: body name: profile required: true schema: $ref: '#/definitions/Profile' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Profile' '201': description: Created. The request has been fulfilled and a new profile has been created. schema: $ref: '#/definitions/Profile' '202': description: Accepted. The request has been accepted for processing and the operation will complete asynchronously. headers: location: type: string schema: $ref: '#/definitions/Profile' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename patch: tags: - Profiles description: Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group. operationId: microsoftAzureProfilesUpdate x-ms-examples: Profiles_Update: $ref: ./examples/Profiles_Update.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. required: true type: string - name: profileUpdateParameters in: body description: Profile properties needed to update an existing profile. required: true schema: $ref: '#/definitions/ProfileUpdateParameters' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/Profile' '202': description: Accepted. The request has been accepted for processing and the operation will complete asynchronously. headers: location: type: string schema: $ref: '#/definitions/Profile' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename delete: tags: - Profiles description: Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains. operationId: microsoftAzureProfilesDelete x-ms-examples: Profiles_Delete: $ref: ./examples/Profiles_Delete.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the Azure Front Door Standard or Azure Front Door Premium or 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. '202': description: Accepted. The request has been accepted for processing and the operation will complete asynchronously. headers: location: type: string '204': description: No Content. The request has been accepted but the profile was not found. default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/canMigrate: post: tags: - Profiles description: Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile. operationId: microsoftAzureProfilesCanmigrate x-ms-examples: Profiles_CanMigrate: $ref: ./examples/Profiles_CanMigrate.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - description: Properties needed to check if cdn profile or classic frontdoor can be migrated. in: body name: canMigrateParameters required: true schema: $ref: '#/definitions/CanMigrateParameters' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/CanMigrateResult' '202': description: Accepted. The request has been accepted for processing and the operation will complete asynchronously. headers: location: type: string default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Canmigrate /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/migrate: post: tags: - Profiles description: Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this. operationId: microsoftAzureProfilesMigrate x-ms-examples: Profiles_Migrate: $ref: ./examples/Profiles_Migrate.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - description: Properties needed to migrate the profile. in: body name: migrationParameters required: true schema: $ref: '#/definitions/MigrationParameters' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/MigrateResult' '202': description: Accepted. The request has been accepted for processing and the operation will complete asynchronously. headers: location: type: string schema: $ref: '#/definitions/MigrateResult' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Migrate ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/migrationCommit : post: tags: - Profiles description: Commit the migrated Azure Frontdoor(Standard/Premium) profile. operationId: microsoftAzureProfilesMigrationcommit x-ms-examples: Profiles_MigrationCommit: $ref: ./examples/Profiles_MigrationCommit.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. '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' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Migrationcommit ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri : post: tags: - Profiles description: Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes. operationId: microsoftAzureProfilesGeneratessouri x-ms-examples: Profiles_GenerateSsoUri: $ref: ./examples/Profiles_GenerateSsoUri.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/SsoUri' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Generatessouri ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes : post: tags: - Profiles description: Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values. operationId: microsoftAzureProfilesListsupportedoptimizationtypes x-ms-examples: Profiles_ListSupportedOptimizationTypes: $ref: ./examples/Profiles_ListSupportedOptimizationTypes.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the Azure Front Door Standard or Azure Front Door Premium or 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/SupportedOptimizationTypesListResult' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Getsupportedoptimizationtypes ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage : post: tags: - Profiles description: Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile. operationId: microsoftAzureProfilesListresourceusage x-ms-examples: Profiles_ListResourceUsage: $ref: ./examples/Profiles_ListResourceUsage.json parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: profileName in: path description: Name of the Azure Front Door Standard or Azure Front Door Premium or 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/ResourceUsageListResult' default: description: CDN error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Checkresourceusage ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName} : put: tags: - Profiles operationId: microsoftAzureProfilesCreateorupdate x-ms-examples: Profiles_CreateOrUpdate: $ref: ./examples/ProfilesCreateOrUpdate.json description: Creates a profile within a Hub, or updates an existing profile. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the hub. - name: profileName in: path required: true type: string description: The name of the profile. pattern: ^[a-zA-Z][a-zA-Z0-9_]+$ minLength: 1 maxLength: 128 - name: parameters in: body required: true schema: $ref: '#/definitions/ProfileResourceFormat' description: Parameters supplied to the create/delete Profile type operation - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. Successfully created the profile. schema: $ref: '#/definitions/ProfileResourceFormat' '202': description: Accepted. The create profile operation is accepted. x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Profiles Profilename get: tags: - Profiles operationId: microsoftAzureProfilesGet x-ms-examples: Profiles_Get: $ref: ./examples/ProfilesGet.json description: Gets information about the specified profile. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the hub. - name: profileName in: path required: true type: string description: The name of the profile. - name: locale-code in: query required: false type: string default: en-us description: Locale of profile to retrieve, default is en-us. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. Successfully get the profile. schema: $ref: '#/definitions/ProfileResourceFormat' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Profiles Profilename delete: tags: - Profiles operationId: microsoftAzureProfilesDelete x-ms-examples: Profiles_Delete: $ref: ./examples/ProfilesDelete.json description: Deletes a profile within a hub parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the hub. - name: profileName in: path required: true type: string description: The name of the profile. - name: locale-code in: query required: false type: string default: en-us description: Locale of profile to retrieve, default is en-us. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. The profile is deleted. '202': description: Accepted. The delete operation is accepted. '204': description: NoContent. Successfully requested delete operation, but the response is intentionally empty. x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Profiles Profilename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles : get: tags: - Profiles operationId: microsoftAzureProfilesListbyhub x-ms-examples: Profiles_ListByHub: $ref: ./examples/ProfilesListByHub.json description: Gets all profile in the hub. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the hub. - name: locale-code in: query required: false type: string default: en-us description: Locale of profile to retrieve, default is en-us. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. Successfully get all the profiles in the hub. schema: $ref: '#/definitions/ProfileListResult_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Profiles ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/profiles/{profileName}/getEnrichingKpis : post: tags: - Profiles operationId: microsoftAzureProfilesGetenrichingkpis x-ms-examples: Profiles_GetEnrichingKpis: $ref: ./examples/ProfileGetEnrichingKpis.json description: Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: hubName in: path required: true type: string description: The name of the hub. - name: profileName in: path required: true type: string description: The name of the profile. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. Successfully get the enriching KPIs. schema: type: array items: $ref: '#/definitions/KpiDefinition' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Customerinsights Hubs Hubname Profiles Profilename Getenrichingkpis definitions: Profile: description: A profile is a logical grouping of endpoints that share the same settings. type: object allOf: - $ref: '#/definitions/TrackedResource' properties: sku: description: The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile. $ref: '#/definitions/Sku' kind: readOnly: true type: string description: Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile. identity: description: Managed service identity (system assigned and/or user assigned identities). type: object $ref: ../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity properties: x-ms-client-flatten: true $ref: '#/definitions/ProfileProperties' required: - sku ProxyResource: properties: id: readOnly: true type: string description: Resource ID. name: readOnly: true type: string description: Resource name. type: readOnly: true type: string description: Resource type. x-ms-azure-resource: true description: Common properties of proxy resource. MetadataDefinitionBase: properties: attributes: type: object additionalProperties: type: array items: type: string description: The attributes for the Type. description: type: object additionalProperties: type: string description: Localized descriptions for the property. displayName: type: object additionalProperties: type: string description: Localized display names for the property. localizedAttributes: type: object additionalProperties: type: object additionalProperties: type: string description: Any custom localized attributes for the Type. smallImage: type: string description: Small Image associated with the Property or EntityType. mediumImage: type: string description: Medium Image associated with the Property or EntityType. largeImage: type: string description: Large Image associated with the Property or EntityType. description: The Metadata definition base. MigrateResultProperties: type: object properties: migratedProfileResourceId: readOnly: true description: Arm resource id of the migrated profile $ref: '#/definitions/ResourceReference' Sku: description: 'Standard_Verizon = The SKU name for a Standard Verizon CDN profile. Premium_Verizon = The SKU name for a Premium Verizon CDN profile. Custom_Verizon = The SKU name for a Custom Verizon CDN profile. Standard_Akamai = The SKU name for an Akamai CDN profile. Standard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model. Standard_Microsoft = The SKU name for a Standard Microsoft CDN profile. Standard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile. Premium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile. Standard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model. Standard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model. StandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model. StandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model. StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model. ' properties: name: description: Name of the pricing tier. enum: - Standard_Verizon - Premium_Verizon - Custom_Verizon - Standard_Akamai - Standard_ChinaCdn - Standard_Microsoft - Standard_AzureFrontDoor - Premium_AzureFrontDoor - Standard_955BandWidth_ChinaCdn - Standard_AvgBandWidth_ChinaCdn - StandardPlus_ChinaCdn - StandardPlus_955BandWidth_ChinaCdn - StandardPlus_AvgBandWidth_ChinaCdn type: string x-ms-enum: name: SkuName modelAsString: true type: object ProfileUpdateParameters: type: object description: Properties required to update a profile. properties: tags: description: Profile tags type: object additionalProperties: type: string identity: description: Managed service identity (system assigned and/or user assigned identities). type: object $ref: ../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity properties: x-ms-client-flatten: true $ref: '#/definitions/ProfilePropertiesUpdateParameters' x-ms-azure-resource: true KpiAlias: required: - aliasName - expression properties: aliasName: type: string description: KPI alias name. expression: type: string description: The expression. description: The KPI alias. ProfileEnumValidValuesFormat: properties: value: type: integer description: The integer value of the enum member. localizedValueNames: type: object additionalProperties: type: string description: Localized names of the enum member. description: Valid enum values in case of an enum property. KpiThresholds: properties: lowerLimit: type: number format: decimal description: The lower threshold limit. upperLimit: type: number format: decimal description: The upper threshold limit. increasingKpi: type: boolean description: Whether or not the KPI is an increasing KPI. required: - lowerLimit - upperLimit - increasingKpi description: Defines the KPI Threshold limits. CanMigrateParameters: type: object description: Request body for CanMigrate operation. required: - classicResourceReference properties: classicResourceReference: description: Resource reference of the classic cdn profile or classic frontdoor that need to be migrated. $ref: '#/definitions/ResourceReference' x-ms-azure-resource: true MigrationErrorType: description: Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message. type: object properties: code: description: Error code. readOnly: true type: string resourceName: description: Resource which has the problem. readOnly: true type: string errorMessage: description: Error message indicating why the operation failed. readOnly: true type: string nextSteps: description: Describes what needs to be done to fix the problem readOnly: true type: string 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 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 KpiGroupByMetadata: properties: displayName: type: object additionalProperties: type: string description: The display name. fieldName: type: string description: The name of the field. fieldType: type: string description: The type of the field. description: The KPI GroupBy field metadata. ProfileListResult: description: Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results. properties: value: type: array readOnly: true items: $ref: '#/definitions/Profile' description: List of CDN profiles within a resource group. nextLink: type: string description: URL to get the next set of profile objects if there are any. MigrationWebApplicationFirewallMapping: description: 'Web Application Firewall Mapping ' type: object properties: migratedFrom: description: Migration From Waf policy $ref: '#/definitions/ResourceReference' migratedTo: description: Migration to Waf policy $ref: '#/definitions/ResourceReference' StrongId: required: - keyPropertyNames - strongIdName properties: keyPropertyNames: type: array items: type: string description: The properties which make up the unique ID. strongIdName: type: string description: The Name identifying the strong ID. displayName: type: object additionalProperties: type: string description: Localized display name. description: type: object additionalProperties: type: string description: Localized descriptions. description: Property/Properties which represent a unique ID. PropertyDefinition: required: - fieldName - fieldType properties: arrayValueSeparator: type: string description: Array value separator for properties with isArray set. enumValidValues: type: array items: $ref: '#/definitions/ProfileEnumValidValuesFormat' description: Describes valid values for an enum property. fieldName: type: string description: Name of the property. fieldType: type: string description: Type of the property. isArray: type: boolean description: Indicates if the property is actually an array of the fieldType above on the data api. isEnum: type: boolean description: Indicates if the property is an enum. isFlagEnum: type: boolean description: Indicates if the property is an flag enum. isImage: type: boolean description: Whether the property is an Image. isLocalizedString: type: boolean description: Whether the property is a localized string. isName: type: boolean description: Whether the property is a name or a part of name. isRequired: type: boolean description: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. propertyId: type: string description: The ID associated with the property. schemaItemPropLink: type: string description: URL encoded schema.org item prop link for the property. maxLength: type: integer description: Max length of string. Used only if type is string. isAvailableInGraph: type: boolean description: Whether property is available in graph or not. dataSourcePrecedenceRules: type: array items: $ref: '#/definitions/DataSourcePrecedence' readOnly: true description: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. description: Property definition. KpiDefinition: required: - entityType - entityTypeName - calculationWindow - function - expression properties: entityType: type: string enum: - None - Profile - Interaction - Relationship x-ms-enum: name: EntityTypes modelAsString: false description: The mapping entity type. entityTypeName: type: string description: The mapping entity name. tenantId: type: string readOnly: true description: The hub name. kpiName: type: string readOnly: true description: The KPI name. displayName: type: object additionalProperties: type: string description: Localized display name for the KPI. description: type: object additionalProperties: type: string description: Localized description for the KPI. calculationWindow: type: string enum: - Lifetime - Hour - Day - Week - Month x-ms-enum: name: CalculationWindowTypes modelAsString: false description: The calculation window. calculationWindowFieldName: type: string description: Name of calculation window field. function: type: string enum: - Sum - Avg - Min - Max - Last - Count - None - CountDistinct x-ms-enum: name: KpiFunctions modelAsString: false description: The computation function for the KPI. expression: type: string description: The computation expression for the KPI. unit: type: string description: The unit of measurement for the KPI. filter: type: string description: The filter expression for the KPI. groupBy: type: array items: type: string description: the group by properties for the KPI. groupByMetadata: type: array readOnly: true items: $ref: '#/definitions/KpiGroupByMetadata' description: The KPI GroupByMetadata. participantProfilesMetadata: type: array readOnly: true items: $ref: '#/definitions/KpiParticipantProfilesMetadata' description: The participant profiles. provisioningState: $ref: '#/definitions/ProvisioningState' readOnly: true description: Provisioning state. thresHolds: $ref: '#/definitions/KpiThresholds' description: The KPI thresholds. aliases: type: array items: $ref: '#/definitions/KpiAlias' description: The aliases. extracts: type: array items: $ref: '#/definitions/KpiExtract' description: The KPI extracts. description: Defines the KPI Threshold limits. ProfileTypeDefinition: description: The profile type definition. properties: strongIds: type: array items: $ref: '#/definitions/StrongId' description: The strong IDs. allOf: - $ref: '#/definitions/EntityTypeDefinition' SupportedOptimizationTypesListResult: description: The result of the GetSupportedOptimizationTypes API type: object properties: supportedOptimizationTypes: description: Supported optimization types for a profile. readOnly: true items: $ref: '#/definitions/OptimizationType' type: array ProfilePropertiesUpdateParameters: type: object description: The JSON object containing profile update parameters. properties: originResponseTimeoutSeconds: description: Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns. type: integer format: int32 minimum: 16 exclusiveMinimum: false KpiExtract: required: - extractName - expression properties: extractName: type: string description: KPI extract name. expression: type: string description: The expression. description: The KPI extract. KpiParticipantProfilesMetadata: required: - typeName properties: typeName: type: string description: Name of the type. description: The KPI participant profile metadata. ProfileListResult_2: properties: value: type: array items: $ref: '#/definitions/ProfileResourceFormat' description: Results of the list operation. nextLink: type: string description: Link to the next set of results. description: The response of list profile operation. ProfileProperties: description: The JSON object that contains the properties required to create a profile. properties: resourceState: description: Resource status of the profile. readOnly: true enum: - Creating - Active - Deleting - Disabled - Migrating - Migrated - PendingMigrationCommit - CommittingMigration - AbortingMigration type: string x-ms-enum: name: ProfileResourceState modelAsString: true provisioningState: readOnly: true description: Provisioning status of the profile. type: string enum: - Succeeded - Failed - Updating - Deleting - Creating x-ms-enum: name: ProfileProvisioningState modelAsString: true extendedProperties: description: Key-Value pair representing additional properties for profiles. type: object additionalProperties: type: string readOnly: true frontDoorId: readOnly: true type: string description: The Id of the frontdoor. originResponseTimeoutSeconds: description: Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns. type: integer format: int32 minimum: 16 exclusiveMinimum: false EntityTypeDefinition: properties: apiEntitySetName: type: string description: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object. entityType: type: string enum: - None - Profile - Interaction - Relationship x-ms-enum: name: EntityTypes modelAsString: false description: Type of entity. fields: type: array items: $ref: '#/definitions/PropertyDefinition' description: The properties of the Profile. instancesCount: type: integer description: The instance count. lastChangedUtc: type: string readOnly: true format: date-time description: The last changed time for the type definition. provisioningState: $ref: '#/definitions/ProvisioningState' readOnly: true description: Provisioning state. schemaItemTypeLink: type: string description: The schema org link. This helps ACI identify and suggest semantic models. tenantId: type: string readOnly: true description: The hub name. timestampFieldName: type: string description: The timestamp property name. Represents the time when the interaction or profile update happened. typeName: type: string description: The name of the entity. allOf: - $ref: '#/definitions/MetadataDefinitionBase' description: Describes an entity. IdentityType: description: The type of identity that creates/modifies resources type: string enum: - user - application - managedIdentity - key x-ms-enum: name: IdentityType modelAsString: true MigrateResult: type: object description: Result for migrate operation. properties: id: description: Resource ID. readOnly: true type: string type: description: Resource type. readOnly: true type: string properties: x-ms-client-flatten: true $ref: '#/definitions/MigrateResultProperties' x-ms-azure-resource: true 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. ResourceReference: properties: id: type: string description: Resource ID. description: Reference to another resource. x-ms-azure-resource: true 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. 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 ErrorResponse: 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 ProfileResourceFormat: description: The profile resource format. properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ProfileTypeDefinition' allOf: - $ref: '#/definitions/ProxyResource' CanMigrateProperties: type: object properties: canMigrate: readOnly: true description: Flag that says if the profile can be migrated type: boolean defaultSku: readOnly: true description: Recommended sku for the migration type: string enum: - Standard_AzureFrontDoor - Premium_AzureFrontDoor x-ms-enum: name: CanMigrateDefaultSku modelAsString: true errors: items: description: List of migration errors $ref: '#/definitions/MigrationErrorType' type: array x-ms-identifiers: [] SsoUri: description: The URI required to login to the supplemental portal from the Azure portal. type: object properties: ssoUriValue: description: The URI used to login to the supplemental portal. readOnly: true type: string MigrationParameters: type: object description: Request body for Migrate operation. required: - classicResourceReference - sku - profileName properties: sku: description: Sku for the migration $ref: '#/definitions/Sku' classicResourceReference: description: Resource reference of the classic cdn profile or classic frontdoor that need to be migrated. $ref: '#/definitions/ResourceReference' profileName: description: Name of the new profile that need to be created. type: string migrationWebApplicationFirewallMappings: description: Waf mapping for the migrated profile type: array items: description: List of waf mappings $ref: '#/definitions/MigrationWebApplicationFirewallMapping' x-ms-identifiers: [] x-ms-azure-resource: true CanMigrateResult: type: object description: Result for canMigrate operation. properties: id: description: Resource ID. readOnly: true type: string type: description: Resource type. readOnly: true type: string properties: x-ms-client-flatten: true $ref: '#/definitions/CanMigrateProperties' x-ms-azure-resource: true ProvisioningState: type: string enum: - Provisioning - Succeeded - Expiring - Deleting - HumanIntervention - Failed x-ms-enum: name: ProvisioningStates modelAsString: true description: Provisioning state. DataSource: properties: name: type: string readOnly: true description: The data source name dataSourceType: type: string enum: - Connector - LinkInteraction - SystemDefault x-ms-enum: name: DataSourceType modelAsString: true readOnly: true description: The data source type. status: type: string enum: - None - Active - Deleted x-ms-enum: name: Status modelAsString: true readOnly: true description: The data source status. id: type: integer readOnly: true description: The data source ID. dataSourceReferenceId: type: string readOnly: true description: The data source reference id. description: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules. DataSourcePrecedence: properties: dataSource: x-ms-client-flatten: true $ref: '#/definitions/DataSource' precedence: type: integer description: the precedence value. description: The data source precedence is a way to know the precedence of each data source. 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) parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: Client Api Version. 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. SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. 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'