Associations - List All

Serviço:

Custom Providers

Versão da API:

2018-09-01-preview

Obtém toda a associação para o escopo fornecido.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
scope	path	True	string	O escopo da associação.
api-version	query	True	string	A versão da API a ser usada com a solicitação HTTP.

Respostas

Nome	Tipo	Description
200 OK	AssociationsList	OKEY. Retorna todas as associações para o escopo especificado.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get all associations

Solicitação de exemplo

HTTP

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

Python

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

Go

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

Resposta de exemplo

Código de status:

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"
      }
    }
  ]
}

Definições

Nome	Description
Association	A definição de recurso dessa associação.
AssociationsList	Lista de associações.
ErrorDefinition	Definição de erro.
ErrorResponse	Resposta de erro.
ProvisioningState	O estado de provisionamento do provedor de recursos.

Association

Objeto

A definição de recurso dessa associação.

Nome	Tipo	Description
id	string	A ID da associação.
name	string	O nome da associação.
properties.provisioningState	ProvisioningState	O estado de provisionamento da associação.
properties.targetResourceId	string	A instância de recurso REST do recurso de destino para essa associação.
type	string	O tipo de associação.

AssociationsList

Objeto

Lista de associações.

Nome	Tipo	Description
nextLink	string	A URL a ser usada para obter o próximo conjunto de resultados.
value	Association[]	A matriz de associações.

ErrorDefinition

Objeto

Definição de erro.

Nome	Tipo	Description
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	ErrorDefinition[]	Detalhes internos do erro.
message	string	Descrição do erro.

ErrorResponse

Objeto

Resposta de erro.

Nome	Tipo	Description
error	ErrorDefinition	Os detalhes do erro.

ProvisioningState

Enumeração

O estado de provisionamento do provedor de recursos.

Valor	Description
Accepted
Deleting
Failed
Running
Succeeded