AuthorizationPolicies interface
Interface representing a AuthorizationPolicies.
Methods
| create |
Creates an authorization policy or updates an existing authorization policy. |
| get(string, string, string, Authorization |
Gets an authorization policy in the hub. |
| list |
Gets all the authorization policies in a specified hub. |
| regenerate |
Regenerates the primary policy key of the specified authorization policy. |
| regenerate |
Regenerates the secondary policy key of the specified authorization policy. |
Method Details
createOrUpdate(string, string, string, AuthorizationPolicyResourceFormat, AuthorizationPoliciesCreateOrUpdateOptionalParams)
Creates an authorization policy or updates an existing authorization policy.
function createOrUpdate(resourceGroupName: string, hubName: string, authorizationPolicyName: string, parameters: AuthorizationPolicyResourceFormat, options?: AuthorizationPoliciesCreateOrUpdateOptionalParams): Promise<AuthorizationPolicyResourceFormat>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- authorizationPolicyName
-
string
The name of the policy.
- parameters
- AuthorizationPolicyResourceFormat
Parameters supplied to the CreateOrUpdate authorization policy operation.
The options parameters.
Returns
Promise<AuthorizationPolicyResourceFormat>
get(string, string, string, AuthorizationPoliciesGetOptionalParams)
Gets an authorization policy in the hub.
function get(resourceGroupName: string, hubName: string, authorizationPolicyName: string, options?: AuthorizationPoliciesGetOptionalParams): Promise<AuthorizationPolicyResourceFormat>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- authorizationPolicyName
-
string
The name of the policy.
The options parameters.
Returns
Promise<AuthorizationPolicyResourceFormat>
listByHub(string, string, AuthorizationPoliciesListByHubOptionalParams)
Gets all the authorization policies in a specified hub.
function listByHub(resourceGroupName: string, hubName: string, options?: AuthorizationPoliciesListByHubOptionalParams): PagedAsyncIterableIterator<AuthorizationPolicyResourceFormat, AuthorizationPolicyResourceFormat[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
The options parameters.
Returns
regeneratePrimaryKey(string, string, string, AuthorizationPoliciesRegeneratePrimaryKeyOptionalParams)
Regenerates the primary policy key of the specified authorization policy.
function regeneratePrimaryKey(resourceGroupName: string, hubName: string, authorizationPolicyName: string, options?: AuthorizationPoliciesRegeneratePrimaryKeyOptionalParams): Promise<AuthorizationPolicy>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- authorizationPolicyName
-
string
The name of the policy.
The options parameters.
Returns
Promise<AuthorizationPolicy>
regenerateSecondaryKey(string, string, string, AuthorizationPoliciesRegenerateSecondaryKeyOptionalParams)
Regenerates the secondary policy key of the specified authorization policy.
function regenerateSecondaryKey(resourceGroupName: string, hubName: string, authorizationPolicyName: string, options?: AuthorizationPoliciesRegenerateSecondaryKeyOptionalParams): Promise<AuthorizationPolicy>Parameters
- resourceGroupName
-
string
The name of the resource group.
- hubName
-
string
The name of the hub.
- authorizationPolicyName
-
string
The name of the policy.
The options parameters.
Returns
Promise<AuthorizationPolicy>