Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. programmableconnectivity
  5. getOperatorApiConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.programmableconnectivity.getOperatorApiConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get an Operator API Connection. Azure REST API version: 2024-01-15-preview.

    Using getOperatorApiConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getOperatorApiConnection(args: GetOperatorApiConnectionArgs, opts?: InvokeOptions): Promise<GetOperatorApiConnectionResult>
function getOperatorApiConnectionOutput(args: GetOperatorApiConnectionOutputArgs, opts?: InvokeOptions): Output<GetOperatorApiConnectionResult>
    def get_operator_api_connection(operator_api_connection_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetOperatorApiConnectionResult
def get_operator_api_connection_output(operator_api_connection_name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetOperatorApiConnectionResult]
    func LookupOperatorApiConnection(ctx *Context, args *LookupOperatorApiConnectionArgs, opts ...InvokeOption) (*LookupOperatorApiConnectionResult, error)
func LookupOperatorApiConnectionOutput(ctx *Context, args *LookupOperatorApiConnectionOutputArgs, opts ...InvokeOption) LookupOperatorApiConnectionResultOutput

    > Note: This function is named LookupOperatorApiConnection in the Go SDK.

    public static class GetOperatorApiConnection 
{
    public static Task<GetOperatorApiConnectionResult> InvokeAsync(GetOperatorApiConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetOperatorApiConnectionResult> Invoke(GetOperatorApiConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOperatorApiConnectionResult> getOperatorApiConnection(GetOperatorApiConnectionArgs args, InvokeOptions options)
public static Output<GetOperatorApiConnectionResult> getOperatorApiConnection(GetOperatorApiConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:programmableconnectivity:getOperatorApiConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    OperatorApiConnectionName string
    Azure Programmable Connectivity (APC) Operator API Connection Name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    OperatorApiConnectionName string
    Azure Programmable Connectivity (APC) Operator API Connection Name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    operatorApiConnectionName String
    Azure Programmable Connectivity (APC) Operator API Connection Name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    operatorApiConnectionName string
    Azure Programmable Connectivity (APC) Operator API Connection Name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    operator_api_connection_name str
    Azure Programmable Connectivity (APC) Operator API Connection Name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    operatorApiConnectionName String
    Azure Programmable Connectivity (APC) Operator API Connection Name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getOperatorApiConnection Result

    The following output properties are available:

    AccountType string
    Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
    CamaraApiName string
    The Network API for the current operator in the country/region provided in the linked Operator API Plan.
    GatewayId string
    Reference to the APC Gateway resource ID.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    OperatorApiPlanId string
    Reference to the Operator API Plan Resource ID.
    OperatorName string
    Name of the Operator in the linked Operator API Plan belongs to.
    ProvisioningState string
    The status of the last operation.
    Status Pulumi.AzureNative.ProgrammableConnectivity.Outputs.StatusResponse
    The status of the OperatorApiConnection resource.
    SystemData Pulumi.AzureNative.ProgrammableConnectivity.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AppId string
    Application ID of the App Developer that is registered with the Operator in a specific country/region.
    ConfiguredApplication Pulumi.AzureNative.ProgrammableConnectivity.Outputs.ApplicationPropertiesResponse
    Details about the Application that would use the Operator's Network APIs.
    SaasProperties Pulumi.AzureNative.ProgrammableConnectivity.Outputs.SaasPropertiesResponse
    Details about the SaaS offer purchased from the marketplace.
    Tags Dictionary<string, string>
    Resource tags.
    AccountType string
    Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
    CamaraApiName string
    The Network API for the current operator in the country/region provided in the linked Operator API Plan.
    GatewayId string
    Reference to the APC Gateway resource ID.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    OperatorApiPlanId string
    Reference to the Operator API Plan Resource ID.
    OperatorName string
    Name of the Operator in the linked Operator API Plan belongs to.
    ProvisioningState string
    The status of the last operation.
    Status StatusResponse
    The status of the OperatorApiConnection resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AppId string
    Application ID of the App Developer that is registered with the Operator in a specific country/region.
    ConfiguredApplication ApplicationPropertiesResponse
    Details about the Application that would use the Operator's Network APIs.
    SaasProperties SaasPropertiesResponse
    Details about the SaaS offer purchased from the marketplace.
    Tags map[string]string
    Resource tags.
    accountType String
    Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
    camaraApiName String
    The Network API for the current operator in the country/region provided in the linked Operator API Plan.
    gatewayId String
    Reference to the APC Gateway resource ID.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    operatorApiPlanId String
    Reference to the Operator API Plan Resource ID.
    operatorName String
    Name of the Operator in the linked Operator API Plan belongs to.
    provisioningState String
    The status of the last operation.
    status StatusResponse
    The status of the OperatorApiConnection resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    appId String
    Application ID of the App Developer that is registered with the Operator in a specific country/region.
    configuredApplication ApplicationPropertiesResponse
    Details about the Application that would use the Operator's Network APIs.
    saasProperties SaasPropertiesResponse
    Details about the SaaS offer purchased from the marketplace.
    tags Map<String,String>
    Resource tags.
    accountType string
    Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
    camaraApiName string
    The Network API for the current operator in the country/region provided in the linked Operator API Plan.
    gatewayId string
    Reference to the APC Gateway resource ID.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    operatorApiPlanId string
    Reference to the Operator API Plan Resource ID.
    operatorName string
    Name of the Operator in the linked Operator API Plan belongs to.
    provisioningState string
    The status of the last operation.
    status StatusResponse
    The status of the OperatorApiConnection resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    appId string
    Application ID of the App Developer that is registered with the Operator in a specific country/region.
    configuredApplication ApplicationPropertiesResponse
    Details about the Application that would use the Operator's Network APIs.
    saasProperties SaasPropertiesResponse
    Details about the SaaS offer purchased from the marketplace.
    tags {[key: string]: string}
    Resource tags.
    account_type str
    Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
    camara_api_name str
    The Network API for the current operator in the country/region provided in the linked Operator API Plan.
    gateway_id str
    Reference to the APC Gateway resource ID.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    operator_api_plan_id str
    Reference to the Operator API Plan Resource ID.
    operator_name str
    Name of the Operator in the linked Operator API Plan belongs to.
    provisioning_state str
    The status of the last operation.
    status StatusResponse
    The status of the OperatorApiConnection resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    app_id str
    Application ID of the App Developer that is registered with the Operator in a specific country/region.
    configured_application ApplicationPropertiesResponse
    Details about the Application that would use the Operator's Network APIs.
    saas_properties SaasPropertiesResponse
    Details about the SaaS offer purchased from the marketplace.
    tags Mapping[str, str]
    Resource tags.
    accountType String
    Type of the account the user has with the Operator's Network API infrastructure. AzureManaged | UserManaged.
    camaraApiName String
    The Network API for the current operator in the country/region provided in the linked Operator API Plan.
    gatewayId String
    Reference to the APC Gateway resource ID.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    operatorApiPlanId String
    Reference to the Operator API Plan Resource ID.
    operatorName String
    Name of the Operator in the linked Operator API Plan belongs to.
    provisioningState String
    The status of the last operation.
    status Property Map
    The status of the OperatorApiConnection resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    appId String
    Application ID of the App Developer that is registered with the Operator in a specific country/region.
    configuredApplication Property Map
    Details about the Application that would use the Operator's Network APIs.
    saasProperties Property Map
    Details about the SaaS offer purchased from the marketplace.
    tags Map<String>
    Resource tags.

    Supporting Types

    ApplicationPropertiesResponse

    ApplicationDescription string
    Description of the application.
    ApplicationType string
    The category that describes the application.
    LegalName string
    Legal name of the organization owning the application.
    Name string
    Name of the application. Example: Contoso App.
    OrganizationDescription string
    A description of the organization owning the application.
    PrivacyContactEmailAddress string
    Email address of the Privacy contact or Data Protection officer of the organization.
    TaxNumber string
    Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
    ApplicationDescription string
    Description of the application.
    ApplicationType string
    The category that describes the application.
    LegalName string
    Legal name of the organization owning the application.
    Name string
    Name of the application. Example: Contoso App.
    OrganizationDescription string
    A description of the organization owning the application.
    PrivacyContactEmailAddress string
    Email address of the Privacy contact or Data Protection officer of the organization.
    TaxNumber string
    Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
    applicationDescription String
    Description of the application.
    applicationType String
    The category that describes the application.
    legalName String
    Legal name of the organization owning the application.
    name String
    Name of the application. Example: Contoso App.
    organizationDescription String
    A description of the organization owning the application.
    privacyContactEmailAddress String
    Email address of the Privacy contact or Data Protection officer of the organization.
    taxNumber String
    Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
    applicationDescription string
    Description of the application.
    applicationType string
    The category that describes the application.
    legalName string
    Legal name of the organization owning the application.
    name string
    Name of the application. Example: Contoso App.
    organizationDescription string
    A description of the organization owning the application.
    privacyContactEmailAddress string
    Email address of the Privacy contact or Data Protection officer of the organization.
    taxNumber string
    Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
    application_description str
    Description of the application.
    application_type str
    The category that describes the application.
    legal_name str
    Legal name of the organization owning the application.
    name str
    Name of the application. Example: Contoso App.
    organization_description str
    A description of the organization owning the application.
    privacy_contact_email_address str
    Email address of the Privacy contact or Data Protection officer of the organization.
    tax_number str
    Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.
    applicationDescription String
    Description of the application.
    applicationType String
    The category that describes the application.
    legalName String
    Legal name of the organization owning the application.
    name String
    Name of the application. Example: Contoso App.
    organizationDescription String
    A description of the organization owning the application.
    privacyContactEmailAddress String
    Email address of the Privacy contact or Data Protection officer of the organization.
    taxNumber String
    Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased.

    SaasPropertiesResponse

    SaasResourceId string
    Resource ID of the SaaS offer purchased from the marketplace.
    SaasSubscriptionId string
    Subscription ID of the SaaS offer purchased from the marketplace.
    SaasResourceId string
    Resource ID of the SaaS offer purchased from the marketplace.
    SaasSubscriptionId string
    Subscription ID of the SaaS offer purchased from the marketplace.
    saasResourceId String
    Resource ID of the SaaS offer purchased from the marketplace.
    saasSubscriptionId String
    Subscription ID of the SaaS offer purchased from the marketplace.
    saasResourceId string
    Resource ID of the SaaS offer purchased from the marketplace.
    saasSubscriptionId string
    Subscription ID of the SaaS offer purchased from the marketplace.
    saas_resource_id str
    Resource ID of the SaaS offer purchased from the marketplace.
    saas_subscription_id str
    Subscription ID of the SaaS offer purchased from the marketplace.
    saasResourceId String
    Resource ID of the SaaS offer purchased from the marketplace.
    saasSubscriptionId String
    Subscription ID of the SaaS offer purchased from the marketplace.

    StatusResponse

    Reason string
    Explanation of the current state of the OperatorApiConnection resource.
    State string
    Current state of the OperatorApiConnection resource.
    Reason string
    Explanation of the current state of the OperatorApiConnection resource.
    State string
    Current state of the OperatorApiConnection resource.
    reason String
    Explanation of the current state of the OperatorApiConnection resource.
    state String
    Current state of the OperatorApiConnection resource.
    reason string
    Explanation of the current state of the OperatorApiConnection resource.
    state string
    Current state of the OperatorApiConnection resource.
    reason str
    Explanation of the current state of the OperatorApiConnection resource.
    state str
    Current state of the OperatorApiConnection resource.
    reason String
    Explanation of the current state of the OperatorApiConnection resource.
    state String
    Current state of the OperatorApiConnection resource.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-azure-native