TrafficController - Create Or Update

Reference

Service:: Application Gateway for Containers

API Version:: 2023-05-01-preview

Create a TrafficController

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}?api-version=2023-05-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
trafficControllerName	path	True	string	traffic controller name for path Regex pattern: `^[A-Za-z0-9]([A-Za-z0-9-_.]{0,62}[A-Za-z0-9])?$`
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	TrafficController	Resource 'TrafficController' update operation succeeded
201 Created	TrafficController	Resource 'TrafficController' create operation succeeded Headers Retry-After: integer
Other Status Codes	ErrorResponse	An unexpected error response.

Name

Type

Description

200 OK

TrafficController

Resource 'TrafficController' update operation succeeded

201 Created

TrafficController

Resource 'TrafficController' create operation succeeded

Headers

Retry-After: integer

Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Put Traffic Controller

Sample request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1?api-version=2023-05-01-preview

{
  "location": "NorthCentralUS",
  "tags": {
    "key1": "value1"
  }
}

Sample response

Status code:: 200

{
  "name": "tc1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1",
  "type": "Microsoft.ServiceNetworking/trafficControllers",
  "location": "NorthCentralUS",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "configurationEndpoints": [
      "abc.trafficcontroller.azure.net"
    ],
    "frontends": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1/frontends/fe1"
      }
    ],
    "associations": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1/association/as1"
      }
    ],
    "provisioningState": "Succeeded"
  }
}

Status code:: 201

{
  "name": "tc1",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1",
  "type": "Microsoft.ServiceNetworking/trafficControllers",
  "location": "NorthCentralUS",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "configurationEndpoints": [
      "abc.trafficcontroller.azure.net"
    ],
    "frontends": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1/frontends/fe1"
      }
    ],
    "associations": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1/association/as1"
      }
    ],
    "provisioningState": "Succeeded"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProvisioningState
ResourceId	Resource ID definition used by parent to reference child resources.
systemData	Metadata pertaining to creation and last modification of the resource.
TrafficController	Concrete tracked resource types can be created by aliasing this type using a specific property type.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ProvisioningState

Name	Type	Description
Accepted	string
Canceled	string
Deleting	string
Failed	string
Provisioning	string
Succeeded	string
Updating	string

ResourceId

Resource ID definition used by parent to reference child resources.

Name	Type	Description
id	string	Resource ID of child resource.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.