Microsoft.ProgrammableConnectivity (preview:2025-03-30)

2025/05/02 • 15 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ProgrammableConnectivity/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
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_ListBySubscription (new)
Description :  List Gateway resources by subscription ID.
Reference :  Link ¶

⚼ 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 ,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Name of the application. ,
Required: True ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: True ,
}
string ,
category:
{
Description: The category of the application. ,
Enum:
{
Agriculture: No description available. ,
Art and design: No description available. ,
Auto and vehicle: No description available. ,
Beauty: No description available. ,
Books and reference: No description available. ,
Business: No description available. ,
Construction: No description available. ,
Defense: No description available. ,
Developer tools: No description available. ,
Education: No description available. ,
Engineering: No description available. ,
Events and entertainment: No description available. ,
Finance: No description available. ,
Food and drink: No description available. ,
Games: No description available. ,
Health and fitness: No description available. ,
Healthcare: No description available. ,
Information: No description available. ,
Kids: No description available. ,
Libraries and demo: No description available. ,
Lifestyle: No description available. ,
Manufacturing: No description available. ,
Maps and navigation: No description available. ,
Media: No description available. ,
Medical: No description available. ,
Mining: No description available. ,
Music and audio: No description available. ,
News and magazines: No description available. ,
Organizations: No description available. ,
Other: No description available. ,
Photo and video: No description available. ,
Productivity: No description available. ,
Public service: No description available. ,
Real estate: No description available. ,
Shopping: No description available. ,
Social networking and communications: No description available. ,
Sports: No description available. ,
Tourism: No description available. ,
Utilities: No description available. ,
Trading: No description available. ,
Transportation: No description available. ,
Travel and local: No description available. ,
Water: No description available. ,
Weather: No description available. ,
}
,
Required: True ,
}
enum ,
commercialName:
{
Description: Commercial name of the application. ,
Required: True ,
}
string ,
privacyRightsRequestEmailAddress:
{
Description: Privacy rights request email address. ,
Required: True ,
}
string ,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
}
,
configuredApplicationOwner:
{
Description: Details about the Organization owning the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Common name of the organization owning the application. ,
Required: True ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: True ,
}
string ,
tradingName:
{
Description: Trading name of the organization owning the application. ,
Required: True ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: True ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: True ,
}
string ,
organizationType:
{
Description: The type of organization that the Application Owner is. ,
Enum:
{
Academic scientific organization: No description available. ,
For profit organization: No description available. ,
Governmental organization: No description available. ,
Industry consortium: No description available. ,
International organization: No description available. ,
Non-governmental organization: No description available. ,
Non-profit organization: No description available. ,
Organizational unit: No description available. ,
}
,
Required: True ,
}
enum ,
organizationIdentificationId:
{
Description: ID number for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationIssuer:
{
Description: Issuing organization of the ID for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationType:
{
Description: Type of official identification of the organization. ,
Required: True ,
}
string ,
contactEmailAddress:
{
Description: Email address for the person responsible for the use of Network APIs in this application. ,
Required: True ,
}
string ,
legalRepresentative:
{
Description: Legal representative of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
privacyManager:
{
Description: Privacy manager of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
dataProtectionOfficer:
{
Description: Data Protection Officer of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
registeredGeographicAddress:
{
Description: Registered Geographic address. ,
Required: True ,
}
{
streetNumber:
{
Description: Street Number of the address. ,
Required: False ,
}
string ,
streetName:
{
Description: Street Name of the address. ,
Required: False ,
}
string ,
locality:
{
Description: Locality of the address. ,
Required: False ,
}
string ,
city:
{
Description: City of the address. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: State or province of the address. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code of the address. ,
Required: False ,
}
string ,
countryCode:
{
Description: Country code of the address. ,
Required: True ,
}
string ,
}
,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
localRepresentatives:
{
Description: List of local representatives. ,
Required: True ,
}
[
{
countryCode:
{
Description: Country code for the country/region the local representative is representing. ,
Required: True ,
}
string ,
representative:
{
Description: Local representative for this country/region. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
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_ListBySubscription (new)
Description :  List OperatorApiConnection resources by subscription ID.
Reference :  Link ¶

⚼ 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 ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
,
planTermsAndConditionsAccepted:
{
Description: Whether the caller has accepted the Terms and Conditions of the associated Operator API Plan. After creation, the planTermsAndConditionsLink property is set to the Terms and Conditions that have been accepted. Must be set to True, as the Terms and Conditions must be accepted. ,
Required: True ,
}
boolean ,
planTermsAndConditionsLinks:
{
Description: Links to the Terms and Conditions of the Operator API Plan that were accepted on creation. ,
Required: False ,
}
[
string ,
]
,
purposes:
{
Description: The purpose for which the Application will use the API. Max Items 1 currently as Operators do not support multiple. ,
Required: True ,
}
[
string ,
]
,
purposeReason:
{
Description: Explanation of the reason that justifies the purpose: specifically why is the API used for the application's use case. ,
Required: True ,
}
string ,
dataProcessingList:
{
Description: List of ways the data returned on this API is processed. ,
Required: True ,
}
[
{
processingOperation:
{
Description: The operation that is performed on the data received. ,
Enum:
{
Access: No description available. ,
Acquire: No description available. ,
Adapt: No description available. ,
Aggregate: No description available. ,
Align: No description available. ,
Alter: No description available. ,
Analyze: No description available. ,
Anonymize: No description available. ,
Assess: No description available. ,
Collect: No description available. ,
Combine: No description available. ,
Consult: No description available. ,
Copy: No description available. ,
Cross border transfer: No description available. ,
Delete: No description available. ,
Derive: No description available. ,
Destruct: No description available. ,
Disclose: No description available. ,
Disclose by transmission: No description available. ,
Display: No description available. ,
Disseminate: No description available. ,
Download: No description available. ,
Erase: No description available. ,
Export: No description available. ,
Filter: No description available. ,
Format: No description available. ,
Generate: No description available. ,
Infer: No description available. ,
Make available: No description available. ,
Match: No description available. ,
Modify: No description available. ,
Monitor: No description available. ,
Move: No description available. ,
Observe: No description available. ,
Obtain: No description available. ,
Organize: No description available. ,
Profiling: No description available. ,
Pseudonymize: No description available. ,
Query: No description available. ,
Record: No description available. ,
Reformat: No description available. ,
Remove: No description available. ,
Restrict: No description available. ,
Retrieve: No description available. ,
Screen: No description available. ,
Share: No description available. ,
Store: No description available. ,
Structure: No description available. ,
Transfer: No description available. ,
Transform: No description available. ,
Transmit: No description available. ,
Use: No description available. ,
}
,
Required: True ,
}
enum ,
contexts:
{
Description: The contexts in which the data is processed. ,
Required: True ,
}
[
string ,
]
,
duration:
{
Description: The duration or temporal limitation of the data processing. ,
Enum:
{
Endless: No description available. ,
Fixed occurrences: No description available. ,
Indeterminate: No description available. ,
Temporal: No description available. ,
Until event: No description available. ,
Until time: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of the data processing. ,
Enum:
{
Continuous: No description available. ,
Often: No description available. ,
Singular: No description available. ,
Sporadic: No description available. ,
}
,
Required: True ,
}
enum ,
transitRegions:
{
Description: The countries/regions the data transits through. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
storageRegions:
{
Description: The countries/regions the data is stored in. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
OperatorApiPlans_ListBySubscription (new)
Description :  List OperatorApiPlan resources by subscription ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProgrammableConnectivity/operatorApiPlans
{
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 ,
$filter:
{
Description: An optional OData based filter expression to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Description: An optional query parameter which specifies the maximum number of records to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: An optional query parameter which specifies the number of records to be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The OperatorApiPlan items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorName:
{
Description: Name of the Operator this plan belongs to. ,
Required: False ,
}
string ,
camaraApiName:
{
Description: Standardized Network API name defined by CAMARA specifications. ,
Required: False ,
}
string ,
supportedLocations:
{
Description: List of Azure regions where this offer is supported. ,
Required: False ,
}
[
string ,
]
,
operatorRegions:
{
Description: List of country/region names where this plan is being supported by the Operator. ,
Required: False ,
}
[
string ,
]
,
markets:
{
Description: List of country/region names where this plan is being supported by Azure Marketplace. ,
Required: False ,
}
[
string ,
]
,
limits:
{
Description: The limits, if any, will be imposed by the operator. ,
Required: False ,
}
string ,
marketplaceProperties:
{
Description: Azure marketplace properties for this plan. ,
Required: False ,
}
{
offerId:
{
Description: Azure marketplace Offer ID for this plan. ,
Required: False ,
}
string ,
publisherId:
{
Description: Azure marketplace Publisher ID for this plan. ,
Required: False ,
}
string ,
planId:
{
Description: Azure marketplace Plan ID for this plan. ,
Required: False ,
}
string ,
planTermsAndConditionsLinks:
{
Description: Links to the Terms and Conditions of the Plan that must be accepted to create an associated Operator Api Connection ,
Required: True ,
}
[
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 ,
}
,
]
,
}
,
}
OperatorApiPlans_Get (new)
Description :  Get an OperatorApiPlan resource by name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProgrammableConnectivity/operatorApiPlans/{operatorApiPlanName}
{
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 ,
operatorApiPlanName:
{
Description: APC Gateway Plan Name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatorName:
{
Description: Name of the Operator this plan belongs to. ,
Required: False ,
}
string ,
camaraApiName:
{
Description: Standardized Network API name defined by CAMARA specifications. ,
Required: False ,
}
string ,
supportedLocations:
{
Description: List of Azure regions where this offer is supported. ,
Required: False ,
}
[
string ,
]
,
operatorRegions:
{
Description: List of country/region names where this plan is being supported by the Operator. ,
Required: False ,
}
[
string ,
]
,
markets:
{
Description: List of country/region names where this plan is being supported by Azure Marketplace. ,
Required: False ,
}
[
string ,
]
,
limits:
{
Description: The limits, if any, will be imposed by the operator. ,
Required: False ,
}
string ,
marketplaceProperties:
{
Description: Azure marketplace properties for this plan. ,
Required: False ,
}
{
offerId:
{
Description: Azure marketplace Offer ID for this plan. ,
Required: False ,
}
string ,
publisherId:
{
Description: Azure marketplace Publisher ID for this plan. ,
Required: False ,
}
string ,
planId:
{
Description: Azure marketplace Plan ID for this plan. ,
Required: False ,
}
string ,
planTermsAndConditionsLinks:
{
Description: Links to the Terms and Conditions of the Plan that must be accepted to create an associated Operator Api Connection ,
Required: True ,
}
[
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_ListByResourceGroup (new)
Description :  List Gateway resources by resource group.
Reference :  Link ¶

⚼ 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 ,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Name of the application. ,
Required: True ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: True ,
}
string ,
category:
{
Description: The category of the application. ,
Enum:
{
Agriculture: No description available. ,
Art and design: No description available. ,
Auto and vehicle: No description available. ,
Beauty: No description available. ,
Books and reference: No description available. ,
Business: No description available. ,
Construction: No description available. ,
Defense: No description available. ,
Developer tools: No description available. ,
Education: No description available. ,
Engineering: No description available. ,
Events and entertainment: No description available. ,
Finance: No description available. ,
Food and drink: No description available. ,
Games: No description available. ,
Health and fitness: No description available. ,
Healthcare: No description available. ,
Information: No description available. ,
Kids: No description available. ,
Libraries and demo: No description available. ,
Lifestyle: No description available. ,
Manufacturing: No description available. ,
Maps and navigation: No description available. ,
Media: No description available. ,
Medical: No description available. ,
Mining: No description available. ,
Music and audio: No description available. ,
News and magazines: No description available. ,
Organizations: No description available. ,
Other: No description available. ,
Photo and video: No description available. ,
Productivity: No description available. ,
Public service: No description available. ,
Real estate: No description available. ,
Shopping: No description available. ,
Social networking and communications: No description available. ,
Sports: No description available. ,
Tourism: No description available. ,
Utilities: No description available. ,
Trading: No description available. ,
Transportation: No description available. ,
Travel and local: No description available. ,
Water: No description available. ,
Weather: No description available. ,
}
,
Required: True ,
}
enum ,
commercialName:
{
Description: Commercial name of the application. ,
Required: True ,
}
string ,
privacyRightsRequestEmailAddress:
{
Description: Privacy rights request email address. ,
Required: True ,
}
string ,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
}
,
configuredApplicationOwner:
{
Description: Details about the Organization owning the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Common name of the organization owning the application. ,
Required: True ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: True ,
}
string ,
tradingName:
{
Description: Trading name of the organization owning the application. ,
Required: True ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: True ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: True ,
}
string ,
organizationType:
{
Description: The type of organization that the Application Owner is. ,
Enum:
{
Academic scientific organization: No description available. ,
For profit organization: No description available. ,
Governmental organization: No description available. ,
Industry consortium: No description available. ,
International organization: No description available. ,
Non-governmental organization: No description available. ,
Non-profit organization: No description available. ,
Organizational unit: No description available. ,
}
,
Required: True ,
}
enum ,
organizationIdentificationId:
{
Description: ID number for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationIssuer:
{
Description: Issuing organization of the ID for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationType:
{
Description: Type of official identification of the organization. ,
Required: True ,
}
string ,
contactEmailAddress:
{
Description: Email address for the person responsible for the use of Network APIs in this application. ,
Required: True ,
}
string ,
legalRepresentative:
{
Description: Legal representative of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
privacyManager:
{
Description: Privacy manager of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
dataProtectionOfficer:
{
Description: Data Protection Officer of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
registeredGeographicAddress:
{
Description: Registered Geographic address. ,
Required: True ,
}
{
streetNumber:
{
Description: Street Number of the address. ,
Required: False ,
}
string ,
streetName:
{
Description: Street Name of the address. ,
Required: False ,
}
string ,
locality:
{
Description: Locality of the address. ,
Required: False ,
}
string ,
city:
{
Description: City of the address. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: State or province of the address. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code of the address. ,
Required: False ,
}
string ,
countryCode:
{
Description: Country code of the address. ,
Required: True ,
}
string ,
}
,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
localRepresentatives:
{
Description: List of local representatives. ,
Required: True ,
}
[
{
countryCode:
{
Description: Country code for the country/region the local representative is representing. ,
Required: True ,
}
string ,
representative:
{
Description: Local representative for this country/region. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
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_Get (new)
Description :  Get a Gateway resource by name.
Reference :  Link ¶

⚼ 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 ,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Name of the application. ,
Required: True ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: True ,
}
string ,
category:
{
Description: The category of the application. ,
Enum:
{
Agriculture: No description available. ,
Art and design: No description available. ,
Auto and vehicle: No description available. ,
Beauty: No description available. ,
Books and reference: No description available. ,
Business: No description available. ,
Construction: No description available. ,
Defense: No description available. ,
Developer tools: No description available. ,
Education: No description available. ,
Engineering: No description available. ,
Events and entertainment: No description available. ,
Finance: No description available. ,
Food and drink: No description available. ,
Games: No description available. ,
Health and fitness: No description available. ,
Healthcare: No description available. ,
Information: No description available. ,
Kids: No description available. ,
Libraries and demo: No description available. ,
Lifestyle: No description available. ,
Manufacturing: No description available. ,
Maps and navigation: No description available. ,
Media: No description available. ,
Medical: No description available. ,
Mining: No description available. ,
Music and audio: No description available. ,
News and magazines: No description available. ,
Organizations: No description available. ,
Other: No description available. ,
Photo and video: No description available. ,
Productivity: No description available. ,
Public service: No description available. ,
Real estate: No description available. ,
Shopping: No description available. ,
Social networking and communications: No description available. ,
Sports: No description available. ,
Tourism: No description available. ,
Utilities: No description available. ,
Trading: No description available. ,
Transportation: No description available. ,
Travel and local: No description available. ,
Water: No description available. ,
Weather: No description available. ,
}
,
Required: True ,
}
enum ,
commercialName:
{
Description: Commercial name of the application. ,
Required: True ,
}
string ,
privacyRightsRequestEmailAddress:
{
Description: Privacy rights request email address. ,
Required: True ,
}
string ,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
}
,
configuredApplicationOwner:
{
Description: Details about the Organization owning the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Common name of the organization owning the application. ,
Required: True ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: True ,
}
string ,
tradingName:
{
Description: Trading name of the organization owning the application. ,
Required: True ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: True ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: True ,
}
string ,
organizationType:
{
Description: The type of organization that the Application Owner is. ,
Enum:
{
Academic scientific organization: No description available. ,
For profit organization: No description available. ,
Governmental organization: No description available. ,
Industry consortium: No description available. ,
International organization: No description available. ,
Non-governmental organization: No description available. ,
Non-profit organization: No description available. ,
Organizational unit: No description available. ,
}
,
Required: True ,
}
enum ,
organizationIdentificationId:
{
Description: ID number for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationIssuer:
{
Description: Issuing organization of the ID for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationType:
{
Description: Type of official identification of the organization. ,
Required: True ,
}
string ,
contactEmailAddress:
{
Description: Email address for the person responsible for the use of Network APIs in this application. ,
Required: True ,
}
string ,
legalRepresentative:
{
Description: Legal representative of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
privacyManager:
{
Description: Privacy manager of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
dataProtectionOfficer:
{
Description: Data Protection Officer of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
registeredGeographicAddress:
{
Description: Registered Geographic address. ,
Required: True ,
}
{
streetNumber:
{
Description: Street Number of the address. ,
Required: False ,
}
string ,
streetName:
{
Description: Street Name of the address. ,
Required: False ,
}
string ,
locality:
{
Description: Locality of the address. ,
Required: False ,
}
string ,
city:
{
Description: City of the address. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: State or province of the address. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code of the address. ,
Required: False ,
}
string ,
countryCode:
{
Description: Country code of the address. ,
Required: True ,
}
string ,
}
,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
localRepresentatives:
{
Description: List of local representatives. ,
Required: True ,
}
[
{
countryCode:
{
Description: Country code for the country/region the local representative is representing. ,
Required: True ,
}
string ,
representative:
{
Description: Local representative for this country/region. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
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_CreateOrUpdate (new)
Description :  Create or update an APC Gateway.
Reference :  Link ¶

⚼ 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 ,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Name of the application. ,
Required: True ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: True ,
}
string ,
category:
{
Description: The category of the application. ,
Enum:
{
Agriculture: No description available. ,
Art and design: No description available. ,
Auto and vehicle: No description available. ,
Beauty: No description available. ,
Books and reference: No description available. ,
Business: No description available. ,
Construction: No description available. ,
Defense: No description available. ,
Developer tools: No description available. ,
Education: No description available. ,
Engineering: No description available. ,
Events and entertainment: No description available. ,
Finance: No description available. ,
Food and drink: No description available. ,
Games: No description available. ,
Health and fitness: No description available. ,
Healthcare: No description available. ,
Information: No description available. ,
Kids: No description available. ,
Libraries and demo: No description available. ,
Lifestyle: No description available. ,
Manufacturing: No description available. ,
Maps and navigation: No description available. ,
Media: No description available. ,
Medical: No description available. ,
Mining: No description available. ,
Music and audio: No description available. ,
News and magazines: No description available. ,
Organizations: No description available. ,
Other: No description available. ,
Photo and video: No description available. ,
Productivity: No description available. ,
Public service: No description available. ,
Real estate: No description available. ,
Shopping: No description available. ,
Social networking and communications: No description available. ,
Sports: No description available. ,
Tourism: No description available. ,
Utilities: No description available. ,
Trading: No description available. ,
Transportation: No description available. ,
Travel and local: No description available. ,
Water: No description available. ,
Weather: No description available. ,
}
,
Required: True ,
}
enum ,
commercialName:
{
Description: Commercial name of the application. ,
Required: True ,
}
string ,
privacyRightsRequestEmailAddress:
{
Description: Privacy rights request email address. ,
Required: True ,
}
string ,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
}
,
configuredApplicationOwner:
{
Description: Details about the Organization owning the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Common name of the organization owning the application. ,
Required: True ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: True ,
}
string ,
tradingName:
{
Description: Trading name of the organization owning the application. ,
Required: True ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: True ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: True ,
}
string ,
organizationType:
{
Description: The type of organization that the Application Owner is. ,
Enum:
{
Academic scientific organization: No description available. ,
For profit organization: No description available. ,
Governmental organization: No description available. ,
Industry consortium: No description available. ,
International organization: No description available. ,
Non-governmental organization: No description available. ,
Non-profit organization: No description available. ,
Organizational unit: No description available. ,
}
,
Required: True ,
}
enum ,
organizationIdentificationId:
{
Description: ID number for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationIssuer:
{
Description: Issuing organization of the ID for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationType:
{
Description: Type of official identification of the organization. ,
Required: True ,
}
string ,
contactEmailAddress:
{
Description: Email address for the person responsible for the use of Network APIs in this application. ,
Required: True ,
}
string ,
legalRepresentative:
{
Description: Legal representative of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
privacyManager:
{
Description: Privacy manager of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
dataProtectionOfficer:
{
Description: Data Protection Officer of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
registeredGeographicAddress:
{
Description: Registered Geographic address. ,
Required: True ,
}
{
streetNumber:
{
Description: Street Number of the address. ,
Required: False ,
}
string ,
streetName:
{
Description: Street Name of the address. ,
Required: False ,
}
string ,
locality:
{
Description: Locality of the address. ,
Required: False ,
}
string ,
city:
{
Description: City of the address. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: State or province of the address. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code of the address. ,
Required: False ,
}
string ,
countryCode:
{
Description: Country code of the address. ,
Required: True ,
}
string ,
}
,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
localRepresentatives:
{
Description: List of local representatives. ,
Required: True ,
}
[
{
countryCode:
{
Description: Country code for the country/region the local representative is representing. ,
Required: True ,
}
string ,
representative:
{
Description: Local representative for this country/region. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
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 ,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Name of the application. ,
Required: True ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: True ,
}
string ,
category:
{
Description: The category of the application. ,
Enum:
{
Agriculture: No description available. ,
Art and design: No description available. ,
Auto and vehicle: No description available. ,
Beauty: No description available. ,
Books and reference: No description available. ,
Business: No description available. ,
Construction: No description available. ,
Defense: No description available. ,
Developer tools: No description available. ,
Education: No description available. ,
Engineering: No description available. ,
Events and entertainment: No description available. ,
Finance: No description available. ,
Food and drink: No description available. ,
Games: No description available. ,
Health and fitness: No description available. ,
Healthcare: No description available. ,
Information: No description available. ,
Kids: No description available. ,
Libraries and demo: No description available. ,
Lifestyle: No description available. ,
Manufacturing: No description available. ,
Maps and navigation: No description available. ,
Media: No description available. ,
Medical: No description available. ,
Mining: No description available. ,
Music and audio: No description available. ,
News and magazines: No description available. ,
Organizations: No description available. ,
Other: No description available. ,
Photo and video: No description available. ,
Productivity: No description available. ,
Public service: No description available. ,
Real estate: No description available. ,
Shopping: No description available. ,
Social networking and communications: No description available. ,
Sports: No description available. ,
Tourism: No description available. ,
Utilities: No description available. ,
Trading: No description available. ,
Transportation: No description available. ,
Travel and local: No description available. ,
Water: No description available. ,
Weather: No description available. ,
}
,
Required: True ,
}
enum ,
commercialName:
{
Description: Commercial name of the application. ,
Required: True ,
}
string ,
privacyRightsRequestEmailAddress:
{
Description: Privacy rights request email address. ,
Required: True ,
}
string ,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
}
,
configuredApplicationOwner:
{
Description: Details about the Organization owning the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Common name of the organization owning the application. ,
Required: True ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: True ,
}
string ,
tradingName:
{
Description: Trading name of the organization owning the application. ,
Required: True ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: True ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: True ,
}
string ,
organizationType:
{
Description: The type of organization that the Application Owner is. ,
Enum:
{
Academic scientific organization: No description available. ,
For profit organization: No description available. ,
Governmental organization: No description available. ,
Industry consortium: No description available. ,
International organization: No description available. ,
Non-governmental organization: No description available. ,
Non-profit organization: No description available. ,
Organizational unit: No description available. ,
}
,
Required: True ,
}
enum ,
organizationIdentificationId:
{
Description: ID number for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationIssuer:
{
Description: Issuing organization of the ID for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationType:
{
Description: Type of official identification of the organization. ,
Required: True ,
}
string ,
contactEmailAddress:
{
Description: Email address for the person responsible for the use of Network APIs in this application. ,
Required: True ,
}
string ,
legalRepresentative:
{
Description: Legal representative of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
privacyManager:
{
Description: Privacy manager of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
dataProtectionOfficer:
{
Description: Data Protection Officer of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
registeredGeographicAddress:
{
Description: Registered Geographic address. ,
Required: True ,
}
{
streetNumber:
{
Description: Street Number of the address. ,
Required: False ,
}
string ,
streetName:
{
Description: Street Name of the address. ,
Required: False ,
}
string ,
locality:
{
Description: Locality of the address. ,
Required: False ,
}
string ,
city:
{
Description: City of the address. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: State or province of the address. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code of the address. ,
Required: False ,
}
string ,
countryCode:
{
Description: Country code of the address. ,
Required: True ,
}
string ,
}
,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
localRepresentatives:
{
Description: List of local representatives. ,
Required: True ,
}
[
{
countryCode:
{
Description: Country code for the country/region the local representative is representing. ,
Required: True ,
}
string ,
representative:
{
Description: Local representative for this country/region. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
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 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 ,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Name of the application. ,
Required: True ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: True ,
}
string ,
category:
{
Description: The category of the application. ,
Enum:
{
Agriculture: No description available. ,
Art and design: No description available. ,
Auto and vehicle: No description available. ,
Beauty: No description available. ,
Books and reference: No description available. ,
Business: No description available. ,
Construction: No description available. ,
Defense: No description available. ,
Developer tools: No description available. ,
Education: No description available. ,
Engineering: No description available. ,
Events and entertainment: No description available. ,
Finance: No description available. ,
Food and drink: No description available. ,
Games: No description available. ,
Health and fitness: No description available. ,
Healthcare: No description available. ,
Information: No description available. ,
Kids: No description available. ,
Libraries and demo: No description available. ,
Lifestyle: No description available. ,
Manufacturing: No description available. ,
Maps and navigation: No description available. ,
Media: No description available. ,
Medical: No description available. ,
Mining: No description available. ,
Music and audio: No description available. ,
News and magazines: No description available. ,
Organizations: No description available. ,
Other: No description available. ,
Photo and video: No description available. ,
Productivity: No description available. ,
Public service: No description available. ,
Real estate: No description available. ,
Shopping: No description available. ,
Social networking and communications: No description available. ,
Sports: No description available. ,
Tourism: No description available. ,
Utilities: No description available. ,
Trading: No description available. ,
Transportation: No description available. ,
Travel and local: No description available. ,
Water: No description available. ,
Weather: No description available. ,
}
,
Required: True ,
}
enum ,
commercialName:
{
Description: Commercial name of the application. ,
Required: True ,
}
string ,
privacyRightsRequestEmailAddress:
{
Description: Privacy rights request email address. ,
Required: True ,
}
string ,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
}
,
configuredApplicationOwner:
{
Description: Details about the Organization owning the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Common name of the organization owning the application. ,
Required: True ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: True ,
}
string ,
tradingName:
{
Description: Trading name of the organization owning the application. ,
Required: True ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: True ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: True ,
}
string ,
organizationType:
{
Description: The type of organization that the Application Owner is. ,
Enum:
{
Academic scientific organization: No description available. ,
For profit organization: No description available. ,
Governmental organization: No description available. ,
Industry consortium: No description available. ,
International organization: No description available. ,
Non-governmental organization: No description available. ,
Non-profit organization: No description available. ,
Organizational unit: No description available. ,
}
,
Required: True ,
}
enum ,
organizationIdentificationId:
{
Description: ID number for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationIssuer:
{
Description: Issuing organization of the ID for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationType:
{
Description: Type of official identification of the organization. ,
Required: True ,
}
string ,
contactEmailAddress:
{
Description: Email address for the person responsible for the use of Network APIs in this application. ,
Required: True ,
}
string ,
legalRepresentative:
{
Description: Legal representative of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
privacyManager:
{
Description: Privacy manager of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
dataProtectionOfficer:
{
Description: Data Protection Officer of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
registeredGeographicAddress:
{
Description: Registered Geographic address. ,
Required: True ,
}
{
streetNumber:
{
Description: Street Number of the address. ,
Required: False ,
}
string ,
streetName:
{
Description: Street Name of the address. ,
Required: False ,
}
string ,
locality:
{
Description: Locality of the address. ,
Required: False ,
}
string ,
city:
{
Description: City of the address. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: State or province of the address. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code of the address. ,
Required: False ,
}
string ,
countryCode:
{
Description: Country code of the address. ,
Required: True ,
}
string ,
}
,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
localRepresentatives:
{
Description: List of local representatives. ,
Required: True ,
}
[
{
countryCode:
{
Description: Country code for the country/region the local representative is representing. ,
Required: True ,
}
string ,
representative:
{
Description: Local representative for this country/region. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
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_Update (new)
Description :  Update Gateway tags.
Reference :  Link ¶

⚼ 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 ,
configuredApplication:
{
Description: Details about the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Name of the application. ,
Required: True ,
}
string ,
applicationDescription:
{
Description: Description of the application. ,
Required: True ,
}
string ,
category:
{
Description: The category of the application. ,
Enum:
{
Agriculture: No description available. ,
Art and design: No description available. ,
Auto and vehicle: No description available. ,
Beauty: No description available. ,
Books and reference: No description available. ,
Business: No description available. ,
Construction: No description available. ,
Defense: No description available. ,
Developer tools: No description available. ,
Education: No description available. ,
Engineering: No description available. ,
Events and entertainment: No description available. ,
Finance: No description available. ,
Food and drink: No description available. ,
Games: No description available. ,
Health and fitness: No description available. ,
Healthcare: No description available. ,
Information: No description available. ,
Kids: No description available. ,
Libraries and demo: No description available. ,
Lifestyle: No description available. ,
Manufacturing: No description available. ,
Maps and navigation: No description available. ,
Media: No description available. ,
Medical: No description available. ,
Mining: No description available. ,
Music and audio: No description available. ,
News and magazines: No description available. ,
Organizations: No description available. ,
Other: No description available. ,
Photo and video: No description available. ,
Productivity: No description available. ,
Public service: No description available. ,
Real estate: No description available. ,
Shopping: No description available. ,
Social networking and communications: No description available. ,
Sports: No description available. ,
Tourism: No description available. ,
Utilities: No description available. ,
Trading: No description available. ,
Transportation: No description available. ,
Travel and local: No description available. ,
Water: No description available. ,
Weather: No description available. ,
}
,
Required: True ,
}
enum ,
commercialName:
{
Description: Commercial name of the application. ,
Required: True ,
}
string ,
privacyRightsRequestEmailAddress:
{
Description: Privacy rights request email address. ,
Required: True ,
}
string ,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
}
,
configuredApplicationOwner:
{
Description: Details about the Organization owning the Application that would use the Operator's Network APIs. ,
Required: True ,
}
{
name:
{
Description: Common name of the organization owning the application. ,
Required: True ,
}
string ,
legalName:
{
Description: Legal name of the organization owning the application. ,
Required: True ,
}
string ,
tradingName:
{
Description: Trading name of the organization owning the application. ,
Required: True ,
}
string ,
organizationDescription:
{
Description: A description of the organization owning the application. ,
Required: True ,
}
string ,
taxNumber:
{
Description: Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. ,
Required: True ,
}
string ,
organizationType:
{
Description: The type of organization that the Application Owner is. ,
Enum:
{
Academic scientific organization: No description available. ,
For profit organization: No description available. ,
Governmental organization: No description available. ,
Industry consortium: No description available. ,
International organization: No description available. ,
Non-governmental organization: No description available. ,
Non-profit organization: No description available. ,
Organizational unit: No description available. ,
}
,
Required: True ,
}
enum ,
organizationIdentificationId:
{
Description: ID number for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationIssuer:
{
Description: Issuing organization of the ID for official identification of the organization. ,
Required: True ,
}
string ,
organizationIdentificationType:
{
Description: Type of official identification of the organization. ,
Required: True ,
}
string ,
contactEmailAddress:
{
Description: Email address for the person responsible for the use of Network APIs in this application. ,
Required: True ,
}
string ,
legalRepresentative:
{
Description: Legal representative of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
privacyManager:
{
Description: Privacy manager of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
dataProtectionOfficer:
{
Description: Data Protection Officer of the organization. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
string ,
}
,
registeredGeographicAddress:
{
Description: Registered Geographic address. ,
Required: True ,
}
{
streetNumber:
{
Description: Street Number of the address. ,
Required: False ,
}
string ,
streetName:
{
Description: Street Name of the address. ,
Required: False ,
}
string ,
locality:
{
Description: Locality of the address. ,
Required: False ,
}
string ,
city:
{
Description: City of the address. ,
Required: False ,
}
string ,
stateOrProvince:
{
Description: State or province of the address. ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal code of the address. ,
Required: False ,
}
string ,
countryCode:
{
Description: Country code of the address. ,
Required: True ,
}
string ,
}
,
privacyPolicyUrl:
{
Description: URL for the organization's privacy policy. ,
Format: uri ,
Required: True ,
}
string ,
localRepresentatives:
{
Description: List of local representatives. ,
Required: True ,
}
[
{
countryCode:
{
Description: Country code for the country/region the local representative is representing. ,
Required: True ,
}
string ,
representative:
{
Description: Local representative for this country/region. ,
Required: True ,
}
{
familyName:
{
Description: Family name of the contactable person. ,
Required: True ,
}
string ,
givenName:
{
Description: Given name of the contactable person. ,
Required: True ,
}
string ,
emailAddress:
{
Description: Email address of the contactable person. ,
Required: True ,
}
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_Delete (new)
Description :  Delete a Gateway.
Reference :  Link ¶

⚼ 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 (new)
Description :  List OperatorApiConnection resources by resource group.
Reference :  Link ¶

⚼ 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 ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
,
planTermsAndConditionsAccepted:
{
Description: Whether the caller has accepted the Terms and Conditions of the associated Operator API Plan. After creation, the planTermsAndConditionsLink property is set to the Terms and Conditions that have been accepted. Must be set to True, as the Terms and Conditions must be accepted. ,
Required: True ,
}
boolean ,
planTermsAndConditionsLinks:
{
Description: Links to the Terms and Conditions of the Operator API Plan that were accepted on creation. ,
Required: False ,
}
[
string ,
]
,
purposes:
{
Description: The purpose for which the Application will use the API. Max Items 1 currently as Operators do not support multiple. ,
Required: True ,
}
[
string ,
]
,
purposeReason:
{
Description: Explanation of the reason that justifies the purpose: specifically why is the API used for the application's use case. ,
Required: True ,
}
string ,
dataProcessingList:
{
Description: List of ways the data returned on this API is processed. ,
Required: True ,
}
[
{
processingOperation:
{
Description: The operation that is performed on the data received. ,
Enum:
{
Access: No description available. ,
Acquire: No description available. ,
Adapt: No description available. ,
Aggregate: No description available. ,
Align: No description available. ,
Alter: No description available. ,
Analyze: No description available. ,
Anonymize: No description available. ,
Assess: No description available. ,
Collect: No description available. ,
Combine: No description available. ,
Consult: No description available. ,
Copy: No description available. ,
Cross border transfer: No description available. ,
Delete: No description available. ,
Derive: No description available. ,
Destruct: No description available. ,
Disclose: No description available. ,
Disclose by transmission: No description available. ,
Display: No description available. ,
Disseminate: No description available. ,
Download: No description available. ,
Erase: No description available. ,
Export: No description available. ,
Filter: No description available. ,
Format: No description available. ,
Generate: No description available. ,
Infer: No description available. ,
Make available: No description available. ,
Match: No description available. ,
Modify: No description available. ,
Monitor: No description available. ,
Move: No description available. ,
Observe: No description available. ,
Obtain: No description available. ,
Organize: No description available. ,
Profiling: No description available. ,
Pseudonymize: No description available. ,
Query: No description available. ,
Record: No description available. ,
Reformat: No description available. ,
Remove: No description available. ,
Restrict: No description available. ,
Retrieve: No description available. ,
Screen: No description available. ,
Share: No description available. ,
Store: No description available. ,
Structure: No description available. ,
Transfer: No description available. ,
Transform: No description available. ,
Transmit: No description available. ,
Use: No description available. ,
}
,
Required: True ,
}
enum ,
contexts:
{
Description: The contexts in which the data is processed. ,
Required: True ,
}
[
string ,
]
,
duration:
{
Description: The duration or temporal limitation of the data processing. ,
Enum:
{
Endless: No description available. ,
Fixed occurrences: No description available. ,
Indeterminate: No description available. ,
Temporal: No description available. ,
Until event: No description available. ,
Until time: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of the data processing. ,
Enum:
{
Continuous: No description available. ,
Often: No description available. ,
Singular: No description available. ,
Sporadic: No description available. ,
}
,
Required: True ,
}
enum ,
transitRegions:
{
Description: The countries/regions the data transits through. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
storageRegions:
{
Description: The countries/regions the data is stored in. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
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 (new)
Description :  Get an Operator API Connection.
Reference :  Link ¶

⚼ 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 ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
,
planTermsAndConditionsAccepted:
{
Description: Whether the caller has accepted the Terms and Conditions of the associated Operator API Plan. After creation, the planTermsAndConditionsLink property is set to the Terms and Conditions that have been accepted. Must be set to True, as the Terms and Conditions must be accepted. ,
Required: True ,
}
boolean ,
planTermsAndConditionsLinks:
{
Description: Links to the Terms and Conditions of the Operator API Plan that were accepted on creation. ,
Required: False ,
}
[
string ,
]
,
purposes:
{
Description: The purpose for which the Application will use the API. Max Items 1 currently as Operators do not support multiple. ,
Required: True ,
}
[
string ,
]
,
purposeReason:
{
Description: Explanation of the reason that justifies the purpose: specifically why is the API used for the application's use case. ,
Required: True ,
}
string ,
dataProcessingList:
{
Description: List of ways the data returned on this API is processed. ,
Required: True ,
}
[
{
processingOperation:
{
Description: The operation that is performed on the data received. ,
Enum:
{
Access: No description available. ,
Acquire: No description available. ,
Adapt: No description available. ,
Aggregate: No description available. ,
Align: No description available. ,
Alter: No description available. ,
Analyze: No description available. ,
Anonymize: No description available. ,
Assess: No description available. ,
Collect: No description available. ,
Combine: No description available. ,
Consult: No description available. ,
Copy: No description available. ,
Cross border transfer: No description available. ,
Delete: No description available. ,
Derive: No description available. ,
Destruct: No description available. ,
Disclose: No description available. ,
Disclose by transmission: No description available. ,
Display: No description available. ,
Disseminate: No description available. ,
Download: No description available. ,
Erase: No description available. ,
Export: No description available. ,
Filter: No description available. ,
Format: No description available. ,
Generate: No description available. ,
Infer: No description available. ,
Make available: No description available. ,
Match: No description available. ,
Modify: No description available. ,
Monitor: No description available. ,
Move: No description available. ,
Observe: No description available. ,
Obtain: No description available. ,
Organize: No description available. ,
Profiling: No description available. ,
Pseudonymize: No description available. ,
Query: No description available. ,
Record: No description available. ,
Reformat: No description available. ,
Remove: No description available. ,
Restrict: No description available. ,
Retrieve: No description available. ,
Screen: No description available. ,
Share: No description available. ,
Store: No description available. ,
Structure: No description available. ,
Transfer: No description available. ,
Transform: No description available. ,
Transmit: No description available. ,
Use: No description available. ,
}
,
Required: True ,
}
enum ,
contexts:
{
Description: The contexts in which the data is processed. ,
Required: True ,
}
[
string ,
]
,
duration:
{
Description: The duration or temporal limitation of the data processing. ,
Enum:
{
Endless: No description available. ,
Fixed occurrences: No description available. ,
Indeterminate: No description available. ,
Temporal: No description available. ,
Until event: No description available. ,
Until time: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of the data processing. ,
Enum:
{
Continuous: No description available. ,
Often: No description available. ,
Singular: No description available. ,
Sporadic: No description available. ,
}
,
Required: True ,
}
enum ,
transitRegions:
{
Description: The countries/regions the data transits through. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
storageRegions:
{
Description: The countries/regions the data is stored in. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
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 (new)
Description :  Create an Operator API Connection.
Reference :  Link ¶

⚼ 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 ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
,
planTermsAndConditionsAccepted:
{
Description: Whether the caller has accepted the Terms and Conditions of the associated Operator API Plan. After creation, the planTermsAndConditionsLink property is set to the Terms and Conditions that have been accepted. Must be set to True, as the Terms and Conditions must be accepted. ,
Required: True ,
}
boolean ,
planTermsAndConditionsLinks:
{
Description: Links to the Terms and Conditions of the Operator API Plan that were accepted on creation. ,
Required: False ,
}
[
string ,
]
,
purposes:
{
Description: The purpose for which the Application will use the API. Max Items 1 currently as Operators do not support multiple. ,
Required: True ,
}
[
string ,
]
,
purposeReason:
{
Description: Explanation of the reason that justifies the purpose: specifically why is the API used for the application's use case. ,
Required: True ,
}
string ,
dataProcessingList:
{
Description: List of ways the data returned on this API is processed. ,
Required: True ,
}
[
{
processingOperation:
{
Description: The operation that is performed on the data received. ,
Enum:
{
Access: No description available. ,
Acquire: No description available. ,
Adapt: No description available. ,
Aggregate: No description available. ,
Align: No description available. ,
Alter: No description available. ,
Analyze: No description available. ,
Anonymize: No description available. ,
Assess: No description available. ,
Collect: No description available. ,
Combine: No description available. ,
Consult: No description available. ,
Copy: No description available. ,
Cross border transfer: No description available. ,
Delete: No description available. ,
Derive: No description available. ,
Destruct: No description available. ,
Disclose: No description available. ,
Disclose by transmission: No description available. ,
Display: No description available. ,
Disseminate: No description available. ,
Download: No description available. ,
Erase: No description available. ,
Export: No description available. ,
Filter: No description available. ,
Format: No description available. ,
Generate: No description available. ,
Infer: No description available. ,
Make available: No description available. ,
Match: No description available. ,
Modify: No description available. ,
Monitor: No description available. ,
Move: No description available. ,
Observe: No description available. ,
Obtain: No description available. ,
Organize: No description available. ,
Profiling: No description available. ,
Pseudonymize: No description available. ,
Query: No description available. ,
Record: No description available. ,
Reformat: No description available. ,
Remove: No description available. ,
Restrict: No description available. ,
Retrieve: No description available. ,
Screen: No description available. ,
Share: No description available. ,
Store: No description available. ,
Structure: No description available. ,
Transfer: No description available. ,
Transform: No description available. ,
Transmit: No description available. ,
Use: No description available. ,
}
,
Required: True ,
}
enum ,
contexts:
{
Description: The contexts in which the data is processed. ,
Required: True ,
}
[
string ,
]
,
duration:
{
Description: The duration or temporal limitation of the data processing. ,
Enum:
{
Endless: No description available. ,
Fixed occurrences: No description available. ,
Indeterminate: No description available. ,
Temporal: No description available. ,
Until event: No description available. ,
Until time: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of the data processing. ,
Enum:
{
Continuous: No description available. ,
Often: No description available. ,
Singular: No description available. ,
Sporadic: No description available. ,
}
,
Required: True ,
}
enum ,
transitRegions:
{
Description: The countries/regions the data transits through. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
storageRegions:
{
Description: The countries/regions the data is stored in. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
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 ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
,
planTermsAndConditionsAccepted:
{
Description: Whether the caller has accepted the Terms and Conditions of the associated Operator API Plan. After creation, the planTermsAndConditionsLink property is set to the Terms and Conditions that have been accepted. Must be set to True, as the Terms and Conditions must be accepted. ,
Required: True ,
}
boolean ,
planTermsAndConditionsLinks:
{
Description: Links to the Terms and Conditions of the Operator API Plan that were accepted on creation. ,
Required: False ,
}
[
string ,
]
,
purposes:
{
Description: The purpose for which the Application will use the API. Max Items 1 currently as Operators do not support multiple. ,
Required: True ,
}
[
string ,
]
,
purposeReason:
{
Description: Explanation of the reason that justifies the purpose: specifically why is the API used for the application's use case. ,
Required: True ,
}
string ,
dataProcessingList:
{
Description: List of ways the data returned on this API is processed. ,
Required: True ,
}
[
{
processingOperation:
{
Description: The operation that is performed on the data received. ,
Enum:
{
Access: No description available. ,
Acquire: No description available. ,
Adapt: No description available. ,
Aggregate: No description available. ,
Align: No description available. ,
Alter: No description available. ,
Analyze: No description available. ,
Anonymize: No description available. ,
Assess: No description available. ,
Collect: No description available. ,
Combine: No description available. ,
Consult: No description available. ,
Copy: No description available. ,
Cross border transfer: No description available. ,
Delete: No description available. ,
Derive: No description available. ,
Destruct: No description available. ,
Disclose: No description available. ,
Disclose by transmission: No description available. ,
Display: No description available. ,
Disseminate: No description available. ,
Download: No description available. ,
Erase: No description available. ,
Export: No description available. ,
Filter: No description available. ,
Format: No description available. ,
Generate: No description available. ,
Infer: No description available. ,
Make available: No description available. ,
Match: No description available. ,
Modify: No description available. ,
Monitor: No description available. ,
Move: No description available. ,
Observe: No description available. ,
Obtain: No description available. ,
Organize: No description available. ,
Profiling: No description available. ,
Pseudonymize: No description available. ,
Query: No description available. ,
Record: No description available. ,
Reformat: No description available. ,
Remove: No description available. ,
Restrict: No description available. ,
Retrieve: No description available. ,
Screen: No description available. ,
Share: No description available. ,
Store: No description available. ,
Structure: No description available. ,
Transfer: No description available. ,
Transform: No description available. ,
Transmit: No description available. ,
Use: No description available. ,
}
,
Required: True ,
}
enum ,
contexts:
{
Description: The contexts in which the data is processed. ,
Required: True ,
}
[
string ,
]
,
duration:
{
Description: The duration or temporal limitation of the data processing. ,
Enum:
{
Endless: No description available. ,
Fixed occurrences: No description available. ,
Indeterminate: No description available. ,
Temporal: No description available. ,
Until event: No description available. ,
Until time: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of the data processing. ,
Enum:
{
Continuous: No description available. ,
Often: No description available. ,
Singular: No description available. ,
Sporadic: No description available. ,
}
,
Required: True ,
}
enum ,
transitRegions:
{
Description: The countries/regions the data transits through. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
storageRegions:
{
Description: The countries/regions the data is stored in. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
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 ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
,
planTermsAndConditionsAccepted:
{
Description: Whether the caller has accepted the Terms and Conditions of the associated Operator API Plan. After creation, the planTermsAndConditionsLink property is set to the Terms and Conditions that have been accepted. Must be set to True, as the Terms and Conditions must be accepted. ,
Required: True ,
}
boolean ,
planTermsAndConditionsLinks:
{
Description: Links to the Terms and Conditions of the Operator API Plan that were accepted on creation. ,
Required: False ,
}
[
string ,
]
,
purposes:
{
Description: The purpose for which the Application will use the API. Max Items 1 currently as Operators do not support multiple. ,
Required: True ,
}
[
string ,
]
,
purposeReason:
{
Description: Explanation of the reason that justifies the purpose: specifically why is the API used for the application's use case. ,
Required: True ,
}
string ,
dataProcessingList:
{
Description: List of ways the data returned on this API is processed. ,
Required: True ,
}
[
{
processingOperation:
{
Description: The operation that is performed on the data received. ,
Enum:
{
Access: No description available. ,
Acquire: No description available. ,
Adapt: No description available. ,
Aggregate: No description available. ,
Align: No description available. ,
Alter: No description available. ,
Analyze: No description available. ,
Anonymize: No description available. ,
Assess: No description available. ,
Collect: No description available. ,
Combine: No description available. ,
Consult: No description available. ,
Copy: No description available. ,
Cross border transfer: No description available. ,
Delete: No description available. ,
Derive: No description available. ,
Destruct: No description available. ,
Disclose: No description available. ,
Disclose by transmission: No description available. ,
Display: No description available. ,
Disseminate: No description available. ,
Download: No description available. ,
Erase: No description available. ,
Export: No description available. ,
Filter: No description available. ,
Format: No description available. ,
Generate: No description available. ,
Infer: No description available. ,
Make available: No description available. ,
Match: No description available. ,
Modify: No description available. ,
Monitor: No description available. ,
Move: No description available. ,
Observe: No description available. ,
Obtain: No description available. ,
Organize: No description available. ,
Profiling: No description available. ,
Pseudonymize: No description available. ,
Query: No description available. ,
Record: No description available. ,
Reformat: No description available. ,
Remove: No description available. ,
Restrict: No description available. ,
Retrieve: No description available. ,
Screen: No description available. ,
Share: No description available. ,
Store: No description available. ,
Structure: No description available. ,
Transfer: No description available. ,
Transform: No description available. ,
Transmit: No description available. ,
Use: No description available. ,
}
,
Required: True ,
}
enum ,
contexts:
{
Description: The contexts in which the data is processed. ,
Required: True ,
}
[
string ,
]
,
duration:
{
Description: The duration or temporal limitation of the data processing. ,
Enum:
{
Endless: No description available. ,
Fixed occurrences: No description available. ,
Indeterminate: No description available. ,
Temporal: No description available. ,
Until event: No description available. ,
Until time: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of the data processing. ,
Enum:
{
Continuous: No description available. ,
Often: No description available. ,
Singular: No description available. ,
Sporadic: No description available. ,
}
,
Required: True ,
}
enum ,
transitRegions:
{
Description: The countries/regions the data transits through. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
storageRegions:
{
Description: The countries/regions the data is stored in. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
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 (new)
Description :  Update an Operator API Connection.
Reference :  Link ¶

⚼ 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 ,
planTermsAndConditionsAccepted:
{
Description: Whether the caller has accepted the Terms and Conditions of the associated Operator API Plan. After creation, the planTermsAndConditionsLink property is set to the Terms and Conditions that have been accepted. Must be set to True, as the Terms and Conditions must be accepted. ,
Required: False ,
}
boolean ,
purposes:
{
Description: The purpose for which the Application will use the API. Max Items 1 currently as Operators do not support multiple. ,
Required: False ,
}
[
string ,
]
,
purposeReason:
{
Description: Explanation of the reason that justifies the purpose: specifically why is the API used for the application's use case. ,
Required: False ,
}
string ,
dataProcessingList:
{
Description: List of ways the data returned on this API is processed. ,
Required: False ,
}
[
{
processingOperation:
{
Description: The operation that is performed on the data received. ,
Enum:
{
Access: No description available. ,
Acquire: No description available. ,
Adapt: No description available. ,
Aggregate: No description available. ,
Align: No description available. ,
Alter: No description available. ,
Analyze: No description available. ,
Anonymize: No description available. ,
Assess: No description available. ,
Collect: No description available. ,
Combine: No description available. ,
Consult: No description available. ,
Copy: No description available. ,
Cross border transfer: No description available. ,
Delete: No description available. ,
Derive: No description available. ,
Destruct: No description available. ,
Disclose: No description available. ,
Disclose by transmission: No description available. ,
Display: No description available. ,
Disseminate: No description available. ,
Download: No description available. ,
Erase: No description available. ,
Export: No description available. ,
Filter: No description available. ,
Format: No description available. ,
Generate: No description available. ,
Infer: No description available. ,
Make available: No description available. ,
Match: No description available. ,
Modify: No description available. ,
Monitor: No description available. ,
Move: No description available. ,
Observe: No description available. ,
Obtain: No description available. ,
Organize: No description available. ,
Profiling: No description available. ,
Pseudonymize: No description available. ,
Query: No description available. ,
Record: No description available. ,
Reformat: No description available. ,
Remove: No description available. ,
Restrict: No description available. ,
Retrieve: No description available. ,
Screen: No description available. ,
Share: No description available. ,
Store: No description available. ,
Structure: No description available. ,
Transfer: No description available. ,
Transform: No description available. ,
Transmit: No description available. ,
Use: No description available. ,
}
,
Required: True ,
}
enum ,
contexts:
{
Description: The contexts in which the data is processed. ,
Required: True ,
}
[
string ,
]
,
duration:
{
Description: The duration or temporal limitation of the data processing. ,
Enum:
{
Endless: No description available. ,
Fixed occurrences: No description available. ,
Indeterminate: No description available. ,
Temporal: No description available. ,
Until event: No description available. ,
Until time: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of the data processing. ,
Enum:
{
Continuous: No description available. ,
Often: No description available. ,
Singular: No description available. ,
Sporadic: No description available. ,
}
,
Required: True ,
}
enum ,
transitRegions:
{
Description: The countries/regions the data transits through. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
storageRegions:
{
Description: The countries/regions the data is stored in. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
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 ,
gatewayId:
{
Description: Reference to the APC Gateway resource ID. ,
Format: arm-id ,
Required: True ,
}
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 ,
}
,
planTermsAndConditionsAccepted:
{
Description: Whether the caller has accepted the Terms and Conditions of the associated Operator API Plan. After creation, the planTermsAndConditionsLink property is set to the Terms and Conditions that have been accepted. Must be set to True, as the Terms and Conditions must be accepted. ,
Required: True ,
}
boolean ,
planTermsAndConditionsLinks:
{
Description: Links to the Terms and Conditions of the Operator API Plan that were accepted on creation. ,
Required: False ,
}
[
string ,
]
,
purposes:
{
Description: The purpose for which the Application will use the API. Max Items 1 currently as Operators do not support multiple. ,
Required: True ,
}
[
string ,
]
,
purposeReason:
{
Description: Explanation of the reason that justifies the purpose: specifically why is the API used for the application's use case. ,
Required: True ,
}
string ,
dataProcessingList:
{
Description: List of ways the data returned on this API is processed. ,
Required: True ,
}
[
{
processingOperation:
{
Description: The operation that is performed on the data received. ,
Enum:
{
Access: No description available. ,
Acquire: No description available. ,
Adapt: No description available. ,
Aggregate: No description available. ,
Align: No description available. ,
Alter: No description available. ,
Analyze: No description available. ,
Anonymize: No description available. ,
Assess: No description available. ,
Collect: No description available. ,
Combine: No description available. ,
Consult: No description available. ,
Copy: No description available. ,
Cross border transfer: No description available. ,
Delete: No description available. ,
Derive: No description available. ,
Destruct: No description available. ,
Disclose: No description available. ,
Disclose by transmission: No description available. ,
Display: No description available. ,
Disseminate: No description available. ,
Download: No description available. ,
Erase: No description available. ,
Export: No description available. ,
Filter: No description available. ,
Format: No description available. ,
Generate: No description available. ,
Infer: No description available. ,
Make available: No description available. ,
Match: No description available. ,
Modify: No description available. ,
Monitor: No description available. ,
Move: No description available. ,
Observe: No description available. ,
Obtain: No description available. ,
Organize: No description available. ,
Profiling: No description available. ,
Pseudonymize: No description available. ,
Query: No description available. ,
Record: No description available. ,
Reformat: No description available. ,
Remove: No description available. ,
Restrict: No description available. ,
Retrieve: No description available. ,
Screen: No description available. ,
Share: No description available. ,
Store: No description available. ,
Structure: No description available. ,
Transfer: No description available. ,
Transform: No description available. ,
Transmit: No description available. ,
Use: No description available. ,
}
,
Required: True ,
}
enum ,
contexts:
{
Description: The contexts in which the data is processed. ,
Required: True ,
}
[
string ,
]
,
duration:
{
Description: The duration or temporal limitation of the data processing. ,
Enum:
{
Endless: No description available. ,
Fixed occurrences: No description available. ,
Indeterminate: No description available. ,
Temporal: No description available. ,
Until event: No description available. ,
Until time: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The frequency of the data processing. ,
Enum:
{
Continuous: No description available. ,
Often: No description available. ,
Singular: No description available. ,
Sporadic: No description available. ,
}
,
Required: True ,
}
enum ,
transitRegions:
{
Description: The countries/regions the data transits through. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
storageRegions:
{
Description: The countries/regions the data is stored in. ,
Required: True ,
}
[
{
countryCode:
{
Description: The country code of the country/region the data transits through or is stored in. ,
Required: True ,
}
string ,
commercialOrganization:
{
Description: The commercial organization who is managing the data. ,
Required: False ,
}
string ,
commercialActivity:
{
Description: Flag to indicate if commercial activity applies to this data management. ,
Required: True ,
}
boolean ,
dataPrivacyFrameworkUrl:
{
Description: URL of the organization or governmental data privacy framework. ,
Format: uri ,
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 (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_Delete (new)
Description :  Delete an Operator API Connection.
Reference :  Link ¶

⚼ Request

DELETE:  /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 (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 ,
}
,
]
,
}
,
}