Single Sign On - Create Or Update

Service:

Logz

API Version:

2020-10-01

Konfiguruje logowanie jednokrotne dla tego zasobu. Wykonanie tej operacji może potrwać do 10 minut.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
configurationName	path	True	string
monitorName	path	True	string	Monitorowanie nazwy zasobu
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties	LogzSingleSignOnProperties

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LogzSingleSignOnResource	Powodzenie
201 Created	LogzSingleSignOnResource	Powodzenie
Other Status Codes	ErrorResponse	Domyślna odpowiedź na błąd.

Przykłady

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

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
LogzSingleSignOnProperties
LogzSingleSignOnResource
ProvisioningState	Flaga określająca, czy stan aprowizacji zasobów jest śledzony przez usługę ARM.
SingleSignOnStates	Różne stany zasobu logowania jednokrotnego
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

LogzSingleSignOnProperties

Nazwa	Typ	Opis
enterpriseAppId	string	Identyfikator aplikacji dla przedsiębiorstw używany do logowania jednokrotnego.
provisioningState	ProvisioningState	Flaga określająca, czy stan aprowizacji zasobów jest śledzony przez usługę ARM.
singleSignOnState	SingleSignOnStates	Różne stany zasobu logowania jednokrotnego
singleSignOnUrl	string	Adres URL logowania specyficzny dla tej organizacji logz.

LogzSingleSignOnResource

Nazwa	Typ	Opis
id	string	Identyfikator usługi ARM zasobu.
name	string	Nazwa konfiguracji.
properties	LogzSingleSignOnProperties
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	string	Typ zasobu.

ProvisioningState

Flaga określająca, czy stan aprowizacji zasobów jest śledzony przez usługę ARM.

Nazwa	Typ	Opis
Accepted	string
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Succeeded	string
Updating	string

SingleSignOnStates

Różne stany zasobu logowania jednokrotnego

Nazwa	Typ	Opis
Disable	string
Enable	string
Existing	string
Initial	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.