Microsoft.ProgrammableConnectivity (preview:2024-01-15)

2025/05/02 • 11 updated methods

Gateways_ListBySubscription (updated)
Description :  List Gateway resources by subscription ID.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Gateways_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "A Programmable Connectivity Gateway resource.",
            "old": "A Programmable Connectivity Gateway resource"
          },
          "$properties": {
            "properties": [
              {
                "#name": "operatorApiConnections",
                "Description": {
                  "new": "List of Operator API Connections selected by the user.",
                  "old": "List of Operator API Connections selected by the user"
                }
              },
              {
                "#name": "gatewayBaseUrl",
                "Description": {
                  "new": "Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure.",
                  "old": "Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProgrammableConnectivity/gateways
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Gateway items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiConnections:
{
Description: List of Operator API Connections selected by the user. ,
Required: False ,
}
[
string ,
]
,
gatewayBaseUrl:
{
Description: Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation on the Gateway resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperatorApiConnections_ListBySubscription (updated)
Description :  List OperatorApiConnection resources by subscription ID.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OperatorApiConnections_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "configuredApplication": [
                  {
                    "#name": "name",
                    "Description": {
                      "new": "Name of the application.",
                      "old": "Name of the application. Example: Contoso App."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProgrammableConnectivity/operatorApiConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OperatorApiConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiPlanId:
{
Description: Reference to the Operator API Plan Resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
saasProperties:
{
Description: Details about the SaaS offer purchased from the marketplace. ,
Required: False ,
}
{
saasSubscriptionId:
{
Description: Subscription ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
saasResourceId:
{
Description: Resource ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
}
,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: False ,
}
{
name:
{
Description: Name of the application. ,
Required: False ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The category that describes the application. ,
Required: False ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: False ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: False ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: False ,
}
string ,
privacyContactEmailAddress:
{
Description: Email address of the Privacy contact or Data Protection officer of the organization. ,
Required: False ,
}
string ,
}
,
appId:
{
Description: Application ID of the App Developer that is registered with the Operator in a specific country/region. ,
Required: False ,
}
string ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
accountType:
{
Description: Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged. ,
Enum:
{
AzureManaged: Managed by Azure on-behalf-of the user. ,
UserManaged: Managed by the User themselves on the Operator end. ,
}
,
Required: True ,
}
enum ,
appSecret:
{
Description: Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read. ,
Format: password ,
Required: False ,
}
string ,
operatorName:
{
Description: Name of the Operator in the linked Operator API Plan belongs to. ,
Required: False ,
}
string ,
camaraApiName:
{
Description: The Network API for the current operator in the country/region provided in the linked Operator API Plan. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the OperatorApiConnection resource. ,
Required: False ,
}
{
state:
{
Description: Current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
reason:
{
Description: Explanation of the current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_ListByResourceGroup (updated)
Description :  List Gateway resources by resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Gateways_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "A Programmable Connectivity Gateway resource.",
            "old": "A Programmable Connectivity Gateway resource"
          },
          "$properties": {
            "properties": [
              {
                "#name": "operatorApiConnections",
                "Description": {
                  "new": "List of Operator API Connections selected by the user.",
                  "old": "List of Operator API Connections selected by the user"
                }
              },
              {
                "#name": "gatewayBaseUrl",
                "Description": {
                  "new": "Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure.",
                  "old": "Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/gateways
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Gateway items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiConnections:
{
Description: List of Operator API Connections selected by the user. ,
Required: False ,
}
[
string ,
]
,
gatewayBaseUrl:
{
Description: Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation on the Gateway resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_Get (updated)
Description :  Get a Gateway resource by name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Gateways_Get",
  "$parameters": [
    {
      "#name": "gatewayName",
      "Description": {
        "new": "Azure Programmable Connectivity Gateway Name.",
        "old": "Azure Programmable Connectivity Gateway Name"
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "A Programmable Connectivity Gateway resource.",
        "old": "A Programmable Connectivity Gateway resource"
      },
      "$properties": {
        "properties": [
          {
            "#name": "operatorApiConnections",
            "Description": {
              "new": "List of Operator API Connections selected by the user.",
              "old": "List of Operator API Connections selected by the user"
            }
          },
          {
            "#name": "gatewayBaseUrl",
            "Description": {
              "new": "Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure.",
              "old": "Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/gateways/{gatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Azure Programmable Connectivity Gateway Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiConnections:
{
Description: List of Operator API Connections selected by the user. ,
Required: False ,
}
[
string ,
]
,
gatewayBaseUrl:
{
Description: Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation on the Gateway resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_CreateOrUpdate (updated)
Description :  Create or update an APC Gateway.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Gateways_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "gatewayName",
      "Description": {
        "new": "Azure Programmable Connectivity Gateway Name.",
        "old": "Azure Programmable Connectivity Gateway Name"
      }
    },
    {
      "resource": {
        "Description": {
          "new": "A Programmable Connectivity Gateway resource.",
          "old": "A Programmable Connectivity Gateway resource"
        },
        "$properties": {
          "properties": [
            {
              "#name": "operatorApiConnections",
              "Description": {
                "new": "List of Operator API Connections selected by the user.",
                "old": "List of Operator API Connections selected by the user"
              }
            },
            {
              "#name": "gatewayBaseUrl",
              "Description": {
                "new": "Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure.",
                "old": "Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure."
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "A Programmable Connectivity Gateway resource.",
        "old": "A Programmable Connectivity Gateway resource"
      },
      "$properties": {
        "properties": [
          {
            "#name": "operatorApiConnections",
            "Description": {
              "new": "List of Operator API Connections selected by the user.",
              "old": "List of Operator API Connections selected by the user"
            }
          },
          {
            "#name": "gatewayBaseUrl",
            "Description": {
              "new": "Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure.",
              "old": "Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure."
            }
          }
        ]
      }
    },
    "201": {
      "Description": {
        "new": "A Programmable Connectivity Gateway resource.",
        "old": "A Programmable Connectivity Gateway resource"
      },
      "$properties": {
        "properties": [
          {
            "#name": "operatorApiConnections",
            "Description": {
              "new": "List of Operator API Connections selected by the user.",
              "old": "List of Operator API Connections selected by the user"
            }
          },
          {
            "#name": "gatewayBaseUrl",
            "Description": {
              "new": "Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure.",
              "old": "Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/gateways/{gatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Azure Programmable Connectivity Gateway Name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiConnections:
{
Description: List of Operator API Connections selected by the user. ,
Required: False ,
}
[
string ,
]
,
gatewayBaseUrl:
{
Description: Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation on the Gateway resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiConnections:
{
Description: List of Operator API Connections selected by the user. ,
Required: False ,
}
[
string ,
]
,
gatewayBaseUrl:
{
Description: Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation on the Gateway resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A Programmable Connectivity Gateway resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiConnections:
{
Description: List of Operator API Connections selected by the user. ,
Required: False ,
}
[
string ,
]
,
gatewayBaseUrl:
{
Description: Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation on the Gateway resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_Update (updated)
Description :  Update Gateway tags.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Gateways_Update",
  "$parameters": [
    {
      "#name": "gatewayName",
      "Description": {
        "new": "Azure Programmable Connectivity Gateway Name.",
        "old": "Azure Programmable Connectivity Gateway Name"
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "A Programmable Connectivity Gateway resource.",
        "old": "A Programmable Connectivity Gateway resource"
      },
      "$properties": {
        "properties": [
          {
            "#name": "operatorApiConnections",
            "Description": {
              "new": "List of Operator API Connections selected by the user.",
              "old": "List of Operator API Connections selected by the user"
            }
          },
          {
            "#name": "gatewayBaseUrl",
            "Description": {
              "new": "Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure.",
              "old": "Base URL of the Gateway resource. This is the URL that the users would use to make Open API Gateway requests to the Operators via Azure."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/gateways/{gatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Azure Programmable Connectivity Gateway Name. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiConnections:
{
Description: List of Operator API Connections selected by the user. ,
Required: False ,
}
[
string ,
]
,
gatewayBaseUrl:
{
Description: Base URL of the Gateway resource. This is the URL that the users would use to make Network API requests to the Operators via Azure. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation on the Gateway resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Gateways_Delete (updated)
Description :  Delete a Gateway.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Gateways_Delete",
  "$parameters": [
    {
      "#name": "gatewayName",
      "Description": {
        "new": "Azure Programmable Connectivity Gateway Name.",
        "old": "Azure Programmable Connectivity Gateway Name"
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/gateways/{gatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
gatewayName:
{
Description: Azure Programmable Connectivity Gateway Name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperatorApiConnections_ListByResourceGroup (updated)
Description :  List OperatorApiConnection resources by resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OperatorApiConnections_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "configuredApplication": [
                  {
                    "#name": "name",
                    "Description": {
                      "new": "Name of the application.",
                      "old": "Name of the application. Example: Contoso App."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/operatorApiConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OperatorApiConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiPlanId:
{
Description: Reference to the Operator API Plan Resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
saasProperties:
{
Description: Details about the SaaS offer purchased from the marketplace. ,
Required: False ,
}
{
saasSubscriptionId:
{
Description: Subscription ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
saasResourceId:
{
Description: Resource ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
}
,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: False ,
}
{
name:
{
Description: Name of the application. ,
Required: False ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The category that describes the application. ,
Required: False ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: False ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: False ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: False ,
}
string ,
privacyContactEmailAddress:
{
Description: Email address of the Privacy contact or Data Protection officer of the organization. ,
Required: False ,
}
string ,
}
,
appId:
{
Description: Application ID of the App Developer that is registered with the Operator in a specific country/region. ,
Required: False ,
}
string ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
accountType:
{
Description: Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged. ,
Enum:
{
AzureManaged: Managed by Azure on-behalf-of the user. ,
UserManaged: Managed by the User themselves on the Operator end. ,
}
,
Required: True ,
}
enum ,
appSecret:
{
Description: Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read. ,
Format: password ,
Required: False ,
}
string ,
operatorName:
{
Description: Name of the Operator in the linked Operator API Plan belongs to. ,
Required: False ,
}
string ,
camaraApiName:
{
Description: The Network API for the current operator in the country/region provided in the linked Operator API Plan. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the OperatorApiConnection resource. ,
Required: False ,
}
{
state:
{
Description: Current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
reason:
{
Description: Explanation of the current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperatorApiConnections_Get (updated)
Description :  Get an Operator API Connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OperatorApiConnections_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "configuredApplication": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name of the application.",
                  "old": "Name of the application. Example: Contoso App."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/operatorApiConnections/{operatorApiConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
operatorApiConnectionName:
{
Description: Azure Programmable Connectivity (APC) Operator API Connection Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiPlanId:
{
Description: Reference to the Operator API Plan Resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
saasProperties:
{
Description: Details about the SaaS offer purchased from the marketplace. ,
Required: False ,
}
{
saasSubscriptionId:
{
Description: Subscription ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
saasResourceId:
{
Description: Resource ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
}
,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: False ,
}
{
name:
{
Description: Name of the application. ,
Required: False ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The category that describes the application. ,
Required: False ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: False ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: False ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: False ,
}
string ,
privacyContactEmailAddress:
{
Description: Email address of the Privacy contact or Data Protection officer of the organization. ,
Required: False ,
}
string ,
}
,
appId:
{
Description: Application ID of the App Developer that is registered with the Operator in a specific country/region. ,
Required: False ,
}
string ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
accountType:
{
Description: Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged. ,
Enum:
{
AzureManaged: Managed by Azure on-behalf-of the user. ,
UserManaged: Managed by the User themselves on the Operator end. ,
}
,
Required: True ,
}
enum ,
appSecret:
{
Description: Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read. ,
Format: password ,
Required: False ,
}
string ,
operatorName:
{
Description: Name of the Operator in the linked Operator API Plan belongs to. ,
Required: False ,
}
string ,
camaraApiName:
{
Description: The Network API for the current operator in the country/region provided in the linked Operator API Plan. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the OperatorApiConnection resource. ,
Required: False ,
}
{
state:
{
Description: Current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
reason:
{
Description: Explanation of the current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperatorApiConnections_Create (updated)
Description :  Create an Operator API Connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OperatorApiConnections_Create",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "configuredApplication": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name of the application.",
                  "old": "Name of the application. Example: Contoso App."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "configuredApplication": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name of the application.",
                  "old": "Name of the application. Example: Contoso App."
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "configuredApplication": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name of the application.",
                  "old": "Name of the application. Example: Contoso App."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/operatorApiConnections/{operatorApiConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
operatorApiConnectionName:
{
Description: Azure Programmable Connectivity (APC) Operator API Connection Name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiPlanId:
{
Description: Reference to the Operator API Plan Resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
saasProperties:
{
Description: Details about the SaaS offer purchased from the marketplace. ,
Required: False ,
}
{
saasSubscriptionId:
{
Description: Subscription ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
saasResourceId:
{
Description: Resource ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
}
,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: False ,
}
{
name:
{
Description: Name of the application. ,
Required: False ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The category that describes the application. ,
Required: False ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: False ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: False ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: False ,
}
string ,
privacyContactEmailAddress:
{
Description: Email address of the Privacy contact or Data Protection officer of the organization. ,
Required: False ,
}
string ,
}
,
appId:
{
Description: Application ID of the App Developer that is registered with the Operator in a specific country/region. ,
Required: False ,
}
string ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
accountType:
{
Description: Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged. ,
Enum:
{
AzureManaged: Managed by Azure on-behalf-of the user. ,
UserManaged: Managed by the User themselves on the Operator end. ,
}
,
Required: True ,
}
enum ,
appSecret:
{
Description: Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read. ,
Format: password ,
Required: False ,
}
string ,
operatorName:
{
Description: Name of the Operator in the linked Operator API Plan belongs to. ,
Required: False ,
}
string ,
camaraApiName:
{
Description: The Network API for the current operator in the country/region provided in the linked Operator API Plan. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the OperatorApiConnection resource. ,
Required: False ,
}
{
state:
{
Description: Current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
reason:
{
Description: Explanation of the current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiPlanId:
{
Description: Reference to the Operator API Plan Resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
saasProperties:
{
Description: Details about the SaaS offer purchased from the marketplace. ,
Required: False ,
}
{
saasSubscriptionId:
{
Description: Subscription ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
saasResourceId:
{
Description: Resource ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
}
,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: False ,
}
{
name:
{
Description: Name of the application. ,
Required: False ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The category that describes the application. ,
Required: False ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: False ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: False ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: False ,
}
string ,
privacyContactEmailAddress:
{
Description: Email address of the Privacy contact or Data Protection officer of the organization. ,
Required: False ,
}
string ,
}
,
appId:
{
Description: Application ID of the App Developer that is registered with the Operator in a specific country/region. ,
Required: False ,
}
string ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
accountType:
{
Description: Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged. ,
Enum:
{
AzureManaged: Managed by Azure on-behalf-of the user. ,
UserManaged: Managed by the User themselves on the Operator end. ,
}
,
Required: True ,
}
enum ,
appSecret:
{
Description: Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read. ,
Format: password ,
Required: False ,
}
string ,
operatorName:
{
Description: Name of the Operator in the linked Operator API Plan belongs to. ,
Required: False ,
}
string ,
camaraApiName:
{
Description: The Network API for the current operator in the country/region provided in the linked Operator API Plan. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the OperatorApiConnection resource. ,
Required: False ,
}
{
state:
{
Description: Current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
reason:
{
Description: Explanation of the current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A Programmable Connectivity Operator API Connection resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiPlanId:
{
Description: Reference to the Operator API Plan Resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
saasProperties:
{
Description: Details about the SaaS offer purchased from the marketplace. ,
Required: False ,
}
{
saasSubscriptionId:
{
Description: Subscription ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
saasResourceId:
{
Description: Resource ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
}
,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: False ,
}
{
name:
{
Description: Name of the application. ,
Required: False ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The category that describes the application. ,
Required: False ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: False ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: False ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: False ,
}
string ,
privacyContactEmailAddress:
{
Description: Email address of the Privacy contact or Data Protection officer of the organization. ,
Required: False ,
}
string ,
}
,
appId:
{
Description: Application ID of the App Developer that is registered with the Operator in a specific country/region. ,
Required: False ,
}
string ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
accountType:
{
Description: Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged. ,
Enum:
{
AzureManaged: Managed by Azure on-behalf-of the user. ,
UserManaged: Managed by the User themselves on the Operator end. ,
}
,
Required: True ,
}
enum ,
appSecret:
{
Description: Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read. ,
Format: password ,
Required: False ,
}
string ,
operatorName:
{
Description: Name of the Operator in the linked Operator API Plan belongs to. ,
Required: False ,
}
string ,
camaraApiName:
{
Description: The Network API for the current operator in the country/region provided in the linked Operator API Plan. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the OperatorApiConnection resource. ,
Required: False ,
}
{
state:
{
Description: Current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
reason:
{
Description: Explanation of the current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperatorApiConnections_Update (updated)
Description :  Update an Operator API Connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "OperatorApiConnections_Update",
  "$parameters": {
    "properties": {
      "$properties": {
        "properties": [
          {
            "configuredApplication": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name of the application.",
                  "old": "Name of the application. Example: Contoso App."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "configuredApplication": [
              {
                "#name": "name",
                "Description": {
                  "new": "Name of the application.",
                  "old": "Name of the application. Example: Contoso App."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProgrammableConnectivity/operatorApiConnections/{operatorApiConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
operatorApiConnectionName:
{
Description: Azure Programmable Connectivity (APC) Operator API Connection Name. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiPlanId:
{
Description: Reference to the Operator API Plan Resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
saasProperties:
{
Description: Details about the SaaS offer purchased from the marketplace. ,
Required: False ,
}
{
saasSubscriptionId:
{
Description: Subscription ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
saasResourceId:
{
Description: Resource ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
}
,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: False ,
}
{
name:
{
Description: Name of the application. ,
Required: False ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The category that describes the application. ,
Required: False ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: False ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: False ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: False ,
}
string ,
privacyContactEmailAddress:
{
Description: Email address of the Privacy contact or Data Protection officer of the organization. ,
Required: False ,
}
string ,
}
,
appId:
{
Description: Application ID of the App Developer that is registered with the Operator in a specific country/region. ,
Required: False ,
}
string ,
appSecret:
{
Description: Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read. ,
Format: password ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorApiPlanId:
{
Description: Reference to the Operator API Plan Resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
saasProperties:
{
Description: Details about the SaaS offer purchased from the marketplace. ,
Required: False ,
}
{
saasSubscriptionId:
{
Description: Subscription ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
saasResourceId:
{
Description: Resource ID of the SaaS offer purchased from the marketplace. ,
Required: False ,
}
string ,
}
,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: False ,
}
{
name:
{
Description: Name of the application. ,
Required: False ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: False ,
}
string ,
applicationType:
{
Description: The category that describes the application. ,
Required: False ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: False ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: False ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: False ,
}
string ,
privacyContactEmailAddress:
{
Description: Email address of the Privacy contact or Data Protection officer of the organization. ,
Required: False ,
}
string ,
}
,
appId:
{
Description: Application ID of the App Developer that is registered with the Operator in a specific country/region. ,
Required: False ,
}
string ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
string ,
accountType:
{
Description: Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged. ,
Enum:
{
AzureManaged: Managed by Azure on-behalf-of the user. ,
UserManaged: Managed by the User themselves on the Operator end. ,
}
,
Required: True ,
}
enum ,
appSecret:
{
Description: Application secret linked to the 'appId'. This should be stored securely and is not returned back when the resource information is read. ,
Format: password ,
Required: False ,
}
string ,
operatorName:
{
Description: Name of the Operator in the linked Operator API Plan belongs to. ,
Required: False ,
}
string ,
camaraApiName:
{
Description: The Network API for the current operator in the country/region provided in the linked Operator API Plan. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create or update request has been accepted ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The status of the OperatorApiConnection resource. ,
Required: False ,
}
{
state:
{
Description: Current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
reason:
{
Description: Explanation of the current state of the OperatorApiConnection resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}