Patch AzureCloudConnectorPublicStandardDynamic

PATCH 
/api/v1/projects/:projectId/azure/cloudconnectors/publicstandarddynamics/:id

This operation allows to patch an AzureCloudConnectorPublicStandardDynamic

Request

Path Parameters

id uuidrequired

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

cloud connector Id

projectId uuidrequired

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

project Id

application/json

Body

AzureCloudConnectorPublicStandardDynamic to patch

statestring
cloud connector state
Possible values: [DESIGNED, PROVISIONING, DESIGNING, SUSPENDING, STOPPING, REPAIRING, ACTIVE, INACTIVE, TERMINATED, ERROR]
namestring
cloud connector name
Default value: name-of-your-CC
bandwidthint32
cloud connector bandwidth
maxBandwidthint32
cloud connector maximum bandwidth
technicalVpnIduuid
network connector uuid associated to the cloud connector
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
azureCredentialIduuid
azure credential uuid to be used to manage the cloud connector on Azure
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
primaryPopLocalizationstring
primary pop localization of the cloud connector
Default value: primary-network-point-of-service-Id
azureRegionstring
azure region
Default value: region-of-your-RG
resourceGroupNamestring
azure resource group name
Default value: name-of-your-RG
vnetNamestring
vnet name
Default value: name-of-your-VNET
azureGatewaySubnetstring
azure gateway subnet
Default value: 10.0.1.0/27
azureAsnint64
azure asn
Possible values: >= 64512 and <= 4209999999
Default value: 4200000025
networkSideAsnint64
network side asn
Possible values: >= 64512 and <= 4209999999
Default value: 4200000024
networkSideGatewaySubnetstring
network side gateway subnet
Default value: 192.168.1.0/29

Responses

200

ok

application/json

Schema

Schema

iduuid
cloud connector id
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
namestring
cloud connector name
Default value: name-of-your-CC
statestring
cloud connector state
Possible values: [DESIGNED, PROVISIONING, DESIGNING, SUSPENDING, STOPPING, REPAIRING, ACTIVE, INACTIVE, TERMINATED, ERROR]
projectIduuid
uuid of the project associated to the cloud connector
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
bandwidthint32
cloud connector bandwidth
Default value: 50
maxBandwidthint32
cloud connector maximum bandwidth
Default value: 100
technicalVpnIduuid
network connector uuid associated to the cloud connector
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
azureCredentialIduuid
azure credential uuid to be used to manage the cloud connector on Azure
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
primaryPopLocalizationstring
primary pop localization of the cloud connector
Default value: primary-network-point-of-service-Id
azureRegionstring
azure region
Default value: region-of-your-RG
resourceGroupNamestring
azure resource group name
Default value: name-of-your-RG
vnetNamestring
vnet name
Default value: name-of-your-VNET
azureGatewaySubnetstringrequired
azure gateway subnet
Possible values: Value must match regular expression \S
Default value: 10.0.1.0/27
azureAsnint64
azure asn
Default value: 4200000025
networkSideAsnint64
network side asn
Default value: 4200000024
workflowExecutionIduuid
uuid of the last workflow execution associated to the cloud connector
Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
workflowExecutionStatusstring
status of the last workflow execution associated to the cloud connector
Possible values: [CREATED, IN_PROGRESS, SUCCEEDED, FAILED, CLEARED]
operationalStatusstring
operational status of the cloud connector
Possible values: [N/A, Up, Down, Unknown]
lastTimeOperationalStatusKnowndate-time
Example: 2022-03-10T12:15:50
networkSideGatewaySubnetstring
network side gateway subnet
Default value: 192.168.1.0/29

Example (auto)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "name-of-your-CC",
  "state": "DESIGNED",
  "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bandwidth": 50,
  "maxBandwidth": 100,
  "technicalVpnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "azureCredentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "primaryPopLocalization": "primary-network-point-of-service-Id",
  "azureRegion": "region-of-your-RG",
  "resourceGroupName": "name-of-your-RG",
  "vnetName": "name-of-your-VNET",
  "azureGatewaySubnet": "10.0.1.0/27",
  "azureAsn": 4200000025,
  "networkSideAsn": 4200000024,
  "workflowExecutionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflowExecutionStatus": "CREATED",
  "operationalStatus": "N/A",
  "lastTimeOperationalStatusKnown": "2022-03-10T12:15:50",
  "networkSideGatewaySubnet": "192.168.1.0/29"
}

400

bad request

application/json

Schema

Schema

codeint32
bad request code
messagestring
bad request message
descriptionstring
bad request description
violations object[]
bad request violations
Array [
fieldstring
field
messagestring
message
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

unauthorized access

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

forbidden access

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

not found

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

internal error

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

Authorization: http

name: SecuritySchemetype: httpdescription: Authenticationscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L -X PATCH '/api/v1/projects/:projectId/azure/cloudconnectors/publicstandarddynamics/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "state": "DESIGNED",
  "name": "name-of-your-CC",
  "bandwidth": 0,
  "maxBandwidth": 0,
  "technicalVpnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "azureCredentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "primaryPopLocalization": "primary-network-point-of-service-Id",
  "azureRegion": "region-of-your-RG",
  "resourceGroupName": "name-of-your-RG",
  "vnetName": "name-of-your-VNET",
  "azureGatewaySubnet": "10.0.1.0/27",
  "azureAsn": 4200000025,
  "networkSideAsn": 4200000024,
  "networkSideGatewaySubnet": "192.168.1.0/29"
}'

Request Collapse all

Base URL

/api/v1

Auth

Bearer Token

Parameters

id — pathrequired

projectId — pathrequired

Body

{
  "state": "DESIGNED",
  "name": "name-of-your-CC",
  "bandwidth": 0,
  "maxBandwidth": 0,
  "technicalVpnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "azureCredentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "primaryPopLocalization": "primary-network-point-of-service-Id",
  "azureRegion": "region-of-your-RG",
  "resourceGroupName": "name-of-your-RG",
  "vnetName": "name-of-your-VNET",
  "azureGatewaySubnet": "10.0.1.0/27",
  "azureAsn": 4200000025,
  "networkSideAsn": 4200000024,
  "networkSideGatewaySubnet": "192.168.1.0/29"
}