Microsoft.ServiceNetworking (stable:2025-01-01)

2025/03/06 • 9 updated methods

TrafficControllerInterface_ListBySubscription (updated)
Description :  List TrafficController resources by subscription ID
Reference :  Link ¶

⚶ Changes

{
  "#id": "TrafficControllerInterface_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "securityPolicyConfigurations": [
                  {
                    "#name": "wafSecurityPolicy",
                    "Description": {
                      "new": "Contains reference to a WAF-type security policy.",
                      "old": "Contains reference to a WAF-type security policy that is applied at the Traffic Controller level."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceNetworking/trafficControllers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TrafficController items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationEndpoints:
{
Description: Configuration Endpoints. ,
Required: False ,
}
[
string ,
]
,
frontends:
{
Description: Frontends References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
associations:
{
Description: Associations References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicies:
{
Description: Security Policies References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicyConfigurations:
{
Description: Security Policy Configuration ,
Required: False ,
}
{
wafSecurityPolicy:
{
Description: Contains reference to a WAF-type security policy. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Waf Security Policy ,
Required: True ,
}
string ,
}
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrafficControllerInterface_ListByResourceGroup (updated)
Description :  List TrafficController resources by resource group
Reference :  Link ¶

⚶ Changes

{
  "#id": "TrafficControllerInterface_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "securityPolicyConfigurations": [
                  {
                    "#name": "wafSecurityPolicy",
                    "Description": {
                      "new": "Contains reference to a WAF-type security policy.",
                      "old": "Contains reference to a WAF-type security policy that is applied at the Traffic Controller level."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TrafficController items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationEndpoints:
{
Description: Configuration Endpoints. ,
Required: False ,
}
[
string ,
]
,
frontends:
{
Description: Frontends References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
associations:
{
Description: Associations References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicies:
{
Description: Security Policies References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicyConfigurations:
{
Description: Security Policy Configuration ,
Required: False ,
}
{
wafSecurityPolicy:
{
Description: Contains reference to a WAF-type security policy. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Waf Security Policy ,
Required: True ,
}
string ,
}
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrafficControllerInterface_Get (updated)
Description :  Get a TrafficController
Reference :  Link ¶

⚶ Changes

{
  "#id": "TrafficControllerInterface_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "securityPolicyConfigurations": [
              {
                "#name": "wafSecurityPolicy",
                "Description": {
                  "new": "Contains reference to a WAF-type security policy.",
                  "old": "Contains reference to a WAF-type security policy that is applied at the Traffic Controller level."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trafficControllerName:
{
Description: traffic controller name for path ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationEndpoints:
{
Description: Configuration Endpoints. ,
Required: False ,
}
[
string ,
]
,
frontends:
{
Description: Frontends References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
associations:
{
Description: Associations References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicies:
{
Description: Security Policies References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicyConfigurations:
{
Description: Security Policy Configuration ,
Required: False ,
}
{
wafSecurityPolicy:
{
Description: Contains reference to a WAF-type security policy. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Waf Security Policy ,
Required: True ,
}
string ,
}
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrafficControllerInterface_CreateOrUpdate (updated)
Description :  Create a TrafficController
Reference :  Link ¶

⚶ Changes

{
  "#id": "TrafficControllerInterface_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "securityPolicyConfigurations": [
              {
                "#name": "wafSecurityPolicy",
                "Description": {
                  "new": "Contains reference to a WAF-type security policy.",
                  "old": "Contains reference to a WAF-type security policy that is applied at the Traffic Controller level."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "securityPolicyConfigurations": [
              {
                "#name": "wafSecurityPolicy",
                "Description": {
                  "new": "Contains reference to a WAF-type security policy.",
                  "old": "Contains reference to a WAF-type security policy that is applied at the Traffic Controller level."
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "securityPolicyConfigurations": [
              {
                "#name": "wafSecurityPolicy",
                "Description": {
                  "new": "Contains reference to a WAF-type security policy.",
                  "old": "Contains reference to a WAF-type security policy that is applied at the Traffic Controller level."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trafficControllerName:
{
Description: traffic controller name for path ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationEndpoints:
{
Description: Configuration Endpoints. ,
Required: False ,
}
[
string ,
]
,
frontends:
{
Description: Frontends References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
associations:
{
Description: Associations References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicies:
{
Description: Security Policies References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicyConfigurations:
{
Description: Security Policy Configuration ,
Required: False ,
}
{
wafSecurityPolicy:
{
Description: Contains reference to a WAF-type security policy. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Waf Security Policy ,
Required: True ,
}
string ,
}
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationEndpoints:
{
Description: Configuration Endpoints. ,
Required: False ,
}
[
string ,
]
,
frontends:
{
Description: Frontends References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
associations:
{
Description: Associations References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicies:
{
Description: Security Policies References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicyConfigurations:
{
Description: Security Policy Configuration ,
Required: False ,
}
{
wafSecurityPolicy:
{
Description: Contains reference to a WAF-type security policy. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Waf Security Policy ,
Required: True ,
}
string ,
}
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Concrete tracked resource types can be created by aliasing this type using a specific property type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationEndpoints:
{
Description: Configuration Endpoints. ,
Required: False ,
}
[
string ,
]
,
frontends:
{
Description: Frontends References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
associations:
{
Description: Associations References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicies:
{
Description: Security Policies References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicyConfigurations:
{
Description: Security Policy Configuration ,
Required: False ,
}
{
wafSecurityPolicy:
{
Description: Contains reference to a WAF-type security policy. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Waf Security Policy ,
Required: True ,
}
string ,
}
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TrafficControllerInterface_Update (updated)
Description :  Update a TrafficController
Reference :  Link ¶

⚶ Changes

{
  "#id": "TrafficControllerInterface_Update",
  "$parameters": {
    "properties": {
      "$properties": {
        "properties": [
          {
            "securityPolicyConfigurations": [
              {
                "#name": "wafSecurityPolicy",
                "Description": {
                  "new": "Contains reference to a WAF-type security policy.",
                  "old": "Contains reference to a WAF-type security policy that is applied at the Traffic Controller level."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "securityPolicyConfigurations": [
              {
                "#name": "wafSecurityPolicy",
                "Description": {
                  "new": "Contains reference to a WAF-type security policy.",
                  "old": "Contains reference to a WAF-type security policy that is applied at the Traffic Controller level."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trafficControllerName:
{
Description: traffic controller name for path ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securityPolicyConfigurations:
{
Description: Security Policy Configuration ,
Required: False ,
}
{
wafSecurityPolicy:
{
Description: Contains reference to a WAF-type security policy. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Waf Security Policy ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
configurationEndpoints:
{
Description: Configuration Endpoints. ,
Required: False ,
}
[
string ,
]
,
frontends:
{
Description: Frontends References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
associations:
{
Description: Associations References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicies:
{
Description: Security Policies References List ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of child resource. ,
Required: True ,
}
string ,
}
,
]
,
securityPolicyConfigurations:
{
Description: Security Policy Configuration ,
Required: False ,
}
{
wafSecurityPolicy:
{
Description: Contains reference to a WAF-type security policy. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the Waf Security Policy ,
Required: True ,
}
string ,
}
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityPoliciesInterface_ListByTrafficController (updated)
Description :  List SecurityPolicy resources by TrafficController
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecurityPoliciesInterface_ListByTrafficController",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "wafPolicy",
                "Description": {
                  "new": "Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set.",
                  "old": "Web Application Firewall Policy of the Traffic Controller Security Policy"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/securityPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trafficControllerName:
{
Description: traffic controller name for path ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SecurityPolicy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
policyType:
{
Description: Type of the Traffic Controller Security Policy ,
Enum:
{
waf: Policy of Type WAF ,
}
,
Required: False ,
}
enum ,
wafPolicy:
{
Description: Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the WAF ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller SecurityPolicy Resource ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityPoliciesInterface_Get (updated)
Description :  Get a SecurityPolicy
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecurityPoliciesInterface_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "wafPolicy",
            "Description": {
              "new": "Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set.",
              "old": "Web Application Firewall Policy of the Traffic Controller Security Policy"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/securityPolicies/{securityPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trafficControllerName:
{
Description: traffic controller name for path ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: SecurityPolicy ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
policyType:
{
Description: Type of the Traffic Controller Security Policy ,
Enum:
{
waf: Policy of Type WAF ,
}
,
Required: False ,
}
enum ,
wafPolicy:
{
Description: Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the WAF ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller SecurityPolicy Resource ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityPoliciesInterface_CreateOrUpdate (updated)
Description :  Create a SecurityPolicy
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecurityPoliciesInterface_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "#name": "wafPolicy",
            "Description": {
              "new": "Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set.",
              "old": "Web Application Firewall Policy of the Traffic Controller Security Policy"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "wafPolicy",
            "Description": {
              "new": "Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set.",
              "old": "Web Application Firewall Policy of the Traffic Controller Security Policy"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "wafPolicy",
            "Description": {
              "new": "Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set.",
              "old": "Web Application Firewall Policy of the Traffic Controller Security Policy"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/securityPolicies/{securityPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trafficControllerName:
{
Description: traffic controller name for path ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: SecurityPolicy ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
policyType:
{
Description: Type of the Traffic Controller Security Policy ,
Enum:
{
waf: Policy of Type WAF ,
}
,
Required: False ,
}
enum ,
wafPolicy:
{
Description: Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the WAF ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller SecurityPolicy Resource ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
policyType:
{
Description: Type of the Traffic Controller Security Policy ,
Enum:
{
waf: Policy of Type WAF ,
}
,
Required: False ,
}
enum ,
wafPolicy:
{
Description: Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the WAF ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller SecurityPolicy Resource ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: SecurityPolicy Subresource of Traffic Controller. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
policyType:
{
Description: Type of the Traffic Controller Security Policy ,
Enum:
{
waf: Policy of Type WAF ,
}
,
Required: False ,
}
enum ,
wafPolicy:
{
Description: Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the WAF ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller SecurityPolicy Resource ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityPoliciesInterface_Update (updated)
Description :  Update a SecurityPolicy
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecurityPoliciesInterface_Update",
  "$parameters": {
    "properties": {
      "$properties": {
        "properties": [
          {
            "#name": "wafPolicy",
            "Description": {
              "new": "Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set.",
              "old": "Web Application Firewall Policy of the Traffic Controller Security Policy"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "wafPolicy",
            "Description": {
              "new": "Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set.",
              "old": "Web Application Firewall Policy of the Traffic Controller Security Policy"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/securityPolicies/{securityPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
trafficControllerName:
{
Description: traffic controller name for path ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: SecurityPolicy ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
wafPolicy:
{
Description: Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the WAF ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
policyType:
{
Description: Type of the Traffic Controller Security Policy ,
Enum:
{
waf: Policy of Type WAF ,
}
,
Required: False ,
}
enum ,
wafPolicy:
{
Description: Web Application Firewall Policy of the Traffic Controller Security Policy. Single Security Policy can have only one policy type set. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the WAF ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller SecurityPolicy Resource ,
Enum:
{
Provisioning: Resource in Provisioning State ,
Updating: Resource in Updating State ,
Deleting: Resource in Deleting State ,
Accepted: Resource in Accepted State ,
Succeeded: Resource in Succeeded State ,
Failed: Resource in Failed State ,
Canceled: Resource in Canceled State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}