Connection - Get

Szolgáltatás:

Automation

API-verzió:

2024-10-23

Kérje le a kapcsolatnév alapján azonosított kapcsolatot.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName}?api-version=2024-10-23

URI-paraméterek

Name	In	Kötelező	Típus	Description
automationAccountName	path	True	string	Az automation-fiók neve.
connectionName	path	True	string	A kapcsolat neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	Connection	Az Azure-művelet sikeresen befejeződött.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get a connection

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount28/connections/myConnection?api-version=2024-10-23

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.automation import AutomationClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-automation
# USAGE
    python get_connection.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AutomationClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.connection.get(
        resource_group_name="rg",
        automation_account_name="myAutomationAccount28",
        connection_name="myConnection",
    )
    print(response)


# x-ms-original-file: 2024-10-23/getConnection.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armautomation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

// Generated from example definition: 2024-10-23/getConnection.json
func ExampleConnectionClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armautomation.NewClientFactory("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewConnectionClient().Get(ctx, "rg", "myAutomationAccount28", "myConnection", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armautomation.ConnectionClientGetResponse{
	// 	Connection: armautomation.Connection{
	// 		Name: to.Ptr("myConnection"),
	// 		ID: to.Ptr("/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount28/connections/myConnection"),
	// 		Properties: &armautomation.ConnectionProperties{
	// 			Description: to.Ptr("my description goes here"),
	// 			ConnectionType: &armautomation.ConnectionTypeAssociationProperty{
	// 				Name: to.Ptr("Azure"),
	// 			},
	// 			CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-27T07:52:29.29+00:00"); return t}()),
	// 			FieldDefinitionValues: map[string]*string{
	// 				"AutomationCertificateName": to.Ptr("myCertificateName"),
	// 				"SubscriptionID": to.Ptr("b5e4748c-f69a-467c-8749-e2f9c8cd3007"),
	// 			},
	// 			LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-03-27T07:52:33.617+00:00"); return t}()),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to retrieve the connection identified by connection name.
 *
 * @summary retrieve the connection identified by connection name.
 * x-ms-original-file: 2024-10-23/getConnection.json
 */
async function getAConnection() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee";
  const client = new AutomationClient(credential, subscriptionId);
  const result = await client.connectionOperations.get(
    "rg",
    "myAutomationAccount28",
    "myConnection",
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:

200

{
  "name": "myConnection",
  "id": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount28/connections/myConnection",
  "properties": {
    "description": "my description goes here",
    "connectionType": {
      "name": "Azure"
    },
    "creationTime": "2017-03-27T07:52:29.29+00:00",
    "fieldDefinitionValues": {
      "AutomationCertificateName": "myCertificateName",
      "SubscriptionID": "b5e4748c-f69a-467c-8749-e2f9c8cd3007"
    },
    "lastModifiedTime": "2017-03-27T07:52:33.617+00:00"
  }
}

Definíciók

Name	Description
Connection	A kapcsolat definíciója.
ConnectionTypeAssociationProperty	Az entitáshoz társított kapcsolattípus-tulajdonság.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Connection

Tárgy

A kapcsolat definíciója.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties.connectionType	ConnectionTypeAssociationProperty	Lekéri vagy beállítja a kapcsolat kapcsolattípusát.
properties.creationTime	string (date-time)	Megkapja a létrehozási időt.
properties.description	string	Lekéri vagy beállítja a leírást.
properties.fieldDefinitionValues	object	Lekéri a kapcsolat meződefiníciós értékeit.
properties.lastModifiedTime	string (date-time)	Az utolsó módosítás időpontja.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ConnectionTypeAssociationProperty

Tárgy

Az entitáshoz társított kapcsolattípus-tulajdonság.

Name	Típus	Description
name	string	Lekéri vagy beállítja a kapcsolattípus nevét.

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.