azure-native.agfoodplatform.DataConnector
Explore with Pulumi AI
DataConnector Model.
Uses Azure REST API version 2023-06-01-preview. In version 2.x of the Azure Native provider, it used API version 2023-06-01-preview.
Create DataConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataConnector(name: string, args: DataConnectorArgs, opts?: CustomResourceOptions);
@overload
def DataConnector(resource_name: str,
args: DataConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DataConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_manager_for_agriculture_resource_name: Optional[str] = None,
properties: Optional[DataConnectorPropertiesArgs] = None,
resource_group_name: Optional[str] = None,
data_connector_name: Optional[str] = None)
func NewDataConnector(ctx *Context, name string, args DataConnectorArgs, opts ...ResourceOption) (*DataConnector, error)
public DataConnector(string name, DataConnectorArgs args, CustomResourceOptions? opts = null)
public DataConnector(String name, DataConnectorArgs args)
public DataConnector(String name, DataConnectorArgs args, CustomResourceOptions options)
type: azure-native:agfoodplatform:DataConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DataConnectorArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. DataConnectorArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DataConnectorArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DataConnectorArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. DataConnectorArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var dataConnectorResource = new AzureNative.AgFoodPlatform.DataConnector("dataConnectorResource", new()
{
DataManagerForAgricultureResourceName = "string",
Properties = new AzureNative.AgFoodPlatform.Inputs.DataConnectorPropertiesArgs
{
Credentials = new AzureNative.AgFoodPlatform.Inputs.ApiKeyAuthCredentialsArgs
{
ApiKey = new AzureNative.AgFoodPlatform.Inputs.KeyVaultPropertiesArgs
{
KeyName = "string",
KeyVaultUri = "string",
KeyVersion = "string",
},
Kind = "ApiKeyAuthCredentials",
},
},
ResourceGroupName = "string",
DataConnectorName = "string",
});
example, err := agfoodplatform.NewDataConnector(ctx, "dataConnectorResource", &agfoodplatform.DataConnectorArgs{
DataManagerForAgricultureResourceName: pulumi.String("string"),
Properties: &agfoodplatform.DataConnectorPropertiesArgs{
Credentials: agfoodplatform.ApiKeyAuthCredentials{
ApiKey: agfoodplatform.KeyVaultProperties{
KeyName: "string",
KeyVaultUri: "string",
KeyVersion: "string",
},
Kind: "ApiKeyAuthCredentials",
},
},
ResourceGroupName: pulumi.String("string"),
DataConnectorName: pulumi.String("string"),
})
var dataConnectorResource = new DataConnector("dataConnectorResource", DataConnectorArgs.builder()
.dataManagerForAgricultureResourceName("string")
.properties(DataConnectorPropertiesArgs.builder()
.credentials(ApiKeyAuthCredentialsArgs.builder()
.apiKey(KeyVaultPropertiesArgs.builder()
.keyName("string")
.keyVaultUri("string")
.keyVersion("string")
.build())
.kind("ApiKeyAuthCredentials")
.build())
.build())
.resourceGroupName("string")
.dataConnectorName("string")
.build());
data_connector_resource = azure_native.agfoodplatform.DataConnector("dataConnectorResource",
data_manager_for_agriculture_resource_name="string",
properties={
"credentials": {
"api_key": {
"key_name": "string",
"key_vault_uri": "string",
"key_version": "string",
},
"kind": "ApiKeyAuthCredentials",
},
},
resource_group_name="string",
data_connector_name="string")
const dataConnectorResource = new azure_native.agfoodplatform.DataConnector("dataConnectorResource", {
dataManagerForAgricultureResourceName: "string",
properties: {
credentials: {
apiKey: {
keyName: "string",
keyVaultUri: "string",
keyVersion: "string",
},
kind: "ApiKeyAuthCredentials",
},
},
resourceGroupName: "string",
dataConnectorName: "string",
});
type: azure-native:agfoodplatform:DataConnector
properties:
dataConnectorName: string
dataManagerForAgricultureResourceName: string
properties:
credentials:
apiKey:
keyName: string
keyVaultUri: string
keyVersion: string
kind: ApiKeyAuthCredentials
resourceGroupName: string
DataConnector Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DataConnector resource accepts the following input properties:
- Data
Manager For Agriculture Resource Name This property is required. Changes to this property will trigger replacement.
- DataManagerForAgriculture resource name.
- Properties
This property is required. Pulumi.Azure Native. Ag Food Platform. Inputs. Data Connector Properties - DataConnector Properties.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Data
Connector Name Changes to this property will trigger replacement.
- Connector name.
- Data
Manager For Agriculture Resource Name This property is required. Changes to this property will trigger replacement.
- DataManagerForAgriculture resource name.
- Properties
This property is required. DataConnector Properties Args - DataConnector Properties.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Data
Connector Name Changes to this property will trigger replacement.
- Connector name.
- data
Manager For Agriculture Resource Name This property is required. Changes to this property will trigger replacement.
- DataManagerForAgriculture resource name.
- properties
This property is required. DataConnector Properties - DataConnector Properties.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- data
Connector Name Changes to this property will trigger replacement.
- Connector name.
- data
Manager For Agriculture Resource Name This property is required. Changes to this property will trigger replacement.
- DataManagerForAgriculture resource name.
- properties
This property is required. DataConnector Properties - DataConnector Properties.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- data
Connector Name Changes to this property will trigger replacement.
- Connector name.
- data_
manager_ for_ agriculture_ resource_ name This property is required. Changes to this property will trigger replacement.
- DataManagerForAgriculture resource name.
- properties
This property is required. DataConnector Properties Args - DataConnector Properties.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- data_
connector_ name Changes to this property will trigger replacement.
- Connector name.
- data
Manager For Agriculture Resource Name This property is required. Changes to this property will trigger replacement.
- DataManagerForAgriculture resource name.
- properties
This property is required. Property Map - DataConnector Properties.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- data
Connector Name Changes to this property will trigger replacement.
- Connector name.
Outputs
All input properties are implicitly available as output properties. Additionally, the DataConnector resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- ETag string
- The ETag value to implement optimistic concurrency.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Ag Food Platform. Outputs. System Data Response - 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"
- Azure
Api stringVersion - The Azure API version of the resource.
- ETag string
- The ETag value to implement optimistic concurrency.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- e
Tag String - The ETag value to implement optimistic concurrency.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - 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"
- azure
Api stringVersion - The Azure API version of the resource.
- e
Tag string - The ETag value to implement optimistic concurrency.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - 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"
- azure_
api_ strversion - The Azure API version of the resource.
- e_
tag str - The ETag value to implement optimistic concurrency.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- e
Tag String - The ETag value to implement optimistic concurrency.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data 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"
Supporting Types
ApiKeyAuthCredentials, ApiKeyAuthCredentialsArgs
- Api
Key This property is required. Pulumi.Azure Native. Ag Food Platform. Inputs. Key Vault Properties - Properties of the key vault.
- Api
Key This property is required. KeyVault Properties - Properties of the key vault.
- api
Key This property is required. KeyVault Properties - Properties of the key vault.
- api
Key This property is required. KeyVault Properties - Properties of the key vault.
- api_
key This property is required. KeyVault Properties - Properties of the key vault.
- api
Key This property is required. Property Map - Properties of the key vault.
ApiKeyAuthCredentialsResponse, ApiKeyAuthCredentialsResponseArgs
- Api
Key This property is required. Pulumi.Azure Native. Ag Food Platform. Inputs. Key Vault Properties Response - Properties of the key vault.
- Api
Key This property is required. KeyVault Properties Response - Properties of the key vault.
- api
Key This property is required. KeyVault Properties Response - Properties of the key vault.
- api
Key This property is required. KeyVault Properties Response - Properties of the key vault.
- api_
key This property is required. KeyVault Properties Response - Properties of the key vault.
- api
Key This property is required. Property Map - Properties of the key vault.
DataConnectorProperties, DataConnectorPropertiesArgs
- Credentials
This property is required. Pulumi.Azure | Pulumi.Native. Ag Food Platform. Inputs. Api Key Auth Credentials Azure Native. Ag Food Platform. Inputs. OAuth Client Credentials - AuthCredentials abstract base class for Auth Purpose.
- Credentials
This property is required. ApiKey | OAuthAuth Credentials Client Credentials - AuthCredentials abstract base class for Auth Purpose.
- credentials
This property is required. ApiKey | OAuthAuth Credentials Client Credentials - AuthCredentials abstract base class for Auth Purpose.
- credentials
This property is required. ApiKey | OAuthAuth Credentials Client Credentials - AuthCredentials abstract base class for Auth Purpose.
- credentials
This property is required. ApiKey | OAuthAuth Credentials Client Credentials - AuthCredentials abstract base class for Auth Purpose.
- credentials
This property is required. Property Map | Property Map - AuthCredentials abstract base class for Auth Purpose.
DataConnectorPropertiesResponse, DataConnectorPropertiesResponseArgs
- Credentials
This property is required. Pulumi.Azure | Pulumi.Native. Ag Food Platform. Inputs. Api Key Auth Credentials Response Azure Native. Ag Food Platform. Inputs. OAuth Client Credentials Response - AuthCredentials abstract base class for Auth Purpose.
- Credentials
This property is required. ApiKey | OAuthAuth Credentials Response Client Credentials Response - AuthCredentials abstract base class for Auth Purpose.
- credentials
This property is required. ApiKey | OAuthAuth Credentials Response Client Credentials Response - AuthCredentials abstract base class for Auth Purpose.
- credentials
This property is required. ApiKey | OAuthAuth Credentials Response Client Credentials Response - AuthCredentials abstract base class for Auth Purpose.
- credentials
This property is required. ApiKey | OAuthAuth Credentials Response Client Credentials Response - AuthCredentials abstract base class for Auth Purpose.
- credentials
This property is required. Property Map | Property Map - AuthCredentials abstract base class for Auth Purpose.
KeyVaultProperties, KeyVaultPropertiesArgs
- Key
Name This property is required. string - Name of Key Vault key.
- Key
Vault Uri This property is required. string - Uri of the key vault.
- Key
Version This property is required. string - Version of Key Vault key.
- Key
Name This property is required. string - Name of Key Vault key.
- Key
Vault Uri This property is required. string - Uri of the key vault.
- Key
Version This property is required. string - Version of Key Vault key.
- key
Name This property is required. String - Name of Key Vault key.
- key
Vault Uri This property is required. String - Uri of the key vault.
- key
Version This property is required. String - Version of Key Vault key.
- key
Name This property is required. string - Name of Key Vault key.
- key
Vault Uri This property is required. string - Uri of the key vault.
- key
Version This property is required. string - Version of Key Vault key.
- key_
name This property is required. str - Name of Key Vault key.
- key_
vault_ uri This property is required. str - Uri of the key vault.
- key_
version This property is required. str - Version of Key Vault key.
- key
Name This property is required. String - Name of Key Vault key.
- key
Vault Uri This property is required. String - Uri of the key vault.
- key
Version This property is required. String - Version of Key Vault key.
KeyVaultPropertiesResponse, KeyVaultPropertiesResponseArgs
- Key
Name This property is required. string - Name of Key Vault key.
- Key
Vault Uri This property is required. string - Uri of the key vault.
- Key
Version This property is required. string - Version of Key Vault key.
- Key
Name This property is required. string - Name of Key Vault key.
- Key
Vault Uri This property is required. string - Uri of the key vault.
- Key
Version This property is required. string - Version of Key Vault key.
- key
Name This property is required. String - Name of Key Vault key.
- key
Vault Uri This property is required. String - Uri of the key vault.
- key
Version This property is required. String - Version of Key Vault key.
- key
Name This property is required. string - Name of Key Vault key.
- key
Vault Uri This property is required. string - Uri of the key vault.
- key
Version This property is required. string - Version of Key Vault key.
- key_
name This property is required. str - Name of Key Vault key.
- key_
vault_ uri This property is required. str - Uri of the key vault.
- key_
version This property is required. str - Version of Key Vault key.
- key
Name This property is required. String - Name of Key Vault key.
- key
Vault Uri This property is required. String - Uri of the key vault.
- key
Version This property is required. String - Version of Key Vault key.
OAuthClientCredentials, OAuthClientCredentialsArgs
- Client
Id This property is required. string - ClientId associated with the provider.
- Client
Secret This property is required. Pulumi.Azure Native. Ag Food Platform. Inputs. Key Vault Properties - Properties of the key vault.
- Client
Id This property is required. string - ClientId associated with the provider.
- Client
Secret This property is required. KeyVault Properties - Properties of the key vault.
- client
Id This property is required. String - ClientId associated with the provider.
- client
Secret This property is required. KeyVault Properties - Properties of the key vault.
- client
Id This property is required. string - ClientId associated with the provider.
- client
Secret This property is required. KeyVault Properties - Properties of the key vault.
- client_
id This property is required. str - ClientId associated with the provider.
- client_
secret This property is required. KeyVault Properties - Properties of the key vault.
- client
Id This property is required. String - ClientId associated with the provider.
- client
Secret This property is required. Property Map - Properties of the key vault.
OAuthClientCredentialsResponse, OAuthClientCredentialsResponseArgs
- Client
Id This property is required. string - ClientId associated with the provider.
- Client
Secret This property is required. Pulumi.Azure Native. Ag Food Platform. Inputs. Key Vault Properties Response - Properties of the key vault.
- Client
Id This property is required. string - ClientId associated with the provider.
- Client
Secret This property is required. KeyVault Properties Response - Properties of the key vault.
- client
Id This property is required. String - ClientId associated with the provider.
- client
Secret This property is required. KeyVault Properties Response - Properties of the key vault.
- client
Id This property is required. string - ClientId associated with the provider.
- client
Secret This property is required. KeyVault Properties Response - Properties of the key vault.
- client_
id This property is required. str - ClientId associated with the provider.
- client_
secret This property is required. KeyVault Properties Response - Properties of the key vault.
- client
Id This property is required. String - ClientId associated with the provider.
- client
Secret This property is required. Property Map - Properties of the key vault.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:agfoodplatform:DataConnector SatelliteSentinelHub /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/dataConnectors/{dataConnectorName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0