1. Packages
  2. Azure Native
  3. API Docs
  4. security
  5. getConnector
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.security.getConnector

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Details of a specific cloud account connector

Uses 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>
Copy
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]
Copy
func LookupConnector(ctx *Context, args *LookupConnectorArgs, opts ...InvokeOption) (*LookupConnectorResult, error)
func LookupConnectorOutput(ctx *Context, args *LookupConnectorOutputArgs, opts ...InvokeOption) LookupConnectorResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
public static Output<GetConnectorResult> getConnector(GetConnectorArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:security:getConnector
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectorName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cloud account connector
ConnectorName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cloud account connector
connectorName
This property is required.
Changes to this property will trigger replacement.
String
Name of the cloud account connector
connectorName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cloud account connector
connector_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the cloud account connector
connectorName
This property is required.
Changes to this property will trigger replacement.
String
Name of the cloud account connector

getConnector Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
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).
AzureApiVersion string
The Azure API version of the resource.
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).
azureApiVersion String
The Azure API version of the resource.
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).
azureApiVersion string
The Azure API version of the resource.
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).
azure_api_version str
The Azure API version of the resource.
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).
azureApiVersion String
The Azure API version of the resource.
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 This property is required. string
The ID of the cloud account
AuthenticationProvisioningState This property is required. string
State of the multi-cloud connector
AwsAssumeRoleArn This property is required. string
Assumed role ID is an identifier that you can use to create temporary security credentials.
AwsExternalId This property is required. string
A unique identifier that is required when you assume a role in another account.
GrantedPermissions This property is required. List<string>
The permissions detected in the cloud account.
AccountId This property is required. string
The ID of the cloud account
AuthenticationProvisioningState This property is required. string
State of the multi-cloud connector
AwsAssumeRoleArn This property is required. string
Assumed role ID is an identifier that you can use to create temporary security credentials.
AwsExternalId This property is required. string
A unique identifier that is required when you assume a role in another account.
GrantedPermissions This property is required. []string
The permissions detected in the cloud account.
accountId This property is required. String
The ID of the cloud account
authenticationProvisioningState This property is required. String
State of the multi-cloud connector
awsAssumeRoleArn This property is required. String
Assumed role ID is an identifier that you can use to create temporary security credentials.
awsExternalId This property is required. String
A unique identifier that is required when you assume a role in another account.
grantedPermissions This property is required. List<String>
The permissions detected in the cloud account.
accountId This property is required. string
The ID of the cloud account
authenticationProvisioningState This property is required. string
State of the multi-cloud connector
awsAssumeRoleArn This property is required. string
Assumed role ID is an identifier that you can use to create temporary security credentials.
awsExternalId This property is required. string
A unique identifier that is required when you assume a role in another account.
grantedPermissions This property is required. string[]
The permissions detected in the cloud account.
account_id This property is required. str
The ID of the cloud account
authentication_provisioning_state This property is required. str
State of the multi-cloud connector
aws_assume_role_arn This property is required. str
Assumed role ID is an identifier that you can use to create temporary security credentials.
aws_external_id This property is required. str
A unique identifier that is required when you assume a role in another account.
granted_permissions This property is required. Sequence[str]
The permissions detected in the cloud account.
accountId This property is required. String
The ID of the cloud account
authenticationProvisioningState This property is required. String
State of the multi-cloud connector
awsAssumeRoleArn This property is required. String
Assumed role ID is an identifier that you can use to create temporary security credentials.
awsExternalId This property is required. String
A unique identifier that is required when you assume a role in another account.
grantedPermissions This property is required. List<String>
The permissions detected in the cloud account.

AwsCredsAuthenticationDetailsPropertiesResponse

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

GcpCredentialsDetailsPropertiesResponse

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

HybridComputeSettingsPropertiesResponse

AutoProvision This property is required. string
Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
HybridComputeProvisioningState This property is required. 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 This property is required. string
Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
HybridComputeProvisioningState This property is required. 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 This property is required. String
Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
hybridComputeProvisioningState This property is required. 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 This property is required. string
Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
hybridComputeProvisioningState This property is required. 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 This property is required. str
Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
hybrid_compute_provisioning_state This property is required. 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 This property is required. String
Whether or not to automatically install Azure Arc (hybrid compute) agents on machines
hybridComputeProvisioningState This property is required. 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
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi