azure-native.cognitiveservices.getPrivateEndpointConnection
Explore with Pulumi AI
Gets the specified private endpoint connection associated with the Cognitive Services account. Azure REST API version: 2023-05-01.
Using getPrivateEndpointConnection
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 getPrivateEndpointConnection(args: GetPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointConnectionResult>
function getPrivateEndpointConnectionOutput(args: GetPrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointConnectionResult>
def get_private_endpoint_connection(account_name: Optional[str] = None,
private_endpoint_connection_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionResult
def get_private_endpoint_connection_output(account_name: Optional[pulumi.Input[str]] = None,
private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointConnectionResult]
func LookupPrivateEndpointConnection(ctx *Context, args *LookupPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionResult, error)
func LookupPrivateEndpointConnectionOutput(ctx *Context, args *LookupPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionResultOutput
> Note: This function is named LookupPrivateEndpointConnection
in the Go SDK.
public static class GetPrivateEndpointConnection
{
public static Task<GetPrivateEndpointConnectionResult> InvokeAsync(GetPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
public static Output<GetPrivateEndpointConnectionResult> Invoke(GetPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:cognitiveservices:getPrivateEndpointConnection
arguments:
# arguments dictionary
The following arguments are supported:
- Account
Name string The name of Cognitive Services account.
- Private
Endpoint stringConnection Name The name of the private endpoint connection associated with the Cognitive Services Account
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Account
Name string The name of Cognitive Services account.
- Private
Endpoint stringConnection Name The name of the private endpoint connection associated with the Cognitive Services Account
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- account
Name String The name of Cognitive Services account.
- private
Endpoint StringConnection Name The name of the private endpoint connection associated with the Cognitive Services Account
- resource
Group StringName The name of the resource group. The name is case insensitive.
- account
Name string The name of Cognitive Services account.
- private
Endpoint stringConnection Name The name of the private endpoint connection associated with the Cognitive Services Account
- resource
Group stringName The name of the resource group. The name is case insensitive.
- account_
name str The name of Cognitive Services account.
- private_
endpoint_ strconnection_ name The name of the private endpoint connection associated with the Cognitive Services Account
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- account
Name String The name of Cognitive Services account.
- private
Endpoint StringConnection Name The name of the private endpoint connection associated with the Cognitive Services Account
- resource
Group StringName The name of the resource group. The name is case insensitive.
getPrivateEndpointConnection Result
The following output properties are available:
- Etag string
Resource Etag.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Name string
The name of the resource
- Properties
Pulumi.
Azure Native. Cognitive Services. Outputs. Private Endpoint Connection Properties Response Resource properties.
- System
Data Pulumi.Azure Native. Cognitive Services. Outputs. System Data Response Metadata pertaining to creation and last modification of the resource.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Location string
The location of the private endpoint connection
- Etag string
Resource Etag.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Name string
The name of the resource
- Properties
Private
Endpoint Connection Properties Response Resource properties.
- System
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Location string
The location of the private endpoint connection
- etag String
Resource Etag.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name String
The name of the resource
- properties
Private
Endpoint Connection Properties Response Resource properties.
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- location String
The location of the private endpoint connection
- etag string
Resource Etag.
- id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name string
The name of the resource
- properties
Private
Endpoint Connection Properties Response Resource properties.
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- location string
The location of the private endpoint connection
- etag str
Resource Etag.
- id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name str
The name of the resource
- properties
Private
Endpoint Connection Properties Response Resource properties.
- system_
data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- location str
The location of the private endpoint connection
- etag String
Resource Etag.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name String
The name of the resource
- properties Property Map
Resource properties.
- system
Data Property Map Metadata pertaining to creation and last modification of the resource.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- location String
The location of the private endpoint connection
Supporting Types
PrivateEndpointConnectionPropertiesResponse
- Private
Link Pulumi.Service Connection State Azure Native. Cognitive Services. Inputs. Private Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State string The provisioning state of the private endpoint connection resource.
- Group
Ids List<string> The private link resource group ids.
- Private
Endpoint Pulumi.Azure Native. Cognitive Services. Inputs. Private Endpoint Response The resource of private end point.
- Private
Link PrivateService Connection State Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State string The provisioning state of the private endpoint connection resource.
- Group
Ids []string The private link resource group ids.
- Private
Endpoint PrivateEndpoint Response The resource of private end point.
- private
Link PrivateService Connection State Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- provisioning
State String The provisioning state of the private endpoint connection resource.
- group
Ids List<String> The private link resource group ids.
- private
Endpoint PrivateEndpoint Response The resource of private end point.
- private
Link PrivateService Connection State Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- provisioning
State string The provisioning state of the private endpoint connection resource.
- group
Ids string[] The private link resource group ids.
- private
Endpoint PrivateEndpoint Response The resource of private end point.
- private_
link_ Privateservice_ connection_ state Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- provisioning_
state str The provisioning state of the private endpoint connection resource.
- group_
ids Sequence[str] The private link resource group ids.
- private_
endpoint PrivateEndpoint Response The resource of private end point.
- private
Link Property MapService Connection State A collection of information about the state of the connection between service consumer and provider.
- provisioning
State String The provisioning state of the private endpoint connection resource.
- group
Ids List<String> The private link resource group ids.
- private
Endpoint Property Map The resource of private end point.
PrivateEndpointResponse
- Id string
The ARM identifier for Private Endpoint
- Id string
The ARM identifier for Private Endpoint
- id String
The ARM identifier for Private Endpoint
- id string
The ARM identifier for Private Endpoint
- id str
The ARM identifier for Private Endpoint
- id String
The ARM identifier for Private Endpoint
PrivateLinkServiceConnectionStateResponse
- Actions
Required string A message indicating if changes on the service provider require any updates on the consumer.
- Description string
The reason for approval/rejection of the connection.
- Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required string A message indicating if changes on the service provider require any updates on the consumer.
- Description string
The reason for approval/rejection of the connection.
- Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String A message indicating if changes on the service provider require any updates on the consumer.
- description String
The reason for approval/rejection of the connection.
- status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required string A message indicating if changes on the service provider require any updates on the consumer.
- description string
The reason for approval/rejection of the connection.
- status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions_
required str A message indicating if changes on the service provider require any updates on the consumer.
- description str
The reason for approval/rejection of the connection.
- status str
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String A message indicating if changes on the service provider require any updates on the consumer.
- description String
The reason for approval/rejection of the connection.
- status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
SystemDataResponse
- 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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0