Associations - List All

Referenz

Dienst:: Custom Providers

API-Version:: 2018-09-01-preview

Ruft alle Zuordnung für den angegebenen Bereich ab.

GET https://management.azure.com/{scope}/providers/Microsoft.CustomProviders/associations?api-version=2018-09-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
scope	path	True	string	Der Bereich der Zuordnung.
api-version	query	True	string	Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	AssociationsList	OKAY. Gibt alle Zuordnungen für den angegebenen Bereich zurück.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get all associations

Beispielanforderung

GET https://management.azure.com/scope/providers/Microsoft.CustomProviders/associations?api-version=2018-09-01-preview

from azure.identity import DefaultAzureCredential
from azure.mgmt.customproviders import Customproviders

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-customproviders
# USAGE
    python get_all_associations.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 = Customproviders(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.associations.list_all(
        scope="scope",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/customproviders/resource-manager/Microsoft.CustomProviders/preview/2018-09-01-preview/examples/getAllAssociations.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

package armcustomproviders_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/customproviders/armcustomproviders"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/customproviders/resource-manager/Microsoft.CustomProviders/preview/2018-09-01-preview/examples/getAllAssociations.json
func ExampleAssociationsClient_NewListAllPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcustomproviders.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAssociationsClient().NewListAllPager("scope", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AssociationsList = armcustomproviders.AssociationsList{
		// 	Value: []*armcustomproviders.Association{
		// 		{
		// 			Name: to.Ptr("associationName"),
		// 			Type: to.Ptr("Microsoft.CustomProviders/associations"),
		// 			ID: to.Ptr("scope/providers/Microsoft.CustomProviders/associations/associationName"),
		// 			Properties: &armcustomproviders.AssociationProperties{
		// 				ProvisioningState: to.Ptr(armcustomproviders.ProvisioningStateSucceeded),
		// 				TargetResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName"),
		// 			},
		// 	}},
		// }
	}
}

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "name": "associationName",
      "id": "scope/providers/Microsoft.CustomProviders/associations/associationName",
      "type": "Microsoft.CustomProviders/associations",
      "properties": {
        "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/appRG/providers/Microsoft.Solutions/applications/applicationName",
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
Association	Die Ressourcendefinition dieser Zuordnung.
AssociationsList	Liste der Zuordnungen.
ErrorDefinition	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
ProvisioningState	Der Bereitstellungsstatus des Ressourcenanbieters.

Association

Objekt

Die Ressourcendefinition dieser Zuordnung.

Name	Typ	Beschreibung
id	string	Die Zuordnungs-ID.
name	string	Der Zuordnungsname.
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus der Zuordnung.
properties.targetResourceId	string	Die REST-Ressourceninstanz der Zielressource für diese Zuordnung.
type	string	Der Zuordnungstyp.