1. Packages
  2. Azure Native
  3. API Docs
  4. security
  5. getConnector
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.security.getConnector

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Details of a specific cloud account connector Azure REST API version: 2020-01-01-preview.

    Using getConnector

    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 getConnector(args: GetConnectorArgs, opts?: InvokeOptions): Promise<GetConnectorResult>
    function getConnectorOutput(args: GetConnectorOutputArgs, opts?: InvokeOptions): Output<GetConnectorResult>
    def get_connector(connector_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetConnectorResult
    def get_connector_output(connector_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetConnectorResult]
    func LookupConnector(ctx *Context, args *LookupConnectorArgs, opts ...InvokeOption) (*LookupConnectorResult, error)
    func LookupConnectorOutput(ctx *Context, args *LookupConnectorOutputArgs, opts ...InvokeOption) LookupConnectorResultOutput

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

    public static class GetConnector 
    {
        public static Task<GetConnectorResult> InvokeAsync(GetConnectorArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectorResult> Invoke(GetConnectorInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:security:getConnector
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConnectorName string
    Name of the cloud account connector
    ConnectorName string
    Name of the cloud account connector
    connectorName String
    Name of the cloud account connector
    connectorName string
    Name of the cloud account connector
    connector_name str
    Name of the cloud account connector
    connectorName String
    Name of the cloud account connector

    getConnector Result

    The following output properties are available:

    Id string
    Resource Id
    Name string
    Resource name
    Type string
    Resource type
    AuthenticationDetails Pulumi.AzureNative.Security.Outputs.AwAssumeRoleAuthenticationDetailsPropertiesResponse | Pulumi.AzureNative.Security.Outputs.AwsCredsAuthenticationDetailsPropertiesResponse | Pulumi.AzureNative.Security.Outputs.GcpCredentialsDetailsPropertiesResponse
    Settings for authentication management, these settings are relevant only for the cloud connector.
    HybridComputeSettings Pulumi.AzureNative.Security.Outputs.HybridComputeSettingsPropertiesResponse
    Settings for hybrid compute management. These settings are relevant only for Arc autoProvision (Hybrid Compute).
    Id string
    Resource Id
    Name string
    Resource name
    Type string
    Resource type
    AuthenticationDetails AwAssumeRoleAuthenticationDetailsPropertiesResponse | AwsCredsAuthenticationDetailsPropertiesResponse | GcpCredentialsDetailsPropertiesResponse
    Settings for authentication management, these settings are relevant only for the cloud connector.
    HybridComputeSettings HybridComputeSettingsPropertiesResponse
    Settings for hybrid compute management. These settings are relevant only for Arc autoProvision (Hybrid Compute).
    id String
    Resource Id
    name String
    Resource name
    type String
    Resource type
    authenticationDetails AwAssumeRoleAuthenticationDetailsPropertiesResponse | AwsCredsAuthenticationDetailsPropertiesResponse | GcpCredentialsDetailsPropertiesResponse
    Settings for authentication management, these settings are relevant only for the cloud connector.
    hybridComputeSettings HybridComputeSettingsPropertiesResponse
    Settings for hybrid compute management. These settings are relevant only for Arc autoProvision (Hybrid Compute).
    id string
    Resource Id
    name string
    Resource name
    type string
    Resource type
    authenticationDetails AwAssumeRoleAuthenticationDetailsPropertiesResponse | AwsCredsAuthenticationDetailsPropertiesResponse | GcpCredentialsDetailsPropertiesResponse
    Settings for authentication management, these settings are relevant only for the cloud connector.
    hybridComputeSettings HybridComputeSettingsPropertiesResponse
    Settings for hybrid compute management. These settings are relevant only for Arc autoProvision (Hybrid Compute).
    id str
    Resource Id
    name str
    Resource name
    type str
    Resource type
    authentication_details AwAssumeRoleAuthenticationDetailsPropertiesResponse | AwsCredsAuthenticationDetailsPropertiesResponse | GcpCredentialsDetailsPropertiesResponse
    Settings for authentication management, these settings are relevant only for the cloud connector.
    hybrid_compute_settings HybridComputeSettingsPropertiesResponse
    Settings for hybrid compute management. These settings are relevant only for Arc autoProvision (Hybrid Compute).
    id String
    Resource Id
    name String
    Resource name
    type String
    Resource type
    authenticationDetails Property Map | Property Map | Property Map
    Settings for authentication management, these settings are relevant only for the cloud connector.
    hybridComputeSettings Property Map
    Settings for hybrid compute management. These settings are relevant only for Arc autoProvision (Hybrid Compute).

    Supporting Types

    AwAssumeRoleAuthenticationDetailsPropertiesResponse

    AccountId string
    The ID of the cloud account
    AuthenticationProvisioningState string
    State of the multi-cloud connector
    AwsAssumeRoleArn string
    Assumed role ID is an identifier that you can use to create temporary security credentials.
    AwsExternalId string
    A unique identifier that is required when you assume a role in another account.
    GrantedPermissions List<string>
    The permissions detected in the cloud account.
    AccountId string
    The ID of the cloud account
    AuthenticationProvisioningState string
    State of the multi-cloud connector
    AwsAssumeRoleArn string
    Assumed role ID is an identifier that you can use to create temporary security credentials.
    AwsExternalId string
    A unique identifier that is required when you assume a role in another account.
    GrantedPermissions []string
    The permissions detected in the cloud account.
    accountId String
    The ID of the cloud account
    authenticationProvisioningState String
    State of the multi-cloud connector
    awsAssumeRoleArn String
    Assumed role ID is an identifier that you can use to create temporary security credentials.
    awsExternalId String
    A unique identifier that is required when you assume a role in another account.
    grantedPermissions List<String>
    The permissions detected in the cloud account.
    accountId string
    The ID of the cloud account
    authenticationProvisioningState string
    State of the multi-cloud connector
    awsAssumeRoleArn string
    Assumed role ID is an identifier that you can use to create temporary security credentials.
    awsExternalId string
    A unique identifier that is required when you assume a role in another account.
    grantedPermissions string[]
    The permissions detected in the cloud account.
    account_id str
    The ID of the cloud account
    authentication_provisioning_state str
    State of the multi-cloud connector
    aws_assume_role_arn str
    Assumed role ID is an identifier that you can use to create temporary security credentials.
    aws_external_id str
    A unique identifier that is required when you assume a role in another account.
    granted_permissions Sequence[str]
    The permissions detected in the cloud account.
    accountId String
    The ID of the cloud account
    authenticationProvisioningState String
    State of the multi-cloud connector
    awsAssumeRoleArn String
    Assumed role ID is an identifier that you can use to create temporary security credentials.
    awsExternalId String
    A unique identifier that is required when you assume a role in another account.
    grantedPermissions List<String>
    The permissions detected in the cloud account.

    AwsCredsAuthenticationDetailsPropertiesResponse

    AccountId string
    The ID of the cloud account
    AuthenticationProvisioningState string
    State of the multi-cloud connector
    AwsAccessKeyId string
    Public key element of the AWS credential object (write only)
    AwsSecretAccessKey string
    Secret key element of the AWS credential object (write only)
    GrantedPermissions List<string>
    The permissions detected in the cloud account.
    AccountId string
    The ID of the cloud account
    AuthenticationProvisioningState string
    State of the multi-cloud connector
    AwsAccessKeyId string
    Public key element of the AWS credential object (write only)
    AwsSecretAccessKey string
    Secret key element of the AWS credential object (write only)
    GrantedPermissions []string
    The permissions detected in the cloud account.
    accountId String
    The ID of the cloud account
    authenticationProvisioningState String
    State of the multi-cloud connector
    awsAccessKeyId String
    Public key element of the AWS credential object (write only)
    awsSecretAccessKey String
    Secret key element of the AWS credential object (write only)
    grantedPermissions List<String>
    The permissions detected in the cloud account.
    accountId string
    The ID of the cloud account
    authenticationProvisioningState string
    State of the multi-cloud connector
    awsAccessKeyId string
    Public key element of the AWS credential object (write only)
    awsSecretAccessKey string
    Secret key element of the AWS credential object (write only)
    grantedPermissions string[]
    The permissions detected in the cloud account.
    account_id str
    The ID of the cloud account
    authentication_provisioning_state str
    State of the multi-cloud connector
    aws_access_key_id str
    Public key element of the AWS credential object (write only)
    aws_secret_access_key str
    Secret key element of the AWS credential object (write only)
    granted_permissions Sequence[str]
    The permissions detected in the cloud account.
    accountId String
    The ID of the cloud account
    authenticationProvisioningState String
    State of the multi-cloud connector
    awsAccessKeyId String
    Public key element of the AWS credential object (write only)
    awsSecretAccessKey String
    Secret key element of the AWS credential object (write only)
    grantedPermissions List<String>
    The permissions detected in the cloud account.

    GcpCredentialsDetailsPropertiesResponse

    AuthProviderX509CertUrl string
    Auth provider x509 certificate URL field of the API key (write only)
    AuthUri string
    Auth URI field of the API key (write only)
    AuthenticationProvisioningState string
    State of the multi-cloud connector
    ClientEmail string
    Client email field of the API key (write only)
    ClientId string
    Client ID field of the API key (write only)
    ClientX509CertUrl string
    Client x509 certificate URL field of the API key (write only)
    GrantedPermissions List<string>
    The permissions detected in the cloud account.
    OrganizationId string
    The organization ID of the GCP cloud account
    PrivateKey string
    Private key field of the API key (write only)
    PrivateKeyId string
    Private key ID field of the API key (write only)
    ProjectId string
    Project ID field of the API key (write only)
    TokenUri string
    Token URI field of the API key (write only)
    Type string
    Type field of the API key (write only)
    AuthProviderX509CertUrl string
    Auth provider x509 certificate URL field of the API key (write only)
    AuthUri string
    Auth URI field of the API key (write only)
    AuthenticationProvisioningState string
    State of the multi-cloud connector
    ClientEmail string
    Client email field of the API key (write only)
    ClientId string
    Client ID field of the API key (write only)
    ClientX509CertUrl string
    Client x509 certificate URL field of the API key (write only)
    GrantedPermissions []string
    The permissions detected in the cloud account.
    OrganizationId string
    The organization ID of the GCP cloud account
    PrivateKey string
    Private key field of the API key (write only)
    PrivateKeyId string
    Private key ID field of the API key (write only)
    ProjectId string
    Project ID field of the API key (write only)
    TokenUri string
    Token URI field of the API key (write only)
    Type string
    Type field of the API key (write only)
    authProviderX509CertUrl String
    Auth provider x509 certificate URL field of the API key (write only)
    authUri String
    Auth URI field of the API key (write only)
    authenticationProvisioningState String
    State of the multi-cloud connector
    clientEmail String
    Client email field of the API key (write only)
    clientId String
    Client ID field of the API key (write only)
    clientX509CertUrl String
    Client x509 certificate URL field of the API key (write only)
    grantedPermissions List<String>
    The permissions detected in the cloud account.
    organizationId String
    The organization ID of the GCP cloud account
    privateKey String
    Private key field of the API key (write only)
    privateKeyId String
    Private key ID field of the API key (write only)
    projectId String
    Project ID field of the API key (write only)
    tokenUri String
    Token URI field of the API key (write only)
    type String
    Type field of the API key (write only)
    authProviderX509CertUrl string
    Auth provider x509 certificate URL field of the API key (write only)
    authUri string
    Auth URI field of the API key (write only)
    authenticationProvisioningState string
    State of the multi-cloud connector
    clientEmail string
    Client email field of the API key (write only)
    clientId string
    Client ID field of the API key (write only)
    clientX509CertUrl string
    Client x509 certificate URL field of the API key (write only)
    grantedPermissions string[]
    The permissions detected in the cloud account.
    organizationId string
    The organization ID of the GCP cloud account
    privateKey string
    Private key field of the API key (write only)
    privateKeyId string
    Private key ID field of the API key (write only)
    projectId string
    Project ID field of the API key (write only)
    tokenUri string
    Token URI field of the API key (write only)
    type string
    Type field of the API key (write only)
    auth_provider_x509_cert_url str
    Auth provider x509 certificate URL field of the API key (write only)
    auth_uri str
    Auth URI field of the API key (write only)
    authentication_provisioning_state str
    State of the multi-cloud connector
    client_email str
    Client email field of the API key (write only)
    client_id str
    Client ID field of the API key (write only)
    client_x509_cert_url str
    Client x509 certificate URL field of the API key (write only)
    granted_permissions Sequence[str]
    The permissions detected in the cloud account.
    organization_id str
    The organization ID of the GCP cloud account
    private_key str
    Private key field of the API key (write only)
    private_key_id str
    Private key ID field of the API key (write only)
    project_id str
    Project ID field of the API key (write only)
    token_uri str
    Token URI field of the API key (write only)
    type str
    Type field of the API key (write only)
    authProviderX509CertUrl String
    Auth provider x509 certificate URL field of the API key (write only)
    authUri String
    Auth URI field of the API key (write only)
    authenticationProvisioningState String
    State of the multi-cloud connector
    clientEmail String
    Client email field of the API key (write only)
    clientId String
    Client ID field of the API key (write only)
    clientX509CertUrl String
    Client x509 certificate URL field of the API key (write only)
    grantedPermissions List<String>
    The permissions detected in the cloud account.
    organizationId String
    The organization ID of the GCP cloud account
    privateKey String
    Private key field of the API key (write only)
    privateKeyId String
    Private key ID field of the API key (write only)
    projectId String
    Project ID field of the API key (write only)
    tokenUri String
    Token URI field of the API key (write only)
    type String
    Type field of the API key (write only)

    HybridComputeSettingsPropertiesResponse

    AutoProvision string
    Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
    HybridComputeProvisioningState string
    State of the service principal and its secret
    ProxyServer Pulumi.AzureNative.Security.Inputs.ProxyServerPropertiesResponse
    For a non-Azure machine that is not connected directly to the internet, specify a proxy server that the non-Azure machine can use.
    Region string
    The location where the metadata of machines will be stored
    ResourceGroupName string
    The name of the resource group where Arc (Hybrid Compute) connectors are connected.
    ServicePrincipal Pulumi.AzureNative.Security.Inputs.ServicePrincipalPropertiesResponse
    An object to access resources that are secured by an Azure AD tenant.
    AutoProvision string
    Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
    HybridComputeProvisioningState string
    State of the service principal and its secret
    ProxyServer ProxyServerPropertiesResponse
    For a non-Azure machine that is not connected directly to the internet, specify a proxy server that the non-Azure machine can use.
    Region string
    The location where the metadata of machines will be stored
    ResourceGroupName string
    The name of the resource group where Arc (Hybrid Compute) connectors are connected.
    ServicePrincipal ServicePrincipalPropertiesResponse
    An object to access resources that are secured by an Azure AD tenant.
    autoProvision String
    Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
    hybridComputeProvisioningState String
    State of the service principal and its secret
    proxyServer ProxyServerPropertiesResponse
    For a non-Azure machine that is not connected directly to the internet, specify a proxy server that the non-Azure machine can use.
    region String
    The location where the metadata of machines will be stored
    resourceGroupName String
    The name of the resource group where Arc (Hybrid Compute) connectors are connected.
    servicePrincipal ServicePrincipalPropertiesResponse
    An object to access resources that are secured by an Azure AD tenant.
    autoProvision string
    Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
    hybridComputeProvisioningState string
    State of the service principal and its secret
    proxyServer ProxyServerPropertiesResponse
    For a non-Azure machine that is not connected directly to the internet, specify a proxy server that the non-Azure machine can use.
    region string
    The location where the metadata of machines will be stored
    resourceGroupName string
    The name of the resource group where Arc (Hybrid Compute) connectors are connected.
    servicePrincipal ServicePrincipalPropertiesResponse
    An object to access resources that are secured by an Azure AD tenant.
    auto_provision str
    Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
    hybrid_compute_provisioning_state str
    State of the service principal and its secret
    proxy_server ProxyServerPropertiesResponse
    For a non-Azure machine that is not connected directly to the internet, specify a proxy server that the non-Azure machine can use.
    region str
    The location where the metadata of machines will be stored
    resource_group_name str
    The name of the resource group where Arc (Hybrid Compute) connectors are connected.
    service_principal ServicePrincipalPropertiesResponse
    An object to access resources that are secured by an Azure AD tenant.
    autoProvision String
    Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
    hybridComputeProvisioningState String
    State of the service principal and its secret
    proxyServer Property Map
    For a non-Azure machine that is not connected directly to the internet, specify a proxy server that the non-Azure machine can use.
    region String
    The location where the metadata of machines will be stored
    resourceGroupName String
    The name of the resource group where Arc (Hybrid Compute) connectors are connected.
    servicePrincipal Property Map
    An object to access resources that are secured by an Azure AD tenant.

    ProxyServerPropertiesResponse

    Ip string
    Proxy server IP
    Port string
    Proxy server port
    Ip string
    Proxy server IP
    Port string
    Proxy server port
    ip String
    Proxy server IP
    port String
    Proxy server port
    ip string
    Proxy server IP
    port string
    Proxy server port
    ip str
    Proxy server IP
    port str
    Proxy server port
    ip String
    Proxy server IP
    port String
    Proxy server port

    ServicePrincipalPropertiesResponse

    ApplicationId string
    Application ID of service principal.
    Secret string
    A secret string that the application uses to prove its identity, also can be referred to as application password (write only).
    ApplicationId string
    Application ID of service principal.
    Secret string
    A secret string that the application uses to prove its identity, also can be referred to as application password (write only).
    applicationId String
    Application ID of service principal.
    secret String
    A secret string that the application uses to prove its identity, also can be referred to as application password (write only).
    applicationId string
    Application ID of service principal.
    secret string
    A secret string that the application uses to prove its identity, also can be referred to as application password (write only).
    application_id str
    Application ID of service principal.
    secret str
    A secret string that the application uses to prove its identity, also can be referred to as application password (write only).
    applicationId String
    Application ID of service principal.
    secret String
    A secret string that the application uses to prove its identity, also can be referred to as application password (write only).

    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi