Public IP Addresses - Ddos Protection Status

Gets the Ddos Protection Status of a Public IP Address

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}/ddosProtectionStatus?api-version=2024-03-01

URI Parameters

Name In Required Type Description
publicIpAddressName
path True

string

The name of the public IP address.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Client API version.

Responses

Name Type Description
200 OK

PublicIpDdosProtectionStatusResult

Request successful. The operation returns the Ddos Protection Status of this Public IP.

202 Accepted

Accepted and the operation will complete asynchronously.

Headers

Location: string

Other Status Codes

CloudError

Error response describing why the operation failed.

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

Get Ddos Protection Status of a Public IP Address

Sample request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip/ddosProtectionStatus?api-version=2024-03-01

Sample response

{
  "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip",
  "publicIpAddress": "10.0.1.5",
  "isWorkloadProtected": "True",
  "ddosProtectionPlanId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan"
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/locations/tempLocation/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-03-01

Definitions

Name Description
CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

IsWorkloadProtected

Value indicating whether the IP address is DDoS workload protected or not.

PublicIpDdosProtectionStatusResult

Response for GetPublicIpAddressDdosProtectionStatusOperation API service call.

CloudError

An error response from the service.

Name Type Description
error

CloudErrorBody

Cloud error body.

CloudErrorBody

An error response from the service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

IsWorkloadProtected

Value indicating whether the IP address is DDoS workload protected or not.

Name Type Description
False

string

True

string

PublicIpDdosProtectionStatusResult

Response for GetPublicIpAddressDdosProtectionStatusOperation API service call.

Name Type Description
ddosProtectionPlanId

string

DDoS protection plan Resource Id of a if IP address is protected through a plan.

isWorkloadProtected

IsWorkloadProtected

Value indicating whether the IP address is DDoS workload protected or not.

publicIpAddress

string

IP Address of the Public IP Resource

publicIpAddressId

string

Public IP ARM resource ID