Single Sign On - Create Or Update

Service:

Logz

API Version:

2020-10-01

Configure l’authentification unique pour cette ressource. Cette opération peut prendre jusqu’à 10 minutes.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/singleSignOnConfigurations/{configurationName}?api-version=2020-10-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
configurationName	path	True	string
monitorName	path	True	string	Surveiller le nom de la ressource
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties	LogzSingleSignOnProperties

Réponses

Nom	Type	Description
200 OK	LogzSingleSignOnResource	Succès
201 Created	LogzSingleSignOnResource	Opération réussie
Other Status Codes	ErrorResponse	Réponse d’erreur par défaut.

Exemples

SingleSignOnConfigurations_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Logz/monitors/myMonitor/singleSignOnConfigurations/default?api-version=2020-10-01

Java

/** Samples for SingleSignOn CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/examples/SingleSignOnConfigurations_CreateOrUpdate.json
     */
    /**
     * Sample code: SingleSignOnConfigurations_CreateOrUpdate.
     *
     * @param manager Entry point to LogzManager.
     */
    public static void singleSignOnConfigurationsCreateOrUpdate(com.azure.resourcemanager.logz.LogzManager manager) {
        manager.singleSignOns().define("default").withExistingMonitor("myResourceGroup", "myMonitor").create();
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.logz import MicrosoftLogz

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-logz
# USAGE
    python single_sign_on_configurations_create_or_update.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 = MicrosoftLogz(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.single_sign_on.begin_create_or_update(
        resource_group_name="myResourceGroup",
        monitor_name="myMonitor",
        configuration_name="default",
    ).result()
    print(response)


# x-ms-original-file: specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/examples/SingleSignOnConfigurations_CreateOrUpdate.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 armlogz_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/logz/armlogz"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/logz/resource-manager/Microsoft.Logz/stable/2020-10-01/examples/SingleSignOnConfigurations_CreateOrUpdate.json
func ExampleSingleSignOnClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armlogz.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSingleSignOnClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myMonitor", "default", &armlogz.SingleSignOnClientBeginCreateOrUpdateOptions{Body: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.SingleSignOnResource = armlogz.SingleSignOnResource{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Logz/monitors"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Logz/monitors/myMonitor/singleSignOnConfigurations/default"),
	// 	Properties: &armlogz.SingleSignOnProperties{
	// 		EnterpriseAppID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		ProvisioningState: to.Ptr(armlogz.ProvisioningStateSucceeded),
	// 		SingleSignOnState: to.Ptr(armlogz.SingleSignOnStatesEnable),
	// 		SingleSignOnURL: to.Ptr("https://www.logz.io/IAmSomeHash"),
	// 	},
	// }
}

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

Sample Response

Status code:

200

{
  "name": "default",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Logz/monitors/myMonitor/singleSignOnConfigurations/default",
  "type": "Microsoft.Logz/monitors",
  "properties": {
    "provisioningState": "Succeeded",
    "singleSignOnState": "Enable",
    "enterpriseAppId": "00000000-0000-0000-0000-000000000000",
    "singleSignOnUrl": "https://www.logz.io/IAmSomeHash"
  }
}

Status code:

201

{
  "name": "default",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Logz/monitors/myMonitor/singleSignOnConfigurations/default",
  "type": "Microsoft.Logz/monitors",
  "properties": {
    "provisioningState": "Succeeded",
    "singleSignOnState": "Enable",
    "enterpriseAppId": "00000000-0000-0000-0000-000000000000",
    "singleSignOnUrl": "https://www.logz.io/IAmSomeHash"
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
LogzSingleSignOnProperties
LogzSingleSignOnResource
ProvisioningState	Indicateur spécifiant si l’état d’approvisionnement des ressources est suivi par ARM.
SingleSignOnStates	Différents états de la ressource SSO
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

LogzSingleSignOnProperties

Nom	Type	Description
enterpriseAppId	string	ID de l’application d’entreprise utilisée pour l’authentification unique.
provisioningState	ProvisioningState	Indicateur spécifiant si l’état d’approvisionnement des ressources est suivi par ARM.
singleSignOnState	SingleSignOnStates	Différents états de la ressource SSO
singleSignOnUrl	string	URL de connexion spécifique à cette organisation Logz.

LogzSingleSignOnResource

Nom	Type	Description
id	string	ID ARM de la ressource.
name	string	Nom de la configuration.
properties	LogzSingleSignOnProperties
systemData	systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
type	string	Type de la ressource.

ProvisioningState

Indicateur spécifiant si l’état d’approvisionnement des ressources est suivi par ARM.

Nom	Type	Description
Accepted	string
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Succeeded	string
Updating	string

SingleSignOnStates

Différents états de la ressource SSO

Nom	Type	Description
Disable	string
Enable	string
Existing	string
Initial	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.