Microsoft Azure Traffic Controller is a cloud-based service that helps businesses manage and optimize their network traffic. The Traffic Controller allows users to set rules and policies for how traffic is routed between different resources in their Azure environment, ensuring that critical applications receive the bandwidth and resources they need to perform at their best.
swagger: '2.0'
info:
title: Microsoft Azure TrafficController
version: 2023-05-01-preview
description: Traffic Controller Provider management API.
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
schemes:
- https
host: management.azure.com
produces:
- application/json
consumes:
- application/json
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
description: Azure Active Directory OAuth2 Flow.
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
user_impersonation: impersonate your user account
tags:
- name: AssociationsInterface
- name: FrontendsInterface
- name: Operations
- name: TrafficControllerInterface
paths:
/providers/Microsoft.ServiceNetworking/operations:
get:
operationId: microsoftAzureOperationsList
tags:
- Operations
description: List the operations for the provider
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Get Operations List:
$ref: ./examples/OperationsList.json
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Providers Microsoft Servicenetworking Operations
/subscriptions/{subscriptionId}/providers/Microsoft.ServiceNetworking/trafficControllers:
get:
operationId: microsoftAzureTrafficcontrollerinterfaceListbysubscription
tags:
- TrafficControllerInterface
description: List TrafficController resources by subscription ID
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/TrafficControllerListResult'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Get Traffic Controllers List:
$ref: ./examples/TrafficControllersGetList.json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Servicenetworking Trafficcontrollers
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers
: get:
operationId: microsoftAzureTrafficcontrollerinterfaceListbyresourcegroup
tags:
- TrafficControllerInterface
description: List TrafficController resources by resource group
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/TrafficControllerListResult'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Get Traffic Controllers:
$ref: ./examples/TrafficControllersGet.json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}
: get:
operationId: microsoftAzureTrafficcontrollerinterfaceGet
tags:
- TrafficControllerInterface
description: Get a TrafficController
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/TrafficController'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Get Traffic Controller:
$ref: ./examples/TrafficControllerGet.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername
put:
operationId: microsoftAzureTrafficcontrollerinterfaceCreateorupdate
tags:
- TrafficControllerInterface
description: Create a TrafficController
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: resource
in: body
description: Resource create parameters.
required: true
schema:
$ref: '#/definitions/TrafficController'
responses:
'200':
description: Resource 'TrafficController' update operation succeeded
schema:
$ref: '#/definitions/TrafficController'
'201':
description: Resource 'TrafficController' create operation succeeded
schema:
$ref: '#/definitions/TrafficController'
headers:
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Put Traffic Controller:
$ref: ./examples/TrafficControllerPut.json
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername
patch:
operationId: microsoftAzureTrafficcontrollerinterfaceUpdate
tags:
- TrafficControllerInterface
description: Update a TrafficController
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: properties
in: body
description: The resource properties to be updated.
required: true
schema:
$ref: '#/definitions/TrafficControllerUpdate'
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/TrafficController'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Patch Traffic Controller:
$ref: ./examples/TrafficControllerPatch.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername
delete:
operationId: microsoftAzureTrafficcontrollerinterfaceDelete
tags:
- TrafficControllerInterface
description: Delete a TrafficController
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
responses:
'200':
description: Resource deleted successfully.
'202':
description: Resource deletion accepted.
headers:
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
Location:
type: string
description: >-
The Location header contains the URL where the status of the
long running operation can be checked.
'204':
description: Resource deleted successfully.
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Delete Traffic Controller:
$ref: ./examples/TrafficControllerDelete.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations
: get:
operationId: microsoftAzureAssociationsinterfaceListbytrafficcontroller
tags:
- AssociationsInterface
description: List Association resources by TrafficController
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/AssociationListResult'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Get Associations:
$ref: ./examples/AssociationsGet.json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername Associations
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}
: get:
operationId: microsoftAzureAssociationsinterfaceGet
tags:
- AssociationsInterface
description: Get a Association
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: associationName
in: path
description: Name of Association
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/Association'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Get Association:
$ref: ./examples/AssociationGet.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername Associations Associationname
put:
operationId: microsoftAzureAssociationsinterfaceCreateorupdate
tags:
- AssociationsInterface
description: Create a Association
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: associationName
in: path
description: Name of Association
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: resource
in: body
description: Resource create parameters.
required: true
schema:
$ref: '#/definitions/Association'
responses:
'200':
description: Resource 'Association' update operation succeeded
schema:
$ref: '#/definitions/Association'
'201':
description: Resource 'Association' create operation succeeded
schema:
$ref: '#/definitions/Association'
headers:
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Put Association:
$ref: ./examples/AssociationPut.json
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername Associations Associationname
patch:
operationId: microsoftAzureAssociationsinterfaceUpdate
tags:
- AssociationsInterface
description: Update a Association
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: associationName
in: path
description: Name of Association
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: properties
in: body
description: The resource properties to be updated.
required: true
schema:
$ref: '#/definitions/AssociationUpdate'
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/Association'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Update Association:
$ref: ./examples/AssociationPatch.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername Associations Associationname
delete:
operationId: microsoftAzureAssociationsinterfaceDelete
tags:
- AssociationsInterface
description: Delete a Association
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: associationName
in: path
description: Name of Association
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
responses:
'200':
description: Resource deleted successfully.
'202':
description: Resource deletion accepted.
headers:
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
Location:
type: string
description: >-
The Location header contains the URL where the status of the
long running operation can be checked.
'204':
description: Resource deleted successfully.
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Delete Association:
$ref: ./examples/AssociationDelete.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername Associations Associationname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends
: get:
operationId: microsoftAzureFrontendsinterfaceListbytrafficcontroller
tags:
- FrontendsInterface
description: List Frontend resources by TrafficController
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/FrontendListResult'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Get Frontends:
$ref: ./examples/FrontendsGet.json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername Frontends
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}
: get:
operationId: microsoftAzureFrontendsinterfaceGet
tags:
- FrontendsInterface
description: Get a Frontend
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: frontendName
in: path
description: Frontends
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/Frontend'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Get Frontend:
$ref: ./examples/FrontendGet.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername Frontends Frontendname
put:
operationId: microsoftAzureFrontendsinterfaceCreateorupdate
tags:
- FrontendsInterface
description: Create a Frontend
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: frontendName
in: path
description: Frontends
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: resource
in: body
description: Resource create parameters.
required: true
schema:
$ref: '#/definitions/Frontend'
responses:
'200':
description: Resource 'Frontend' update operation succeeded
schema:
$ref: '#/definitions/Frontend'
'201':
description: Resource 'Frontend' create operation succeeded
schema:
$ref: '#/definitions/Frontend'
headers:
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Put Frontend:
$ref: ./examples/FrontendPut.json
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername Frontends Frontendname
patch:
operationId: microsoftAzureFrontendsinterfaceUpdate
tags:
- FrontendsInterface
description: Update a Frontend
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: frontendName
in: path
description: Frontends
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: properties
in: body
description: The resource properties to be updated.
required: true
schema:
$ref: '#/definitions/FrontendUpdate'
responses:
'200':
description: ARM operation completed successfully.
schema:
$ref: '#/definitions/Frontend'
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Update Frontend:
$ref: ./examples/FrontendPatch.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername Frontends Frontendname
delete:
operationId: microsoftAzureFrontendsinterfaceDelete
tags:
- FrontendsInterface
description: Delete a Frontend
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
- name: trafficControllerName
in: path
description: traffic controller name for path
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
- name: frontendName
in: path
description: Frontends
required: true
type: string
pattern: ^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$
responses:
'200':
description: Resource deleted successfully.
'202':
description: Resource deletion accepted.
headers:
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
Location:
type: string
description: >-
The Location header contains the URL where the status of the
long running operation can be checked.
'204':
description: Resource deleted successfully.
default:
description: An unexpected error response.
schema:
$ref: >-
../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-examples:
Delete Frontend:
$ref: ./examples/FrontendDelete.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Servicenetworking Trafficcontrollers Trafficcontrollername Frontends Frontendname
definitions:
Association:
type: object
description: Association Subresource of Traffic Controller
properties:
properties:
$ref: '#/definitions/AssociationProperties'
description: The resource-specific properties for this resource.
x-ms-client-flatten: t
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/trafficcontroller-openapi-original.yml