Static Sites - Create User Roles Invitation Link

Szolgáltatás:

App Service

API-verzió:

2024-11-01

A szerepkörrel rendelkező felhasználó meghívási hivatkozásának létrehozása

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/createUserInvitation?api-version=2024-11-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
name	path	True	string	A statikus hely neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Annak az erőforráscsoportnak a neve, amelyhez az erőforrás tartozik.
subscriptionId	path	True	string	Az Ön Azure előfizetési azonosítója. Ez egy GUID formátumú sztring (például 000000000-0000-0000-0000-0000000000).
api-version	query	True	string	API-verzió

Kérelem törzse

Name	Típus	Description
kind	string	Erőforrás típusa.
properties.domain	string	A statikus hely egyéni tartományának tartományneve.
properties.numHoursToExpiration	integer (int32)	Az sas-jogkivonat érvényességi ideje
properties.provider	string	A statikus hely felhasználójának identitásszolgáltatója.
properties.roles	string	A statikus webhely felhasználójának szerepkörei szabad formátumú sztring formátumban
properties.userDetails	string	A statikus webhely felhasználójának felhasználóazonosítója.

Válaszok

Name	Típus	Description
200 OK	StaticSiteUserInvitationResponseResource	OKÉ.
Other Status Codes	DefaultErrorResponse	App Service-hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Create an invitation link for a user for a static site

Mintakérelem

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/createUserInvitation?api-version=2024-11-01

{
  "properties": {
    "domain": "happy-sea-15afae3e.azurestaticwebsites.net",
    "provider": "aad",
    "userDetails": "username",
    "roles": "admin,contributor",
    "numHoursToExpiration": 1
  }
}

Java

import com.azure.resourcemanager.appservice.models.StaticSiteUserInvitationRequestResource;

/**
 * Samples for StaticSites CreateUserRolesInvitationLink.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateUserRolesInvitationLink.json
     */
    /**
     * Sample code: Create an invitation link for a user for a static site.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createAnInvitationLinkForAUserForAStaticSite(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getStaticSites().createUserRolesInvitationLinkWithResponse("rg",
            "testStaticSite0",
            new StaticSiteUserInvitationRequestResource().withDomain("happy-sea-15afae3e.azurestaticwebsites.net")
                .withProvider("aad").withUserDetails("username").withRoles("admin,contributor")
                .withNumHoursToExpiration(1),
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python create_user_roles_invitation_link.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.static_sites.create_user_roles_invitation_link(
        resource_group_name="rg",
        name="testStaticSite0",
        static_site_user_roles_invitation_envelope={
            "properties": {
                "domain": "happy-sea-15afae3e.azurestaticwebsites.net",
                "numHoursToExpiration": 1,
                "provider": "aad",
                "roles": "admin,contributor",
                "userDetails": "username",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateUserRolesInvitationLink.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 armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateUserRolesInvitationLink.json
func ExampleStaticSitesClient_CreateUserRolesInvitationLink() {
	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.NewStaticSitesClient().CreateUserRolesInvitationLink(ctx, "rg", "testStaticSite0", armappservice.StaticSiteUserInvitationRequestResource{
		Properties: &armappservice.StaticSiteUserInvitationRequestResourceProperties{
			Domain:               to.Ptr("happy-sea-15afae3e.azurestaticwebsites.net"),
			NumHoursToExpiration: to.Ptr[int32](1),
			Provider:             to.Ptr("aad"),
			Roles:                to.Ptr("admin,contributor"),
			UserDetails:          to.Ptr("username"),
		},
	}, 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.StaticSiteUserInvitationResponseResource = armappservice.StaticSiteUserInvitationResponseResource{
	// 	Properties: &armappservice.StaticSiteUserInvitationResponseResourceProperties{
	// 		ExpiresOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-28T16:53:56.211Z"); return t}()),
	// 		InvitationURL: to.Ptr("https://happy-sea-15afae3e.azurestaticwebsites.net?invite=asdf"),
	// 	},
	// }
}

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

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Creates an invitation link for a user with the role
 *
 * @summary Description for Creates an invitation link for a user with the role
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateUserRolesInvitationLink.json
 */
async function createAnInvitationLinkForAUserForAStaticSite() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testStaticSite0";
  const staticSiteUserRolesInvitationEnvelope = {
    domain: "happy-sea-15afae3e.azurestaticwebsites.net",
    numHoursToExpiration: 1,
    provider: "aad",
    roles: "admin,contributor",
    userDetails: "username",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.staticSites.createUserRolesInvitationLink(
    resourceGroupName,
    name,
    staticSiteUserRolesInvitationEnvelope,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateUserRolesInvitationLink.json
// this example is just showing the usage of "StaticSites_CreateUserRolesInvitationLink" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this StaticSiteResource created on azure
// for more information of creating StaticSiteResource, please refer to the document of StaticSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string name = "testStaticSite0";
ResourceIdentifier staticSiteResourceId = StaticSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
StaticSiteResource staticSite = client.GetStaticSiteResource(staticSiteResourceId);

// invoke the operation
StaticSiteUserInvitationContent content = new StaticSiteUserInvitationContent
{
    Domain = "happy-sea-15afae3e.azurestaticwebsites.net",
    Provider = "aad",
    UserDetails = "username",
    Roles = "admin,contributor",
    NumHoursToExpiration = 1,
};
StaticSiteUserInvitationResult result = await staticSite.CreateUserRolesInvitationLinkAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

Mintaválasz

Állapotkód:

200

{
  "properties": {
    "invitationUrl": "https://happy-sea-15afae3e.azurestaticwebsites.net?invite=asdf",
    "expiresOn": "2020-02-28T16:53:56.211Z"
  }
}

Definíciók

Name	Description
DefaultErrorResponse	App Service-hibaválasz.
Details
Error	Hibamodell.
StaticSiteUserInvitationRequestResource	Statikus webhelyek felhasználói szerepköreinek meghívási erőforrása.
StaticSiteUserInvitationResponseResource	Statikus webhelyek felhasználói szerepkörök meghívóhivatkozás-erőforrása.

DefaultErrorResponse

Objektum

App Service-hibaválasz.

Name	Típus	Description
error	Error	Hibamodell.

Details

Objektum

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

Error

Objektum

Hibamodell.

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
details	Details[]	Részletes hibák.
innererror	string	További információ a hibakereséshez.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

StaticSiteUserInvitationRequestResource

Objektum

Statikus webhelyek felhasználói szerepköreinek meghívási erőforrása.

Name	Típus	Description
id	string	Erőforrás-azonosító.
kind	string	Erőforrás típusa.
name	string	Erőforrás neve.
properties.domain	string	A statikus hely egyéni tartományának tartományneve.
properties.numHoursToExpiration	integer (int32)	Az sas-jogkivonat érvényességi ideje
properties.provider	string	A statikus hely felhasználójának identitásszolgáltatója.
properties.roles	string	A statikus webhely felhasználójának szerepkörei szabad formátumú sztring formátumban
properties.userDetails	string	A statikus webhely felhasználójának felhasználóazonosítója.
type	string	Erőforrás típusa.

StaticSiteUserInvitationResponseResource

Objektum

Statikus webhelyek felhasználói szerepkörök meghívóhivatkozás-erőforrása.

Name	Típus	Description
id	string	Erőforrás-azonosító.
kind	string	Erőforrás típusa.
name	string	Erőforrás neve.
properties.expiresOn	string (date-time)	A meghívó lejárati ideje
properties.invitationUrl	string	A meghívó hivatkozásának URL-címe
type	string	Erőforrás típusa.