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

2024/12/20 • 22 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceNetworking/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
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_ListBySubscription (new)
Description :  List TrafficController resources by subscription ID
Reference :  Link ¶

⚼ 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 that is applied at the Traffic Controller level. ,
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 (new)
Description :  List TrafficController resources by resource group
Reference :  Link ¶

⚼ 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 that is applied at the Traffic Controller level. ,
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 (new)
Description :  Get a TrafficController
Reference :  Link ¶

⚼ 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 that is applied at the Traffic Controller level. ,
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 (new)
Description :  Create a TrafficController
Reference :  Link ¶

⚼ 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 that is applied at the Traffic Controller level. ,
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 that is applied at the Traffic Controller level. ,
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 that is applied at the Traffic Controller level. ,
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 (new)
Description :  Update a TrafficController
Reference :  Link ¶

⚼ 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 that is applied at the Traffic Controller level. ,
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 that is applied at the Traffic Controller level. ,
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_Delete (new)
Description :  Delete a TrafficController
Reference :  Link ¶

⚼ Request

DELETE:  /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 (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
AssociationsInterface_ListByTrafficController (new)
Description :  List Association resources by TrafficController
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations
{
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 Association items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
associationType:
{
Description: Association Type ,
Enum:
{
subnets: Association of Type Subnet ,
}
,
Required: True ,
}
enum ,
subnet:
{
Description: Association Subnet ,
Required: False ,
}
{
id:
{
Description: Association ID. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller Association 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 ,
}
,
]
,
}
,
}
AssociationsInterface_Get (new)
Description :  Get a Association
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}
{
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 ,
associationName:
{
Description: Name of Association ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
associationType:
{
Description: Association Type ,
Enum:
{
subnets: Association of Type Subnet ,
}
,
Required: True ,
}
enum ,
subnet:
{
Description: Association Subnet ,
Required: False ,
}
{
id:
{
Description: Association ID. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller Association 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 ,
}
,
]
,
}
,
}
AssociationsInterface_CreateOrUpdate (new)
Description :  Create a Association
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}
{
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 ,
associationName:
{
Description: Name of Association ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
associationType:
{
Description: Association Type ,
Enum:
{
subnets: Association of Type Subnet ,
}
,
Required: True ,
}
enum ,
subnet:
{
Description: Association Subnet ,
Required: False ,
}
{
id:
{
Description: Association ID. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller Association 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 ,
}
{
associationType:
{
Description: Association Type ,
Enum:
{
subnets: Association of Type Subnet ,
}
,
Required: True ,
}
enum ,
subnet:
{
Description: Association Subnet ,
Required: False ,
}
{
id:
{
Description: Association ID. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller Association 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: Association Subresource of Traffic Controller ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
associationType:
{
Description: Association Type ,
Enum:
{
subnets: Association of Type Subnet ,
}
,
Required: True ,
}
enum ,
subnet:
{
Description: Association Subnet ,
Required: False ,
}
{
id:
{
Description: Association ID. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller Association 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 ,
}
,
]
,
}
,
}
AssociationsInterface_Update (new)
Description :  Update a Association
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}
{
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 ,
associationName:
{
Description: Name of Association ,
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 ,
}
{
associationType:
{
Description: Association Type ,
Enum:
{
subnets: Association of Type Subnet ,
}
,
Required: False ,
}
enum ,
subnet:
{
Description: Association Subnet ,
Required: False ,
}
{
id:
{
Description: Association ID. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
associationType:
{
Description: Association Type ,
Enum:
{
subnets: Association of Type Subnet ,
}
,
Required: True ,
}
enum ,
subnet:
{
Description: Association Subnet ,
Required: False ,
}
{
id:
{
Description: Association ID. ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Provisioning State of Traffic Controller Association 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 ,
}
,
]
,
}
,
}
AssociationsInterface_Delete (new)
Description :  Delete a Association
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}
{
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 ,
associationName:
{
Description: Name of Association ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
FrontendsInterface_ListByTrafficController (new)
Description :  List Frontend resources by TrafficController
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends
{
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 Frontend items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fqdn:
{
Description: The Fully Qualified Domain Name of the DNS record associated to a Traffic Controller frontend. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State of Traffic Controller Frontend 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 ,
}
,
]
,
}
,
}
FrontendsInterface_Get (new)
Description :  Get a Frontend
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}
{
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 ,
frontendName:
{
Description: Frontends ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fqdn:
{
Description: The Fully Qualified Domain Name of the DNS record associated to a Traffic Controller frontend. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State of Traffic Controller Frontend 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 ,
}
,
]
,
}
,
}
FrontendsInterface_CreateOrUpdate (new)
Description :  Create a Frontend
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}
{
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 ,
frontendName:
{
Description: Frontends ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fqdn:
{
Description: The Fully Qualified Domain Name of the DNS record associated to a Traffic Controller frontend. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State of Traffic Controller Frontend 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 ,
}
{
fqdn:
{
Description: The Fully Qualified Domain Name of the DNS record associated to a Traffic Controller frontend. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State of Traffic Controller Frontend 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: Frontend Sub Resource of Traffic Controller. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fqdn:
{
Description: The Fully Qualified Domain Name of the DNS record associated to a Traffic Controller frontend. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State of Traffic Controller Frontend 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 ,
}
,
]
,
}
,
}
FrontendsInterface_Update (new)
Description :  Update a Frontend
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}
{
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 ,
frontendName:
{
Description: Frontends ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
fqdn:
{
Description: The Fully Qualified Domain Name of the DNS record associated to a Traffic Controller frontend. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning State of Traffic Controller Frontend 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 ,
}
,
]
,
}
,
}
FrontendsInterface_Delete (new)
Description :  Delete a Frontend
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}
{
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 ,
frontendName:
{
Description: Frontends ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 (new)
Description :  List SecurityPolicy resources by TrafficController
Reference :  Link ¶

⚼ 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 ,
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 (new)
Description :  Get a SecurityPolicy
Reference :  Link ¶

⚼ 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 ,
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 (new)
Description :  Create a SecurityPolicy
Reference :  Link ¶

⚼ 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 ,
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 ,
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 ,
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 (new)
Description :  Update a SecurityPolicy
Reference :  Link ¶

⚼ 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 ,
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 ,
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_Delete (new)
Description :  Delete a SecurityPolicy
Reference :  Link ¶

⚼ Request

DELETE:  /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 (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}