Microsoft.Network (stable:2025-10-01)

2025/10/21 • 38 new methods

FrontDoorNameAvailability_Check (new)
Description :  Check the availability of a Front Door resource name.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Network/checkFrontDoorNameAvailability
{
checkFrontDoorNameAvailabilityInput:
{
Description: Input to check. ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource whose name is to be validated. ,
Enum:
{
Microsoft.Network/frontDoors: No description available. ,
Microsoft.Network/frontDoors/frontendEndpoints: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailability:
{
Description: Indicates whether the name is available. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontDoorNameAvailabilityWithSubscription_Check (new)
Description :  Check the availability of a Front Door subdomain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/checkFrontDoorNameAvailability
{
checkFrontDoorNameAvailabilityInput:
{
Description: Input to check. ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource whose name is to be validated. ,
Enum:
{
Microsoft.Network/frontDoors: No description available. ,
Microsoft.Network/frontDoors/frontendEndpoints: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailability:
{
Description: Indicates whether the name is available. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontDoors_List (new)
Description :  Lists all of the Front Doors within an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/frontDoors
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Front Doors within a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Front Door Load Balancer ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the Front Door. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Front Door. ,
Required: False ,
}
string ,
cname:
{
Description: The host that each frontendEndpoint must CNAME to. ,
Required: False ,
}
string ,
frontdoorId:
{
Description: The Id of the frontdoor. ,
Required: False ,
}
string ,
rulesEngines:
{
Description: Rules Engine Configurations available to routing rules. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
extendedProperties:
{
Description: Key-Value pair representing additional properties for frontdoor. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Front Door objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontDoors_ListByResourceGroup (new)
Description :  Lists all of the Front Doors within a resource group under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Front Doors within a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Front Door Load Balancer ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the Front Door. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Front Door. ,
Required: False ,
}
string ,
cname:
{
Description: The host that each frontendEndpoint must CNAME to. ,
Required: False ,
}
string ,
frontdoorId:
{
Description: The Id of the frontdoor. ,
Required: False ,
}
string ,
rulesEngines:
{
Description: Rules Engine Configurations available to routing rules. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
extendedProperties:
{
Description: Key-Value pair representing additional properties for frontdoor. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Front Door objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontDoors_Get (new)
Description :  Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Front Door Load Balancer ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the Front Door. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Front Door. ,
Required: False ,
}
string ,
cname:
{
Description: The host that each frontendEndpoint must CNAME to. ,
Required: False ,
}
string ,
frontdoorId:
{
Description: The Id of the frontdoor. ,
Required: False ,
}
string ,
rulesEngines:
{
Description: Rules Engine Configurations available to routing rules. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
extendedProperties:
{
Description: Key-Value pair representing additional properties for frontdoor. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontDoors_CreateOrUpdate (new)
Description :  Creates a new Front Door with a Front Door name under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
frontDoorParameters:
{
Description: Front Door properties needed to create a new Front Door. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Front Door Load Balancer ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the Front Door. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Front Door. ,
Required: False ,
}
string ,
cname:
{
Description: The host that each frontendEndpoint must CNAME to. ,
Required: False ,
}
string ,
frontdoorId:
{
Description: The Id of the frontdoor. ,
Required: False ,
}
string ,
rulesEngines:
{
Description: Rules Engine Configurations available to routing rules. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
extendedProperties:
{
Description: Key-Value pair representing additional properties for frontdoor. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Front Door Load Balancer ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the Front Door. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Front Door. ,
Required: False ,
}
string ,
cname:
{
Description: The host that each frontendEndpoint must CNAME to. ,
Required: False ,
}
string ,
frontdoorId:
{
Description: The Id of the frontdoor. ,
Required: False ,
}
string ,
rulesEngines:
{
Description: Rules Engine Configurations available to routing rules. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
extendedProperties:
{
Description: Key-Value pair representing additional properties for frontdoor. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Front Door Load Balancer ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the Front Door. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Front Door. ,
Required: False ,
}
string ,
cname:
{
Description: The host that each frontendEndpoint must CNAME to. ,
Required: False ,
}
string ,
frontdoorId:
{
Description: The Id of the frontdoor. ,
Required: False ,
}
string ,
rulesEngines:
{
Description: Rules Engine Configurations available to routing rules. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
extendedProperties:
{
Description: Key-Value pair representing additional properties for frontdoor. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the Front Door Load Balancer ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the Front Door. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the Front Door. ,
Required: False ,
}
string ,
cname:
{
Description: The host that each frontendEndpoint must CNAME to. ,
Required: False ,
}
string ,
frontdoorId:
{
Description: The Id of the frontdoor. ,
Required: False ,
}
string ,
rulesEngines:
{
Description: Rules Engine Configurations available to routing rules. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
extendedProperties:
{
Description: Key-Value pair representing additional properties for frontdoor. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontDoors_Delete (new)
Description :  Deletes an existing Front Door with the specified parameters.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontendEndpoints_ListByFrontDoor (new)
Description :  Lists all of the frontend endpoints within a Front Door.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Frontend endpoints within a Front Door. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Frontend endpoint ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the frontendEndpoint. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsConfiguration:
{
Description: The configuration specifying how to enable HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate ,
Enum:
{
AzureKeyVault: No description available. ,
FrontDoor: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery ,
Enum:
{
ServerNameIndication: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version required from the clients to establish an SSL handshake with Front Door. ,
Enum:
{
1.0: No description available. ,
1.2: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultCertificateSourceParameters:
{
Description: KeyVault certificate source parameters (if certificateSource=AzureKeyVault) ,
Required: False ,
}
{
vault:
{
Description: The Key Vault containing the SSL certificate ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
secretName:
{
Description: The name of the Key Vault secret representing the full certificate PFX ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the Key Vault secret representing the full certificate PFX ,
Required: False ,
}
string ,
}
,
frontDoorCertificateSourceParameters:
{
Description: Parameters required for enabling SSL with Front Door-managed certificates (if certificateSource=FrontDoor) ,
Required: False ,
}
{
certificateType:
{
Description: Defines the type of the certificate used for secure connections to a frontendEndpoint ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of frontend endpoints if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontendEndpoints_Get (new)
Description :  Gets a Frontend endpoint with the specified name within the specified Front Door.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
frontendEndpointName:
{
Description: Name of the Frontend endpoint which is unique within the Front Door. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Frontend endpoint ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the frontendEndpoint. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsConfiguration:
{
Description: The configuration specifying how to enable HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate ,
Enum:
{
AzureKeyVault: No description available. ,
FrontDoor: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery ,
Enum:
{
ServerNameIndication: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version required from the clients to establish an SSL handshake with Front Door. ,
Enum:
{
1.0: No description available. ,
1.2: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultCertificateSourceParameters:
{
Description: KeyVault certificate source parameters (if certificateSource=AzureKeyVault) ,
Required: False ,
}
{
vault:
{
Description: The Key Vault containing the SSL certificate ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
secretName:
{
Description: The name of the Key Vault secret representing the full certificate PFX ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the Key Vault secret representing the full certificate PFX ,
Required: False ,
}
string ,
}
,
frontDoorCertificateSourceParameters:
{
Description: Parameters required for enabling SSL with Front Door-managed certificates (if certificateSource=FrontDoor) ,
Required: False ,
}
{
certificateType:
{
Description: Defines the type of the certificate used for secure connections to a frontendEndpoint ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_PurgeContent (new)
Description :  Removes a content from Front Door.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/purge
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
contentFilePaths:
{
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 ,
}
{
contentPaths:
{
Description: The path to the content to be purged. Can describe a file path or a wild card directory. ,
Required: True ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontendEndpoints_EnableHttps (new)
Description :  Enables a frontendEndpoint for HTTPS traffic
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}/enableHttps
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
frontendEndpointName:
{
Description: Name of the Frontend endpoint which is unique within the Front Door. ,
Required: True ,
}
string ,
customHttpsConfiguration:
{
Description: The configuration specifying how to enable HTTPS ,
Required: True ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate ,
Enum:
{
AzureKeyVault: No description available. ,
FrontDoor: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery ,
Enum:
{
ServerNameIndication: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: The minimum TLS version required from the clients to establish an SSL handshake with Front Door. ,
Enum:
{
1.0: No description available. ,
1.2: No description available. ,
}
,
Required: True ,
}
enum ,
keyVaultCertificateSourceParameters:
{
Description: KeyVault certificate source parameters (if certificateSource=AzureKeyVault) ,
Required: False ,
}
{
vault:
{
Description: The Key Vault containing the SSL certificate ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
secretName:
{
Description: The name of the Key Vault secret representing the full certificate PFX ,
Required: False ,
}
string ,
secretVersion:
{
Description: The version of the Key Vault secret representing the full certificate PFX ,
Required: False ,
}
string ,
}
,
frontDoorCertificateSourceParameters:
{
Description: Parameters required for enabling SSL with Front Door-managed certificates (if certificateSource=FrontDoor) ,
Required: False ,
}
{
certificateType:
{
Description: Defines the type of the certificate used for secure connections to a frontendEndpoint ,
Enum:
{
Dedicated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontendEndpoints_DisableHttps (new)
Description :  Disables a frontendEndpoint for HTTPS traffic
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}/disableHttps
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
frontendEndpointName:
{
Description: Name of the Frontend endpoint which is unique within the Front Door. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
FrontDoors_ValidateCustomDomain (new)
Description :  Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/validateCustomDomain
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Custom domain to be validated. ,
Required: True ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
customDomainValidated:
{
Description: Indicates whether the custom domain is valid or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the custom domain is not valid. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing why the custom domain is not valid. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RulesEngines_ListByFrontDoor (new)
Description :  Lists all of the Rules Engine Configurations within a Front Door.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/rulesEngines
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of rulesEngines within a Front Door. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of RulesEngine objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RulesEngines_Get (new)
Description :  Gets a Rules Engine Configuration with the specified name within the specified Front Door.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/rulesEngines/{rulesEngineName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
rulesEngineName:
{
Description: Name of the Rules Engine which is unique within the Front Door. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RulesEngines_CreateOrUpdate (new)
Description :  Creates a new Rules Engine Configuration with the specified name within the specified Front Door.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/rulesEngines/{rulesEngineName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
rulesEngineName:
{
Description: Name of the Rules Engine which is unique within the Front Door. ,
Required: True ,
}
string ,
rulesEngineParameters:
{
Description: Rules Engine Configuration properties needed to create a new Rules Engine Configuration. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the Rules Engine Configuration. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
Migrated: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
RulesEngines_Delete (new)
Description :  Deletes an existing Rules Engine Configuration with the specified parameters.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/rulesEngines/{rulesEngineName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
frontDoorName:
{
Description: Name of the Front Door which is globally unique. ,
Required: True ,
}
string ,
rulesEngineName:
{
Description: Name of the Rules Engine which is unique within the Front Door. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NetworkExperimentProfiles_List (new)
Description :  Gets a list of Network Experiment Profiles under a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/NetworkExperimentProfiles
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Profiles within a resource group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Profile ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Profile objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NetworkExperimentProfiles_ListByResourceGroup (new)
Description :  Gets a list of Network Experiment Profiles within a resource group under a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Profiles within a resource group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Profile ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Profile objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NetworkExperimentProfiles_Get (new)
Description :  Gets an NetworkExperiment Profile by ProfileName
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the Profile ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NetworkExperimentProfiles_CreateOrUpdate (new)
Description :  Creates an NetworkExperiment Profile
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}
{
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: An Network Experiment Profile ,
Required: True ,
}
{
name:
{
Description: The name of the Profile ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
name:
{
Description: The name of the Profile ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the Profile ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
name:
{
Description: The name of the Profile ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NetworkExperimentProfiles_Update (new)
Description :  Updates an NetworkExperimentProfiles
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
parameters:
{
Description: The Profile Update Model ,
Required: True ,
}
{
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
enabledState:
{
Description: The enabled state of the Profile ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
name:
{
Description: The name of the Profile ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
name:
{
Description: The name of the Profile ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NetworkExperimentProfiles_Delete (new)
Description :  Deletes an NetworkExperiment Profile by ProfileName
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
PreconfiguredEndpoints_List (new)
Description :  Gets a list of Preconfigured Endpoints
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/PreconfiguredEndpoints
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of PreconfiguredEndpoints supported by NetworkExperiment. ,
Required: False ,
}
[
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a preconfiguredEndpoint ,
Required: False ,
}
{
description:
{
Description: The description of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint that is preconfigured ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of endpoint ,
Enum:
{
AFD: No description available. ,
AzureRegion: No description available. ,
CDN: No description available. ,
ATM: No description available. ,
}
,
Required: False ,
}
enum ,
backend:
{
Description: The preconfigured endpoint backend ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of PreconfiguredEndpoints if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Experiments_ListByProfile (new)
Description :  Gets a list of Experiments
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Experiments within a resource group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the Experiment ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an Experiment ,
Required: False ,
}
{
description:
{
Description: The description of the details or intents of the Experiment ,
Required: False ,
}
string ,
endpointA:
{
Description: The endpoint A of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
endpointB:
{
Description: The endpoint B of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The description of Experiment status from the server side ,
Required: False ,
}
string ,
scriptFileUri:
{
Description: The uri to the Script used in the Experiment ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Experiment objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Experiments_Get (new)
Description :  Gets an Experiment by ExperimentName
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
experimentName:
{
Description: The Experiment identifier associated with the Experiment ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the Experiment ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an Experiment ,
Required: False ,
}
{
description:
{
Description: The description of the details or intents of the Experiment ,
Required: False ,
}
string ,
endpointA:
{
Description: The endpoint A of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
endpointB:
{
Description: The endpoint B of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The description of Experiment status from the server side ,
Required: False ,
}
string ,
scriptFileUri:
{
Description: The uri to the Script used in the Experiment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Experiments_CreateOrUpdate (new)
Description :  Creates or updates an Experiment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
experimentName:
{
Description: The Experiment identifier associated with the Experiment ,
Required: True ,
}
string ,
parameters:
{
Description: The Experiment resource ,
Required: True ,
}
{
name:
{
Description: The name of the Experiment ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an Experiment ,
Required: False ,
}
{
description:
{
Description: The description of the details or intents of the Experiment ,
Required: False ,
}
string ,
endpointA:
{
Description: The endpoint A of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
endpointB:
{
Description: The endpoint B of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The description of Experiment status from the server side ,
Required: False ,
}
string ,
scriptFileUri:
{
Description: The uri to the Script used in the Experiment ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: The name of the Experiment ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an Experiment ,
Required: False ,
}
{
description:
{
Description: The description of the details or intents of the Experiment ,
Required: False ,
}
string ,
endpointA:
{
Description: The endpoint A of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
endpointB:
{
Description: The endpoint B of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The description of Experiment status from the server side ,
Required: False ,
}
string ,
scriptFileUri:
{
Description: The uri to the Script used in the Experiment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
name:
{
Description: The name of the Experiment ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an Experiment ,
Required: False ,
}
{
description:
{
Description: The description of the details or intents of the Experiment ,
Required: False ,
}
string ,
endpointA:
{
Description: The endpoint A of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
endpointB:
{
Description: The endpoint B of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The description of Experiment status from the server side ,
Required: False ,
}
string ,
scriptFileUri:
{
Description: The uri to the Script used in the Experiment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
name:
{
Description: The name of the Experiment ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an Experiment ,
Required: False ,
}
{
description:
{
Description: The description of the details or intents of the Experiment ,
Required: False ,
}
string ,
endpointA:
{
Description: The endpoint A of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
endpointB:
{
Description: The endpoint B of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The description of Experiment status from the server side ,
Required: False ,
}
string ,
scriptFileUri:
{
Description: The uri to the Script used in the Experiment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Experiments_Update (new)
Description :  Updates an Experiment
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
experimentName:
{
Description: The Experiment identifier associated with the Experiment ,
Required: True ,
}
string ,
parameters:
{
Description: The Experiment Update Model ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of a Profile ,
Required: False ,
}
{
description:
{
Description: The description of the intent or details of the Experiment ,
Required: False ,
}
string ,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: The name of the Experiment ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an Experiment ,
Required: False ,
}
{
description:
{
Description: The description of the details or intents of the Experiment ,
Required: False ,
}
string ,
endpointA:
{
Description: The endpoint A of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
endpointB:
{
Description: The endpoint B of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The description of Experiment status from the server side ,
Required: False ,
}
string ,
scriptFileUri:
{
Description: The uri to the Script used in the Experiment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
name:
{
Description: The name of the Experiment ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an Experiment ,
Required: False ,
}
{
description:
{
Description: The description of the details or intents of the Experiment ,
Required: False ,
}
string ,
endpointA:
{
Description: The endpoint A of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
endpointB:
{
Description: The endpoint B of an experiment ,
Required: False ,
}
{
name:
{
Description: The name of the endpoint ,
Required: False ,
}
string ,
endpoint:
{
Description: The endpoint URL ,
Required: False ,
}
string ,
}
,
enabledState:
{
Description: The state of the Experiment ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Description: Resource status. ,
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The description of Experiment status from the server side ,
Required: False ,
}
string ,
scriptFileUri:
{
Description: The uri to the Script used in the Experiment ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Experiments_Delete (new)
Description :  Deletes an Experiment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
experimentName:
{
Description: The Experiment identifier associated with the Experiment ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Reports_GetLatencyScorecards (new)
Description :  Gets a Latency Scorecard for a given Experiment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}/LatencyScorecard
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
experimentName:
{
Description: The Experiment identifier associated with the Experiment ,
Required: True ,
}
string ,
endDateTimeUTC:
{
Description: The end DateTime of the Latency Scorecard in UTC ,
Required: False ,
}
string ,
country:
{
Description: The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html ,
Required: False ,
}
string ,
aggregationInterval:
{
Description: The aggregation interval of the Latency Scorecard ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a latency scorecard ,
Required: False ,
}
{
id:
{
Description: The unique identifier of the Latency Scorecard ,
Required: False ,
}
string ,
name:
{
Description: The name of the Latency Scorecard ,
Required: False ,
}
string ,
description:
{
Description: The description of the Latency Scorecard ,
Required: False ,
}
string ,
endpointA:
{
Description: The A endpoint in the scorecard ,
Required: False ,
}
string ,
endpointB:
{
Description: The B endpoint in the scorecard ,
Required: False ,
}
string ,
startDateTimeUTC:
{
Description: The start time of the Latency Scorecard in UTC ,
Format: date-time ,
Required: False ,
}
string ,
endDateTimeUTC:
{
Description: The end time of the Latency Scorecard in UTC ,
Format: date-time ,
Required: False ,
}
string ,
country:
{
Description: The country associated with the Latency Scorecard. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html ,
Required: False ,
}
string ,
latencyMetrics:
{
Description: The latency metrics of the Latency Scorecard ,
Required: False ,
}
[
{
name:
{
Description: The name of the Latency Metric ,
Required: False ,
}
string ,
endDateTimeUTC:
{
Description: The end time of the Latency Scorecard in UTC ,
Required: False ,
}
string ,
aValue:
{
Description: The metric value of the A endpoint ,
Required: False ,
}
number ,
bValue:
{
Description: The metric value of the B endpoint ,
Required: False ,
}
number ,
delta:
{
Description: The difference in value between endpoint A and B ,
Required: False ,
}
number ,
deltaPercent:
{
Description: The percent difference between endpoint A and B ,
Required: False ,
}
number ,
aCLower95CI:
{
Description: The lower end of the 95% confidence interval for endpoint A ,
Required: False ,
}
number ,
aHUpper95CI:
{
Description: The upper end of the 95% confidence interval for endpoint A ,
Required: False ,
}
number ,
bCLower95CI:
{
Description: The lower end of the 95% confidence interval for endpoint B ,
Required: False ,
}
number ,
bUpper95CI:
{
Description: The upper end of the 95% confidence interval for endpoint B ,
Required: False ,
}
number ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Reports_GetTimeseries (new)
Description :  Gets a Timeseries for a given Experiment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/NetworkExperimentProfiles/{profileName}/Experiments/{experimentName}/Timeseries
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: The Profile identifier associated with the Tenant and Partner ,
Required: True ,
}
string ,
experimentName:
{
Description: The Experiment identifier associated with the Experiment ,
Required: True ,
}
string ,
startDateTimeUTC:
{
Description: The start DateTime of the Timeseries in UTC ,
Format: date-time ,
Required: True ,
}
string ,
endDateTimeUTC:
{
Description: The end DateTime of the Timeseries in UTC ,
Format: date-time ,
Required: True ,
}
string ,
aggregationInterval:
{
Description: The aggregation interval of the Timeseries ,
Required: True ,
}
string ,
timeseriesType:
{
Description: The type of Timeseries ,
Required: True ,
}
string ,
endpoint:
{
Description: The specific endpoint ,
Required: False ,
}
string ,
country:
{
Description: The country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Timeseries ,
Required: False ,
}
{
endpoint:
{
Description: The endpoint associated with the Timeseries data point ,
Required: False ,
}
string ,
startDateTimeUTC:
{
Description: The start DateTime of the Timeseries in UTC ,
Required: False ,
}
string ,
endDateTimeUTC:
{
Description: The end DateTime of the Timeseries in UTC ,
Required: False ,
}
string ,
aggregationInterval:
{
Description: The aggregation interval of the Timeseries ,
Enum:
{
Hourly: No description available. ,
Daily: No description available. ,
}
,
Required: False ,
}
enum ,
timeseriesType:
{
Description: The type of Timeseries ,
Enum:
{
MeasurementCounts: No description available. ,
LatencyP50: No description available. ,
LatencyP75: No description available. ,
LatencyP95: No description available. ,
}
,
Required: False ,
}
enum ,
country:
{
Description: The country associated with the Timeseries. Values are country ISO codes as specified here- https://www.iso.org/iso-3166-country-codes.html ,
Required: False ,
}
string ,
timeseriesData:
{
Description: The set of data points for the timeseries ,
Required: False ,
}
[
{
dateTimeUTC:
{
Description: The DateTime of the Timeseries data point in UTC ,
Required: False ,
}
string ,
value:
{
Description: The Value of the Timeseries data point ,
Required: False ,
}
number ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_List (new)
Description :  Lists all of the protection policies within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of WebApplicationFirewallPolicies within a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
ServiceTagMatch: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
sensitivity:
{
Description: Describes the override sensitivity to be applied when rule matches. ,
Enum:
{
Low: Low Sensitivity - triggers the rule by larger spikes in traffic ,
Medium: Medium Sensitivity - triggers the rule by moderate spikes in traffic ,
High: High Sensitivity - triggers the rule by smaller spikes in traffic ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of WebApplicationFirewallPolicy objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_ListBySubscription (new)
Description :  Lists all of the protection policies within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of WebApplicationFirewallPolicies within a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
ServiceTagMatch: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
sensitivity:
{
Description: Describes the override sensitivity to be applied when rule matches. ,
Enum:
{
Low: Low Sensitivity - triggers the rule by larger spikes in traffic ,
Medium: Medium Sensitivity - triggers the rule by moderate spikes in traffic ,
High: High Sensitivity - triggers the rule by smaller spikes in traffic ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of WebApplicationFirewallPolicy objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Policies_Get (new)
Description :  Retrieve protection policy with specified name within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the Web Application Firewall Policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
ServiceTagMatch: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
sensitivity:
{
Description: Describes the override sensitivity to be applied when rule matches. ,
Enum:
{
Low: Low Sensitivity - triggers the rule by larger spikes in traffic ,
Medium: Medium Sensitivity - triggers the rule by moderate spikes in traffic ,
High: High Sensitivity - triggers the rule by smaller spikes in traffic ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_CreateOrUpdate (new)
Description :  Create or update policy with specified rule set name within a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the Web Application Firewall Policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
parameters:
{
Description: Policy to be created. ,
Required: True ,
}
{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
ServiceTagMatch: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
sensitivity:
{
Description: Describes the override sensitivity to be applied when rule matches. ,
Enum:
{
Low: Low Sensitivity - triggers the rule by larger spikes in traffic ,
Medium: Medium Sensitivity - triggers the rule by moderate spikes in traffic ,
High: High Sensitivity - triggers the rule by smaller spikes in traffic ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
ServiceTagMatch: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
sensitivity:
{
Description: Describes the override sensitivity to be applied when rule matches. ,
Enum:
{
Low: Low Sensitivity - triggers the rule by larger spikes in traffic ,
Medium: Medium Sensitivity - triggers the rule by moderate spikes in traffic ,
High: High Sensitivity - triggers the rule by smaller spikes in traffic ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
ServiceTagMatch: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
sensitivity:
{
Description: Describes the override sensitivity to be applied when rule matches. ,
Enum:
{
Low: Low Sensitivity - triggers the rule by larger spikes in traffic ,
Medium: Medium Sensitivity - triggers the rule by moderate spikes in traffic ,
High: High Sensitivity - triggers the rule by smaller spikes in traffic ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
ServiceTagMatch: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
sensitivity:
{
Description: Describes the override sensitivity to be applied when rule matches. ,
Enum:
{
Low: Low Sensitivity - triggers the rule by larger spikes in traffic ,
Medium: Medium Sensitivity - triggers the rule by moderate spikes in traffic ,
High: High Sensitivity - triggers the rule by smaller spikes in traffic ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_Update (new)
Description :  Patch a specific frontdoor webApplicationFirewall policy for tags update under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the Web Application Firewall Policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
parameters:
{
Description: FrontdoorWebApplicationFirewallPolicy parameters to be patched. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes settings for the policy. ,
Required: False ,
}
{
enabledState:
{
Description: Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
redirectUrl:
{
Description: If action type is redirect, this field represents redirect URL for the client. ,
Required: False ,
}
string ,
customBlockResponseStatusCode:
{
Description: If the action type is block, customer can override the response status code. ,
Required: False ,
}
integer ,
customBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
requestBodyCheck:
{
Description: Describes if policy managed rules will inspect the request body content. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
javascriptChallengeExpirationInMinutes:
{
Description: Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
captchaExpirationInMinutes:
{
Description: Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. ,
Format: int32 ,
Required: False ,
}
integer ,
logScrubbing:
{
Description: Defines rules that scrub sensitive fields in the Web Application Firewall logs. ,
Required: False ,
}
{
state:
{
Description: State of the log scrubbing config. Default value is Enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
scrubbingRules:
{
Description: List of log scrubbing rules applied to the Web Application Firewall logs. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable to be scrubbed from the logs. ,
Enum:
{
RequestIPAddress: No description available. ,
RequestUri: No description available. ,
QueryStringArgNames: No description available. ,
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. ,
Enum:
{
EqualsAny: No description available. ,
Equals: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. ,
Required: False ,
}
string ,
state:
{
Description: Defines the state of a log scrubbing rule. Default value is enabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Describes the name of the rule. ,
Required: False ,
}
string ,
priority:
{
Description: Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. ,
Required: True ,
}
integer ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
ruleType:
{
Description: Describes type of rule. ,
Enum:
{
MatchRule: No description available. ,
RateLimitRule: No description available. ,
}
,
Required: True ,
}
enum ,
rateLimitDurationInMinutes:
{
Description: Time window for resetting the rate limit count. Default is 1 minute. ,
Required: False ,
}
integer ,
rateLimitThreshold:
{
Description: Number of allowed requests per client within the time window. ,
Required: False ,
}
integer ,
groupBy:
{
Description: Describes the list of variables to group the rate limit requests ,
Required: False ,
}
[
{
variableName:
{
Description: Describes the supported variable for group by ,
Enum:
{
SocketAddr: No description available. ,
GeoLocation: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Request variable to compare with. ,
Enum:
{
RemoteAddr: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
SocketAddr: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. ,
Required: False ,
}
string ,
operator:
{
Description: Comparison type to use for matching with the variable value. ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
ServiceTagMatch: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
ruleSetAction:
{
Description: Defines the rule set action. ,
Enum:
{
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the set. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
ruleGroupOverrides:
{
Description: Defines the rule group overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group to override. ,
Required: True ,
}
string ,
exclusions:
{
Description: Describes the exclusions that are applied to all rules in the group. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
sensitivity:
{
Description: Describes the override sensitivity to be applied when rule matches. ,
Enum:
{
Low: Low Sensitivity - triggers the rule by larger spikes in traffic ,
Medium: Medium Sensitivity - triggers the rule by moderate spikes in traffic ,
High: High Sensitivity - triggers the rule by smaller spikes in traffic ,
}
,
Required: False ,
}
enum ,
exclusions:
{
Description: Describes the exclusions that are applied to this specific rule. ,
Required: False ,
}
[
{
matchVariable:
{
Description: The variable type to be excluded. ,
Enum:
{
RequestHeaderNames: No description available. ,
RequestCookieNames: No description available. ,
QueryStringArgNames: No description available. ,
RequestBodyPostArgNames: No description available. ,
RequestBodyJsonArgNames: No description available. ,
}
,
Required: True ,
}
enum ,
selectorMatchOperator:
{
Description: Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. ,
Enum:
{
Equals: No description available. ,
Contains: No description available. ,
StartsWith: No description available. ,
EndsWith: No description available. ,
EqualsAny: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector value for which elements in the collection this exclusion applies to. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
frontendEndpointLinks:
{
Description: Describes Frontend Endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
routingRuleLinks:
{
Description: Describes Routing Rules associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
securityPolicyLinks:
{
Description: Describes Security Policy associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the policy. ,
Required: False ,
}
string ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified. ,
Required: False ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Classic_AzureFrontDoor: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_Delete (new)
Description :  Deletes Policy
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the Web Application Firewall Policy. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
ManagedRuleSets_List (new)
Description :  Lists all available managed rule sets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets
{
subscriptionId:
{
Description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of managed rule set definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Properties for a managed rule set definition. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the managed rule set. ,
Required: False ,
}
string ,
ruleSetId:
{
Description: Id of the managed rule set. ,
Required: False ,
}
string ,
ruleSetType:
{
Description: Type of the managed rule set. ,
Required: False ,
}
string ,
ruleSetVersion:
{
Description: Version of the managed rule set type. ,
Required: False ,
}
string ,
ruleGroups:
{
Description: Rule groups of the managed rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Name of the managed rule group. ,
Required: False ,
}
string ,
description:
{
Description: Description of the managed rule group. ,
Required: False ,
}
string ,
rules:
{
Description: List of rules within the managed rule group. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: False ,
}
string ,
defaultState:
{
Description: Describes the default state for the managed rule. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
defaultAction:
{
Description: Describes the default action to be applied when the managed rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
AnomalyScoring: No description available. ,
JSChallenge: No description available. ,
CAPTCHA: No description available. ,
}
,
Required: False ,
}
enum ,
defaultSensitivity:
{
Description: Describes the default sensitivity to be applied when the managed rule matches. ,
Enum:
{
Low: Low Sensitivity - triggers the rule by larger spikes in traffic ,
Medium: Medium Sensitivity - triggers the rule by moderate spikes in traffic ,
High: High Sensitivity - triggers the rule by smaller spikes in traffic ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Describes the functionality of the managed rule. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve next set of managed rule set definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}