Registered Asns - Create Or Update

Service:

Peering

API Version:

2021-01-01

Creates a new registered ASN with the specified name under the given subscription, resource group and peering.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredAsns/{registeredAsnName}?api-version=2021-01-01

URI Parameters

Name	In	Required	Type	Description
peeringName	path	True	string	The name of the peering.
registeredAsnName	path	True	string	The name of the ASN.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The Azure subscription ID.
api-version	query	True	string	The client API version.

Request Body

Name	Type	Description
properties.asn	integer (int32)	The customer's ASN from which traffic originates.

Responses

Name	Type	Description
200 OK	PeeringRegisteredAsn	OK
201 Created	PeeringRegisteredAsn	Created
Other Status Codes	ErrorResponse	Error response describing why the operation has 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

Create or update a registered ASN for the peering

Sample request

HTTP

PUT https://management.azure.com/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredAsns/registeredAsnName?api-version=2021-01-01

{
  "properties": {
    "asn": 65000
  }
}

Java

/**
 * Samples for RegisteredAsns CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/peering/resource-manager/Microsoft.Peering/stable/2021-01-01/examples/CreateRegisteredAsn.json
     */
    /**
     * Sample code: Create or update a registered ASN for the peering.
     * 
     * @param manager Entry point to PeeringManager.
     */
    public static void
        createOrUpdateARegisteredASNForThePeering(com.azure.resourcemanager.peering.PeeringManager manager) {
        manager.registeredAsns().define("registeredAsnName").withExistingPeering("rgName", "peeringName").withAsn(65000)
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "properties": {
    "asn": 65000,
    "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000",
    "provisioningState": "Succeeded"
  },
  "name": "registeredAsnName",
  "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredAsns/registeredAsnName",
  "type": "Microsoft.Peering/registeredAsns"
}

Status code:

201

{
  "properties": {
    "asn": 65000,
    "peeringServicePrefixKey": "00000000-0000-0000-0000-000000000000",
    "provisioningState": "Succeeded"
  },
  "name": "registeredAsnName",
  "id": "/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Peering/peerings/peeringName/registeredAsns/registeredAsnName",
  "type": "Microsoft.Peering/registeredAsns"
}

Definitions

Name	Description
ErrorDetail	The error detail that describes why an operation has failed.
ErrorResponse	The error response that indicates why an operation has failed.
PeeringRegisteredAsn	The customer's ASN that is registered by the peering service provider.
provisioningState	The provisioning state of the resource.

ErrorDetail

Object

The error detail that describes why an operation has failed.

Name	Type	Description
code	string	The error code.
message	string	The error message.

ErrorResponse

Object

The error response that indicates why an operation has failed.

Name	Type	Description
error	ErrorDetail	The error detail that describes why an operation has failed.

PeeringRegisteredAsn

Object

The customer's ASN that is registered by the peering service provider.

Name	Type	Description
id	string	The ID of the resource.
name	string	The name of the resource.
properties.asn	integer (int32)	The customer's ASN from which traffic originates.
properties.peeringServicePrefixKey	string	The peering service prefix key that is to be shared with the customer.
properties.provisioningState	provisioningState	The provisioning state of the resource.
type	string	The type of the resource.

provisioningState

Enumeration

The provisioning state of the resource.

Value	Description
Succeeded
Updating
Deleting
Failed