Update AzureCloudConnectorPublicHaDynamic

PUT 
https://api.orange.com/evolutionplatform/azure/api/v1//projects/:projectId/azure/cloudconnectors/publichadynamics/:id

This operation allows to update an AzureCloudConnectorPublicHaDynamic

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

AzureCloudConnectorPublicHaDynamic to update

namestringrequired

cloud connector name

Possible values: Value must match regular expression \S

statestringrequired

cloud connector state

Possible values: [DESIGNED, PROVISIONING, DESIGNING, SUSPENDING, STOPPING, REPAIRING, ACTIVE, INACTIVE, TERMINATED, ERROR]

bandWidthint32

cloud connector bandwidth

technicalVpnIduuidrequired

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}

azureCredentialIduuidrequired

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}

primaryPopLocalizationstringrequired

primary pop localization of the cloud connector

Possible values: Value must match regular expression \S

azureRegionstringrequired

azure region

Possible values: Value must match regular expression \S

resourceGroupNamestringrequired

azure resource group name

Possible values: Value must match regular expression \S

vnetNamestringrequired

vnet name

Possible values: Value must match regular expression \S

azureGatewaySubnetstringrequired

azure gateway subnet

Possible values: Value must match regular expression \S

azureAsnint32required

azure asn

Possible values: >= 64512 and <= 65535

networkSideAsnint32required

network side asn

Possible values: >= 64512 and <= 65535

secondaryPopLocalizationstringrequired

secondary pop localization of the cloud connector

Possible values: Value must match regular expression \S

networkSideGatewaySubnetPrimarystringrequired

network side gateway subnet primary

Possible values: Value must match regular expression \S

networkSideGatewaySubnetSecondarystringrequired

network side gateway subnet secondary

Possible values: Value must match regular expression \S

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

statestring

cloud connector state

Possible values: [DESIGNED, PROVISIONING, DESIGNING, SUSPENDING, STOPPING, REPAIRING, ACTIVE, INACTIVE, TERMINATED, ERROR]

projectNamestring

name of the project associated to the cloud connector

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

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

azureRegionstring

azure regeion

resourceGroupNamestring

azure resource group name

vnetNamestring

vnet name

azureGatewaySubnetstringrequired

azure gateway subnet

Possible values: Value must match regular expression \S

azureAsnint32

azure asn

networkSideAsnint32

network side asn

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]

networkSideGatewaySubnetPrimarystring

network side gateway subnet primary

networkSideGatewaySubnetSecondarystring

network side gateway subnet secondary

secondaryPopLocalizationstring

secondary pop localization of the cloud connector

Example (auto)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "state": "DESIGNED",
  "projectName": "string",
  "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bandWidth": 0,
  "technicalVpnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "azureCredentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "primaryPopLocalization": "string",
  "azureRegion": "string",
  "resourceGroupName": "string",
  "vnetName": "string",
  "azureGatewaySubnet": "string",
  "azureAsn": 0,
  "networkSideAsn": 0,
  "workflowExecutionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflowExecutionStatus": "CREATED",
  "networkSideGatewaySubnetPrimary": "string",
  "networkSideGatewaySubnetSecondary": "string",
  "secondaryPopLocalization": "string"
}

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: oauth2

name: oauth2clientcredentialstype: oauth2flows: {
  "clientCredentials": {
    "tokenUrl": "https://api.orange.com/oauth/v3/token",
    "scopes": {}
  }
}

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

• CURL

curl -L -X PUT 'https://api.orange.com/evolutionplatform/azure/api/v1//projects/:projectId/azure/cloudconnectors/publichadynamics/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "name": "string",
  "state": "DESIGNED",
  "bandWidth": 0,
  "technicalVpnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "azureCredentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "primaryPopLocalization": "string",
  "azureRegion": "string",
  "resourceGroupName": "string",
  "vnetName": "string",
  "azureGatewaySubnet": "string",
  "azureAsn": 0,
  "networkSideAsn": 0,
  "secondaryPopLocalization": "string",
  "networkSideGatewaySubnetPrimary": "string",
  "networkSideGatewaySubnetSecondary": "string"
}'

Request Collapse all

Base URL

https://api.orange.com/evolutionplatform/azure/api/v1/

Auth

Security Scheme

oauth2clientcredentialsapi_key

Bearer Token

Parameters

id — pathrequired

projectId — pathrequired

Body

{
  "name": "string",
  "state": "DESIGNED",
  "bandWidth": 0,
  "technicalVpnId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "azureCredentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "primaryPopLocalization": "string",
  "azureRegion": "string",
  "resourceGroupName": "string",
  "vnetName": "string",
  "azureGatewaySubnet": "string",
  "azureAsn": 0,
  "networkSideAsn": 0,
  "secondaryPopLocalization": "string",
  "networkSideGatewaySubnetPrimary": "string",
  "networkSideGatewaySubnetSecondary": "string"
}