Description for Generate a single sign-on request for the domain management portal.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest?api-version=2023-01-01
URI Parameters
Name |
In |
Required |
Type |
Description |
subscriptionId
|
path |
True
|
string
|
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
|
api-version
|
query |
True
|
string
|
API Version
|
Responses
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name |
Description |
user_impersonation
|
impersonate your user account
|
Examples
Get Domain Control Center Sso Request
Sample Request
POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/generateSsoRequest?api-version=2023-01-01
/**
* Samples for Domains GetControlCenterSsoRequest.
*/
public final class Main {
/*
* x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/
* GetDomainControlCenterSsoRequest.json
*/
/**
* Sample code: Get Domain Control Center Sso Request.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getDomainControlCenterSsoRequest(com.azure.resourcemanager.AzureResourceManager azure) {
azure.webApps().manager().serviceClient().getDomains()
.getControlCenterSsoRequestWithResponse(com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-web
# USAGE
python get_domain_control_center_sso_request.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 = WebSiteManagementClient(
credential=DefaultAzureCredential(),
subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
)
response = client.domains.get_control_center_sso_request()
print(response)
# x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/GetDomainControlCenterSsoRequest.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 armappservice_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/GetDomainControlCenterSsoRequest.json
func ExampleDomainsClient_GetControlCenterSsoRequest() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDomainsClient().GetControlCenterSsoRequest(ctx, 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.DomainControlCenterSsoRequest = armappservice.DomainControlCenterSsoRequest{
// PostParameterKey: to.Ptr("saml"),
// PostParameterValue: to.Ptr("1242sds|k1340"),
// URL: to.Ptr("https://Reseller.provider.com/?xRequestId=sdsdsds&app=dcc"),
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Description for Generate a single sign-on request for the domain management portal.
*
* @summary Description for Generate a single sign-on request for the domain management portal.
* x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/GetDomainControlCenterSsoRequest.json
*/
async function getDomainControlCenterSsoRequest() {
const subscriptionId =
process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
const credential = new DefaultAzureCredential();
const client = new WebSiteManagementClient(credential, subscriptionId);
const result = await client.domains.getControlCenterSsoRequest();
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
Sample Response
{
"url": "https://Reseller.provider.com/?xRequestId=sdsdsds&app=dcc",
"postParameterKey": "saml",
"postParameterValue": "1242sds|k1340"
}
Definitions
DefaultErrorResponse
App Service error response.
Name |
Type |
Description |
error
|
Error
|
Error model.
|
Details
Name |
Type |
Description |
code
|
string
|
Standardized string to programmatically identify the error.
|
message
|
string
|
Detailed error description and debugging information.
|
target
|
string
|
Detailed error description and debugging information.
|
DomainControlCenterSsoRequest
Single sign-on request information for domain management.
Name |
Type |
Description |
postParameterKey
|
string
|
Post parameter key.
|
postParameterValue
|
string
|
Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value.
|
url
|
string
|
URL where the single sign-on request is to be made.
|
Error
Error model.
Name |
Type |
Description |
code
|
string
|
Standardized string to programmatically identify the error.
|
details
|
Details[]
|
Detailed errors.
|
innererror
|
string
|
More information to debug error.
|
message
|
string
|
Detailed error description and debugging information.
|
target
|
string
|
Detailed error description and debugging information.
|