1. Packages
  2. Azure Native
  3. API Docs
  4. workloads
  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.39.0 published on Monday, Apr 29, 2024 by Pulumi

azure-native.workloads.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.39.0 published on Monday, Apr 29, 2024 by Pulumi

    Gets a connector resource Azure REST API version: 2023-10-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,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetConnectorResult
    def get_connector_output(connector_name: Optional[pulumi.Input[str]] = None,
                      resource_group_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:workloads:getConnector
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ConnectorName string
    The name of the connector resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ConnectorName string
    The name of the connector resource
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    connectorName String
    The name of the connector resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    connectorName string
    The name of the connector resource
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    connector_name str
    The name of the connector resource
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    connectorName String
    The name of the connector resource
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getConnector Result

    The following output properties are available:

    Errors Pulumi.AzureNative.Workloads.Outputs.ConnectorErrorDefinitionResponse
    Indicates any errors on the connector resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Defines the provisioning states.
    SourceResourceId string
    Defines the ID of the connector's source resource.
    SystemData Pulumi.AzureNative.Workloads.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"
    Identity Pulumi.AzureNative.Workloads.Outputs.UserAssignedServiceIdentityResponse
    Managed service identity (user assigned identities)
    ManagedResourceGroupConfiguration Pulumi.AzureNative.Workloads.Outputs.ManagedRGConfigurationResponse
    Managed resource group configuration
    Tags Dictionary<string, string>
    Resource tags.
    Errors ConnectorErrorDefinitionResponse
    Indicates any errors on the connector resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Defines the provisioning states.
    SourceResourceId string
    Defines the ID of the connector's source 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"
    Identity UserAssignedServiceIdentityResponse
    Managed service identity (user assigned identities)
    ManagedResourceGroupConfiguration ManagedRGConfigurationResponse
    Managed resource group configuration
    Tags map[string]string
    Resource tags.
    errors ConnectorErrorDefinitionResponse
    Indicates any errors on the connector resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Defines the provisioning states.
    sourceResourceId String
    Defines the ID of the connector's source 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"
    identity UserAssignedServiceIdentityResponse
    Managed service identity (user assigned identities)
    managedResourceGroupConfiguration ManagedRGConfigurationResponse
    Managed resource group configuration
    tags Map<String,String>
    Resource tags.
    errors ConnectorErrorDefinitionResponse
    Indicates any errors on the connector resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    Defines the provisioning states.
    sourceResourceId string
    Defines the ID of the connector's source 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"
    identity UserAssignedServiceIdentityResponse
    Managed service identity (user assigned identities)
    managedResourceGroupConfiguration ManagedRGConfigurationResponse
    Managed resource group configuration
    tags {[key: string]: string}
    Resource tags.
    errors ConnectorErrorDefinitionResponse
    Indicates any errors on the connector resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    Defines the provisioning states.
    source_resource_id str
    Defines the ID of the connector's source 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"
    identity UserAssignedServiceIdentityResponse
    Managed service identity (user assigned identities)
    managed_resource_group_configuration ManagedRGConfigurationResponse
    Managed resource group configuration
    tags Mapping[str, str]
    Resource tags.
    errors Property Map
    Indicates any errors on the connector resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Defines the provisioning states.
    sourceResourceId String
    Defines the ID of the connector's source 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"
    identity Property Map
    Managed service identity (user assigned identities)
    managedResourceGroupConfiguration Property Map
    Managed resource group configuration
    tags Map<String>
    Resource tags.

    Supporting Types

    ConnectorErrorDefinitionResponse

    Code string
    Service specific error code which serves as the substatus for the HTTP error code.
    Details List<Pulumi.AzureNative.Workloads.Inputs.ConnectorErrorDefinitionResponse>
    Internal error details.
    Message string
    Description of the error.
    Code string
    Service specific error code which serves as the substatus for the HTTP error code.
    Details []ConnectorErrorDefinitionResponse
    Internal error details.
    Message string
    Description of the error.
    code String
    Service specific error code which serves as the substatus for the HTTP error code.
    details List<ConnectorErrorDefinitionResponse>
    Internal error details.
    message String
    Description of the error.
    code string
    Service specific error code which serves as the substatus for the HTTP error code.
    details ConnectorErrorDefinitionResponse[]
    Internal error details.
    message string
    Description of the error.
    code str
    Service specific error code which serves as the substatus for the HTTP error code.
    details Sequence[ConnectorErrorDefinitionResponse]
    Internal error details.
    message str
    Description of the error.
    code String
    Service specific error code which serves as the substatus for the HTTP error code.
    details List<Property Map>
    Internal error details.
    message String
    Description of the error.

    ManagedRGConfigurationResponse

    Name string
    Managed resource group name
    Name string
    Managed resource group name
    name String
    Managed resource group name
    name string
    Managed resource group name
    name str
    Managed resource group name
    name String
    Managed resource group name

    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.

    UserAssignedIdentityResponse

    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    clientId string
    The client ID of the assigned identity.
    principalId string
    The principal ID of the assigned identity.
    client_id str
    The client ID of the assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.

    UserAssignedServiceIdentityResponse

    Type string
    Type of manage identity
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Workloads.Inputs.UserAssignedIdentityResponse>
    User assigned identities dictionary
    Type string
    Type of manage identity
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    User assigned identities dictionary
    type String
    Type of manage identity
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    User assigned identities dictionary
    type string
    Type of manage identity
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    User assigned identities dictionary
    type str
    Type of manage identity
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    User assigned identities dictionary
    type String
    Type of manage identity
    userAssignedIdentities Map<Property Map>
    User assigned identities dictionary

    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.39.0 published on Monday, Apr 29, 2024 by Pulumi