Microsoft.NetworkFunction (stable:2022-05-01)

2025/09/26 • 11 new, 11 deleted methods

NetworkFunction_ListOperations (new)
Description :  Lists all of the available NetworkFunction Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.NetworkFunction/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Azure Traffic Collector resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft NetworkFunction. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectorsBySubscription_List (new)
Description :  Return list of Azure Traffic Collectors in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkFunction/azureTrafficCollectors
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Traffic Collector resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectorsByResourceGroup_List (new)
Description :  Return list of Azure Traffic Collectors in a Resource Group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Traffic Collector resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectors_Get (new)
Description :  Gets the specified Azure Traffic Collector in a specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectors_CreateOrUpdate (new)
Description :  Creates or updates a Azure Traffic Collector resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created Azure Traffic Collector. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectors_Delete (new)
Description :  Deletes a specified Azure Traffic Collector resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectors_UpdateTags (new)
Description :  Updates the specified Azure Traffic Collector tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update Azure Traffic Collector tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CollectorPolicies_List (new)
Description :  Return list of Collector policies in a Azure Traffic Collector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}/collectorPolicies
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of collection policies. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CollectorPolicies_Get (new)
Description :  Gets the collector policy in a specified Traffic Collector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}/collectorPolicies/{collectorPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
collectorPolicyName:
{
Description: Collector Policy Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CollectorPolicies_CreateOrUpdate (new)
Description :  Creates or updates a Collector Policy resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}/collectorPolicies/{collectorPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
collectorPolicyName:
{
Description: Collector Policy Name ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created Collector Policy. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CollectorPolicies_Delete (new)
Description :  Deletes a specified Collector Policy resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}/collectorPolicies/{collectorPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
collectorPolicyName:
{
Description: Collector Policy Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
NetworkFunction_ListOperations (removed)
Description :  Lists all of the available NetworkFunction Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.NetworkFunction/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Azure Traffic Collector resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft NetworkFunction. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectorsBySubscription_List (removed)
Description :  Return list of Azure Traffic Collectors in a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetworkFunction/azureTrafficCollectors
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Traffic Collector resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectorsByResourceGroup_List (removed)
Description :  Return list of Azure Traffic Collectors in a Resource Group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Traffic Collector resources. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectors_Get (removed)
Description :  Gets the specified Azure Traffic Collector in a specified resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectors_CreateOrUpdate (removed)
Description :  Creates or updates a Azure Traffic Collector resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created Azure Traffic Collector. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectors_Delete (removed)
Description :  Deletes a specified Azure Traffic Collector resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureTrafficCollectors_UpdateTags (removed)
Description :  Updates the specified Azure Traffic Collector tags.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update Azure Traffic Collector tags. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Azure Traffic Collector. ,
Required: False ,
}
{
collectorPolicies:
{
Description: Collector Policies for Azure Traffic Collector. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
virtualHub:
{
Description: The virtualHub to which the Azure Traffic Collector belongs. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the application rule collection resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CollectorPolicies_List (removed)
Description :  Return list of Collector policies in a Azure Traffic Collector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}/collectorPolicies
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of collection policies. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CollectorPolicies_Get (removed)
Description :  Gets the collector policy in a specified Traffic Collector
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}/collectorPolicies/{collectorPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
collectorPolicyName:
{
Description: Collector Policy Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CollectorPolicies_CreateOrUpdate (removed)
Description :  Creates or updates a Collector Policy resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}/collectorPolicies/{collectorPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
collectorPolicyName:
{
Description: Collector Policy Name ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created Collector Policy. ,
Required: True ,
}
{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Collector Policy. ,
Required: False ,
}
{
ingestionPolicy:
{
Description: Ingestion policies. ,
Required: False ,
}
{
ingestionType:
{
Description: The ingestion type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
ingestionSources:
{
Description: Ingestion Sources. ,
Required: False ,
}
[
{
sourceType:
{
Description: Ingestion source type. ,
Enum:
{
Resource: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
emissionPolicies:
{
Description: Emission policies. ,
Required: False ,
}
[
{
emissionType:
{
Description: Emission format type. ,
Enum:
{
IPFIX: No description available. ,
}
,
Required: False ,
}
enum ,
emissionDestinations:
{
Description: Emission policy destinations. ,
Required: False ,
}
[
{
destinationType:
{
Description: Emission destination type. ,
Enum:
{
AzureMonitor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: A unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
CollectorPolicies_Delete (removed)
Description :  Deletes a specified Collector Policy resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkFunction/azureTrafficCollectors/{azureTrafficCollectorName}/collectorPolicies/{collectorPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
azureTrafficCollectorName:
{
Description: Azure Traffic Collector name ,
Required: True ,
}
string ,
collectorPolicyName:
{
Description: Collector Policy Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}